ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / captoinfo.1m.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2010,2016 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: captoinfo.1m,v 1.30 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>captoinfo 1m</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">captoinfo 1m</H1>
44 <PRE>
45 <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>                                                    <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>captoinfo</STRONG> - convert a <EM>termcap</EM> description into a <EM>terminfo</EM> description
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>captoinfo</STRONG> [<STRONG>-v</STRONG><EM>n</EM> <EM>width</EM>]  [<STRONG>-V</STRONG>] [<STRONG>-1</STRONG>] [<STRONG>-w</STRONG> <EM>width</EM>] <EM>file</EM> ...
56
57
58 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
59        <STRONG>captoinfo</STRONG>  looks in each given text <EM>file</EM> for <STRONG>termcap</STRONG> descriptions.  For
60        each one found, an equivalent <STRONG>terminfo</STRONG> description is written to  stan-
61        dard  output.   Termcap <STRONG>tc</STRONG> capabilities are translated directly to ter-
62        minfo <STRONG>use</STRONG> capabilities.
63
64        If no <EM>file</EM> is given, then the environment variable <STRONG>TERMCAP</STRONG> is used  for
65        the  filename  or entry.  If <STRONG>TERMCAP</STRONG> is a full pathname to a file, only
66        the terminal whose name is specified in the environment  variable  <STRONG>TERM</STRONG>
67        is  extracted  from  that file.  If the environment variable <STRONG>TERMCAP</STRONG> is
68        not set, then the file <STRONG>/usr/share/terminfo</STRONG> is read.
69
70        <STRONG>-v</STRONG>   print out tracing information on standard  error  as  the  program
71             runs.
72
73        <STRONG>-V</STRONG>   print  out the version of the program in use on standard error and
74             exit.
75
76        <STRONG>-1</STRONG>   cause the fields to print out  one  to  a  line.   Otherwise,  the
77             fields  will be printed several to a line to a maximum width of 60
78             characters.
79
80        <STRONG>-w</STRONG>   change the output to <EM>width</EM> characters.
81
82
83 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
84        /usr/share/terminfo Compiled terminal description database.
85
86
87 </PRE><H2><a name="h2-TRANSLATIONS-FROM-NONSTANDARD-CAPABILITIES">TRANSLATIONS FROM NONSTANDARD CAPABILITIES</a></H2><PRE>
88        Some obsolete nonstandard capabilities will automatically be translated
89        into  standard  (SVr4/XSI  Curses)  terminfo capabilities by <STRONG>captoinfo</STRONG>.
90        Whenever one of these automatic translations is done, the program  will
91        issue an notification to stderr, inviting the user to check that it has
92        not mistakenly translated a completely unknown  and  random  capability
93        and/or syntax error.
94
95        Nonstd   Std    From           Terminfo
96         name    name                 capability
97        -----------------------------------------------
98        BO       mr     AT&amp;T    enter_reverse_mode
99        CI       vi     AT&amp;T    cursor_invisible
100        CV       ve     AT&amp;T    cursor_normal
101        DS       mh     AT&amp;T    enter_dim_mode
102        EE       me     AT&amp;T    exit_attribute_mode
103        FE       LF     AT&amp;T    label_on
104        FL       LO     AT&amp;T    label_off
105        XS       mk     AT&amp;T    enter_secure_mode
106        EN       @7     XENIX   key_end
107        GE       ae     XENIX   exit_alt_charset_mode
108        GS       as     XENIX   enter_alt_charset_mode
109        HM       kh     XENIX   key_home
110        LD       kL     XENIX   key_dl
111        PD       kN     XENIX   key_npage
112        PN       po     XENIX   prtr_off
113        PS       pf     XENIX   prtr_on
114        PU       kP     XENIX   key_ppage
115
116        RT       @8     XENIX   kent
117        UP       ku     XENIX   kcuu1
118        KA       k;     Tek     key_f10
119        KB       F1     Tek     key_f11
120        KC       F2     Tek     key_f12
121        KD       F3     Tek     key_f13
122        KE       F4     Tek     key_f14
123        KF       F5     Tek     key_f15
124        BC       Sb     Tek     set_background
125        FC       Sf     Tek     set_foreground
126        HS       mh     Iris    enter_dim_mode
127
128        XENIX  termcap  also  used  to have a set of extension capabilities for
129        forms drawing, designed to take  advantage  of  the  IBM  PC  high-half
130        graphics.  They were as follows:
131
132        Cap          Graphic
133        -----------------------------
134        G2    upper left
135        G3    lower left
136        G1    upper right
137        G4    lower right
138        GR    pointing right
139        GL    pointing left
140        GU    pointing up
141        GD    pointing down
142        GH    horizontal line
143        GV    vertical line
144        GC    intersection
145        G6    upper left
146        G7    lower left
147        G5    upper right
148        G8    lower right
149        Gr    tee pointing right
150        Gr    tee pointing left
151        Gu    tee pointing up
152        Gd    tee pointing down
153        Gh    horizontal line
154        Gv    vertical line
155        Gc    intersection
156        GG    acs magic cookie count
157
158        If  the single-line capabilities occur in an entry, they will automati-
159        cally be composed into an <STRONG>acsc</STRONG> string.   The  double-line  capabilities
160        and <STRONG>GG</STRONG> are discarded with a warning message.
161
162        IBM's  AIX  has  a  terminfo  facility descended from SVr1 terminfo but
163        incompatible with the SVr4 format.  The following  AIX  extensions  are
164        automatically translated:
165
166         IBM    XSI
167        -------------
168        ksel    kslt
169        kbtab   kcbt
170        font0   s0ds
171        font1   s1ds
172        font2   s2ds
173        font3   s3ds
174
175        Additionally,  the AIX <EM>box1</EM> capability will be automatically translated
176        to an <STRONG>acsc</STRONG> string.
177
178        Hewlett-Packard's terminfo library supports  two  nonstandard  terminfo
179        capabilities  <STRONG>meml</STRONG>  (memory lock) and <STRONG>memu</STRONG> (memory unlock).  These will
180        be discarded with a warning message.
181
182
183 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
184        This utility is actually a link to <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, running in  <EM>-I</EM>  mode.   You
185        can use other <STRONG>tic</STRONG> options such as <STRONG>-f</STRONG> and  <STRONG>-x</STRONG>.
186
187        The  verbose option is not identical to SVr4's.  Under SVr4, instead of
188        following the <STRONG>-v</STRONG> with a trace level n, you repeat it n times.
189
190
191 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
192        X/Open Curses, Issue 7 (2009) describes <STRONG>tic</STRONG>  briefly,  but  omits  this
193        program.  SVr4 systems provide <STRONG>captoinfo</STRONG> as a separate application from
194        <STRONG>tic</STRONG>.
195
196        NetBSD does not provide this application.
197
198
199 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
200        <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
201
202        This describes <STRONG>ncurses</STRONG> version 6.2 (patch 20200425).
203
204
205 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
206        Eric S. Raymond &lt;esr@snark.thyrsus.com&gt; and
207        Thomas E. Dickey &lt;dickey@invisible-island.net&gt;
208
209
210
211                                                                  <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>
212 </PRE>
213 <div class="nav">
214 <ul>
215 <li><a href="#h2-NAME">NAME</a></li>
216 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
217 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
218 <li><a href="#h2-FILES">FILES</a></li>
219 <li><a href="#h2-TRANSLATIONS-FROM-NONSTANDARD-CAPABILITIES">TRANSLATIONS FROM NONSTANDARD CAPABILITIES</a></li>
220 <li><a href="#h2-NOTES">NOTES</a></li>
221 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
222 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
223 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
224 </ul>
225 </div>
226 </BODY>
227 </HTML>