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