ncurses 5.8 - patch 20110226
[ncurses.git] / doc / html / man / captoinfo.1m.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2007,2010 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.25 2010/12/04 18:36:44 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>captoinfo 1m</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>captoinfo 1m</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>
50 <H2>NAME</H2><PRE>
51        <STRONG>captoinfo</STRONG>  - convert a <EM>termcap</EM> description into a <EM>terminfo</EM>
52        description
53
54
55 </PRE>
56 <H2>SYNOPSIS</H2><PRE>
57        <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> . . .
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        <STRONG>captoinfo</STRONG> looks  in  each  given  text  <EM>file</EM>  for  <STRONG>termcap</STRONG>
63        descriptions.   For each one found, an equivalent <STRONG>terminfo</STRONG>
64        description is written to  standard  output.   Termcap  <STRONG>tc</STRONG>
65        capabilities are translated directly to terminfo <STRONG>use</STRONG> capa-
66        bilities.
67
68        If no <EM>file</EM> is given, then the environment variable <STRONG>TERMCAP</STRONG>
69        is  used  for the filename or entry.  If <STRONG>TERMCAP</STRONG> is a full
70        pathname to a file, only the terminal whose name is speci-
71        fied  in  the  environment variable <STRONG>TERM</STRONG> is extracted from
72        that file.  If the environment  variable  <STRONG>TERMCAP</STRONG>  is  not
73        set, then the file <STRONG>/usr/share/terminfo</STRONG> is read.
74
75        <STRONG>-v</STRONG>   print  out  tracing  information on standard error as
76             the program runs.
77
78        <STRONG>-V</STRONG>   print out the version of the program in use on  stan-
79             dard error and exit.
80
81        <STRONG>-1</STRONG>   cause  the fields to print out one to a line.  Other-
82             wise, the fields will be printed several to a line to
83             a maximum width of 60 characters.
84
85        <STRONG>-w</STRONG>   change the output to <EM>width</EM> characters.
86
87
88 </PRE>
89 <H2>FILES</H2><PRE>
90        /usr/share/terminfo Compiled      terminal     description
91                            database.
92
93
94 </PRE>
95 <H2>TRANSLATIONS FROM NONSTANDARD CAPABILITIES</H2><PRE>
96        Some obsolete nonstandard capabilities will  automatically
97        be  translated  into  standard  (SVr4/XSI Curses) terminfo
98        capabilities by <STRONG>captoinfo</STRONG>.  Whenever one  of  these  auto-
99        matic  translations  is  done,  the  program will issue an
100        notification to stderr, inviting the user to check that it
101        has  not  mistakenly  translated  a completely unknown and
102        random capability and/or syntax error.
103
104
105        Nonstd   Std    From           Terminfo
106         name    name                 capability
107        -----------------------------------------------
108        BO       mr     AT&amp;T    enter_reverse_mode
109        CI       vi     AT&amp;T    cursor_invisible
110        CV       ve     AT&amp;T    cursor_normal
111        DS       mh     AT&amp;T    enter_dim_mode
112        EE       me     AT&amp;T    exit_attribute_mode
113        FE       LF     AT&amp;T    label_on
114        FL       LO     AT&amp;T    label_off
115        XS       mk     AT&amp;T    enter_secure_mode
116        EN       @7     XENIX   key_end
117        GE       ae     XENIX   exit_alt_charset_mode
118        GS       as     XENIX   enter_alt_charset_mode
119
120        HM       kh     XENIX   key_home
121        LD       kL     XENIX   key_dl
122        PD       kN     XENIX   key_npage
123        PN       po     XENIX   prtr_off
124        PS       pf     XENIX   prtr_on
125        PU       kP     XENIX   key_ppage
126        RT       @8     XENIX   kent
127        UP       ku     XENIX   kcuu1
128        KA       k;     Tek     key_f10
129        KB       F1     Tek     key_f11
130        KC       F2     Tek     key_f12
131        KD       F3     Tek     key_f13
132        KE       F4     Tek     key_f14
133        KF       F5     Tek     key_f15
134        BC       Sb     Tek     set_background
135        FC       Sf     Tek     set_foreground
136        HS       mh     Iris    enter_dim_mode
137
138        XENIX termcap also used to have a set of  extension  capa-
139        bilities  for forms drawing, designed to take advantage of
140        the IBM PC high-half graphics.  They were as follows:
141
142
143        Cap          Graphic
144        -----------------------------
145        G2    upper left
146        G3    lower left
147        G1    upper right
148        G4    lower right
149        GR    pointing right
150        GL    pointing left
151        GU    pointing up
152        GD    pointing down
153        GH    horizontal line
154        GV    vertical line
155        GC    intersection
156        G6    upper left
157        G7    lower left
158        G5    upper right
159        G8    lower right
160        Gr    tee pointing right
161        Gr    tee pointing left
162        Gu    tee pointing up
163        Gd    tee pointing down
164        Gh    horizontal line
165        Gv    vertical line
166        Gc    intersection
167        GG    acs magic cookie count
168
169        If the single-line capabilities occur in  an  entry,  they
170        will  automatically  be composed into an <EM>acsc</EM> string.  The
171        double-line capabilities and <STRONG>GG</STRONG> are discarded with a warn-
172        ing message.
173
174        IBM's AIX has a terminfo facility descended from SVr1 ter-
175        minfo but incompatible with the SVr4 format.  The  follow-
176        ing AIX extensions are automatically translated:
177
178         IBM    XSI
179        -------------
180        ksel    kslt
181        kbtab   kcbt
182        font0   s0ds
183        font1   s1ds
184        font2   s2ds
185
186        font3   s3ds
187
188        Additionally,  the  AIX  <EM>box1</EM> capability will be automati-
189        cally translated to an <EM>acsc</EM> string.
190
191        Hewlett-Packard's terminfo library supports  two  nonstan-
192        dard  terminfo  capabilities  <EM>meml</EM>  (memory lock) and <EM>memu</EM>
193        (memory unlock).  These will be discarded with  a  warning
194        message.
195
196
197 </PRE>
198 <H2>NOTES</H2><PRE>
199        This  utility is actually a link to <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, running in <EM>-I</EM>
200        mode.  You can use other <STRONG>tic</STRONG> options such as <STRONG>-f</STRONG> and  <STRONG>-x</STRONG>.
201
202        The trace option is not identical to SVr4's.  Under  SVr4,
203        instead  of  following  the  <STRONG>-v</STRONG>  with a trace level n, you
204        repeat it n times.
205
206
207 </PRE>
208 <H2>SEE ALSO</H2><PRE>
209        <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>
210
211        This describes <STRONG>ncurses</STRONG> version 5.8 (patch 20110226).
212
213
214 </PRE>
215 <H2>AUTHOR</H2><PRE>
216        Eric S. Raymond &lt;esr@snark.thyrsus.com&gt; and
217        Thomas E. Dickey &lt;dickey@invisible-island.net&gt;
218
219
220
221                                                           <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>
222 </PRE>
223 <HR>
224 <ADDRESS>
225 Man(1) output converted with
226 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
227 </ADDRESS>
228 </BODY>
229 </HTML>