]> ncurses.scripts.mit.edu Git - ncurses.git/blob - doc/html/man/captoinfo.1m.html
ncurses 6.4 - patch 20231007
[ncurses.git] / doc / html / man / captoinfo.1m.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2022,2023 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.51 2023/10/07 21:19:07 tom Exp @
32   * TODO: There are about 40 box drawing code points in CCSID 437;
33   * were there no XENIX capabilities for the mixed single- and double-
34   * line intersections?
35   * TODO: GG doesn't seem to fit with the others; explain it.
36 -->
37 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
38 <HTML>
39 <HEAD>
40 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
41 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
42 <TITLE>captoinfo 1m 2023-10-07 ncurses 6.4 User commands</TITLE>
43 <link rel="author" href="mailto:bug-ncurses@gnu.org">
44
45 </HEAD>
46 <BODY>
47 <H1 class="no-header">captoinfo 1m 2023-10-07 ncurses 6.4 User commands</H1>
48 <PRE>
49 <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>                    User commands                   <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>
50
51
52
53
54 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
55        <STRONG>captoinfo</STRONG> - convert a <EM>termcap</EM> description into a <EM>terminfo</EM> description
56
57
58 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
59        <STRONG>captoinfo</STRONG> [<EM>tic-option</EM>] [<EM>file</EM> ...]
60
61        <STRONG>captoinfo</STRONG> <STRONG>-V</STRONG>
62
63
64 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
65        <STRONG>captoinfo</STRONG>  looks in each given text <EM>file</EM> for <EM>termcap</EM> descriptions.  For
66        each one found, it writes an equivalent  <EM>terminfo</EM>  description  to  the
67        standard   output  stream.   <EM>termcap</EM>  <STRONG>tc</STRONG>  capabilities  are  translated
68        directly to <EM>terminfo</EM> "<STRONG>use</STRONG>" capabilities.
69
70        If no <EM>file</EM>s are specified, <STRONG>captoinfo</STRONG>  interprets  the  content  of  the
71        environment  variable  <STRONG>TERMCAP</STRONG>  as  a  file name, and extracts only the
72        entry for the terminal named in the environment variable <STRONG>TERM</STRONG> from  it.
73        If  the  environment  variable  <STRONG>TERMCAP</STRONG>  is  not  set,  <STRONG>captoinfo</STRONG> reads
74        <EM>/etc/termcap</EM>.
75
76        This utility is implemented as a link to <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, with the latter's  <STRONG>-I</STRONG>
77        option  implied.  You can use other <STRONG>tic</STRONG> options such as <STRONG>-1</STRONG>, <STRONG>-f</STRONG>, <STRONG>-v</STRONG>, <STRONG>-w</STRONG>,
78        and <STRONG>-x</STRONG>.
79
80
81 </PRE><H3><a name="h3-Translations-from-nonstandard-capabilities">Translations from nonstandard capabilities</a></H3><PRE>
82        <STRONG>captoinfo</STRONG>  translates  some  obsolete,  nonstandard  capabilities  into
83        standard   (SVr4/XSI   Curses)  <EM>terminfo</EM>  capabilities.   It  issues  a
84        diagnostic to the standard error stream for each, inviting the user  to
85        check  that  it  has  not  mistakenly translated an unknown or mistyped
86        capability name.
87
88        <STRONG>Nonstandard</STRONG>   <STRONG>Standard</STRONG>                  <EM>t</I<STRONG>t</STRONG><EM>e</I<STRONG>e</STRONG><EM>r</I<STRONG>r</STRONG><EM>m</I<STRONG>m</STRONG><EM>i</I<STRONG>i</STRONG><EM>n</I<STRONG>n</STRONG><EM>f</I<STRONG>f</STRONG><EM>o</I<STRONG>o</STRONG>
89           <STRONG>name</STRONG>         <STRONG>name</STRONG>     <STRONG>From</STRONG>          <STRONG>capability</STRONG>
90        --------------------------------------------------------
91            <STRONG>BO</STRONG>           <STRONG>mr</STRONG>      AT&amp;T    <STRONG>enter_reverse_mode</STRONG>
92            <STRONG>CI</STRONG>           <STRONG>vi</STRONG>      AT&amp;T    <STRONG>cursor_invisible</STRONG>
93            <STRONG>CV</STRONG>           <STRONG>ve</STRONG>      AT&amp;T    <STRONG>cursor_normal</STRONG>
94            <STRONG>DS</STRONG>           <STRONG>mh</STRONG>      AT&amp;T    <STRONG>enter_dim_mode</STRONG>
95            <STRONG>EE</STRONG>           <STRONG>me</STRONG>      AT&amp;T    <STRONG>exit_attribute_mode</STRONG>
96            <STRONG>FE</STRONG>           <STRONG>LF</STRONG>      AT&amp;T    <STRONG>label_on</STRONG>
97            <STRONG>FL</STRONG>           <STRONG>LO</STRONG>      AT&amp;T    <STRONG>label_off</STRONG>
98            <STRONG>XS</STRONG>           <STRONG>mk</STRONG>      AT&amp;T    <STRONG>enter_secure_mode</STRONG>
99            <STRONG>EN</STRONG>           <STRONG>@7</STRONG>      XENIX   <STRONG>key_end</STRONG>
100            <STRONG>GE</STRONG>           <STRONG>ae</STRONG>      XENIX   <STRONG>exit_alt_charset_mode</STRONG>
101            <STRONG>GS</STRONG>           <STRONG>as</STRONG>      XENIX   <STRONG>enter_alt_charset_mode</STRONG>
102            <STRONG>HM</STRONG>           <STRONG>kh</STRONG>      XENIX   <STRONG>key_home</STRONG>
103            <STRONG>LD</STRONG>           <STRONG>kL</STRONG>      XENIX   <STRONG>key_dl</STRONG>
104            <STRONG>PD</STRONG>           <STRONG>kN</STRONG>      XENIX   <STRONG>key_npage</STRONG>
105            <STRONG>PN</STRONG>           <STRONG>po</STRONG>      XENIX   <STRONG>prtr_off</STRONG>
106            <STRONG>PS</STRONG>           <STRONG>pf</STRONG>      XENIX   <STRONG>prtr_on</STRONG>
107            <STRONG>PU</STRONG>           <STRONG>kP</STRONG>      XENIX   <STRONG>key_ppage</STRONG>
108            <STRONG>RT</STRONG>           <STRONG>@8</STRONG>      XENIX   <STRONG>kent</STRONG>
109            <STRONG>UP</STRONG>           <STRONG>ku</STRONG>      XENIX   <STRONG>kcuu1</STRONG>
110            <STRONG>KA</STRONG>           <STRONG>k;</STRONG>      Tek     <STRONG>key_f10</STRONG>
111            <STRONG>KB</STRONG>           <STRONG>F1</STRONG>      Tek     <STRONG>key_f11</STRONG>
112            <STRONG>KC</STRONG>           <STRONG>F2</STRONG>      Tek     <STRONG>key_f12</STRONG>
113            <STRONG>KD</STRONG>           <STRONG>F3</STRONG>      Tek     <STRONG>key_f13</STRONG>
114            <STRONG>KE</STRONG>           <STRONG>F4</STRONG>      Tek     <STRONG>key_f14</STRONG>
115            <STRONG>KF</STRONG>           <STRONG>F5</STRONG>      Tek     <STRONG>key_f15</STRONG>
116            <STRONG>BC</STRONG>           <STRONG>Sb</STRONG>      Tek     <STRONG>set_background</STRONG>
117            <STRONG>FC</STRONG>           <STRONG>Sf</STRONG>      Tek     <STRONG>set_foreground</STRONG>
118
119            <STRONG>HS</STRONG>           <STRONG>mh</STRONG>      Iris    <STRONG>enter_dim_mode</STRONG>
120
121        XENIX <EM>termcap</EM> had a set of extension capabilities, corresponding to box
122        drawing characters of CCSID ("code page") 437, as follows.
123
124        <STRONG>Termcap</STRONG>
125         <STRONG>Name</STRONG>              <STRONG>Graphic</STRONG>
126        ------------------------------------
127          <STRONG>G2</STRONG>      upper left corner
128          <STRONG>G3</STRONG>      lower left corner
129          <STRONG>G1</STRONG>      upper right corner
130          <STRONG>G4</STRONG>      lower right corner
131          <STRONG>GR</STRONG>      tee pointing right
132          <STRONG>GL</STRONG>      tee pointing left
133          <STRONG>GU</STRONG>      tee pointing up
134          <STRONG>GD</STRONG>      tee pointing down
135          <STRONG>GH</STRONG>      horizontal line
136          <STRONG>GV</STRONG>      vertical line
137          <STRONG>GC</STRONG>      intersection
138          <STRONG>G6</STRONG>      double upper left corner
139          <STRONG>G7</STRONG>      double lower left corner
140          <STRONG>G5</STRONG>      double upper right corner
141          <STRONG>G8</STRONG>      double lower right corner
142          <STRONG>Gr</STRONG>      double tee pointing right
143          <STRONG>Gr</STRONG>      double tee pointing left
144          <STRONG>Gu</STRONG>      double tee pointing up
145          <STRONG>Gd</STRONG>      double tee pointing down
146          <STRONG>Gh</STRONG>      double horizontal line
147          <STRONG>Gv</STRONG>      double vertical line
148          <STRONG>Gc</STRONG>      double intersection
149          <STRONG>GG</STRONG>      ACS magic cookie count
150
151        If  the  single-line  capabilities occur in an entry, they are composed
152        into an <STRONG>acsc</STRONG> string.  The double-line capabilities and <STRONG>GG</STRONG> are discarded
153        with a warning message.
154
155        IBM's  AIX  has  a  <EM>terminfo</EM> facility descended from SVr1 <EM>terminfo</EM>, but
156        which is incompatible with the SVr4 format.  <STRONG>captoinfo</STRONG>  translates  the
157        following AIX extensions.
158
159         <STRONG>IBM</STRONG>    <STRONG>XSI</STRONG>
160        -------------
161        ksel    kslt
162        kbtab   kcbt
163        font0   s0ds
164        font1   s1ds
165        font2   s2ds
166        font3   s3ds
167
168        Additionally,  this  program  translates  the AIX <STRONG>box1</STRONG> capability to an
169        <STRONG>acsc</STRONG> string.
170
171        The  HP-UX  <EM>terminfo</EM>  library   supports   two   nonstandard   <EM>terminfo</EM>
172        capabilities,  <STRONG>meml</STRONG>  (memory lock) and <STRONG>memu</STRONG> (memory unlock).  <STRONG>captoinfo</STRONG>
173        discards these with a warning message.
174
175
176 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
177        <EM>/etc/termcap</EM>
178               default <EM>termcap</EM> terminal capability database
179
180
181 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
182        The verbose option is not identical to SVr4's.  Under SVr4, instead  of
183        following the <STRONG>-v</STRONG> with a trace level <EM>n</EM>, you repeat it <EM>n</EM> times.
184
185
186 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
187        X/Open  Curses,  Issue  7  (2009) describes <STRONG>tic</STRONG> briefly, but omits this
188        program.  SVr4 systems provide <STRONG>captoinfo</STRONG> as a separate application from
189        <STRONG>tic</STRONG>.
190
191        NetBSD does not provide this application.
192
193
194 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
195        Eric S. Raymond &lt;esr@snark.thyrsus.com&gt; and
196        Thomas E. Dickey &lt;dickey@invisible-island.net&gt;
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="tic.1m.html">tic(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
203
204 ncurses 6.4                       2023-10-07                     <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>
205 </PRE>
206 <div class="nav">
207 <ul>
208 <li><a href="#h2-NAME">NAME</a></li>
209 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
210 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
211 <ul>
212 <li><a href="#h3-Translations-from-nonstandard-capabilities">Translations from nonstandard capabilities</a></li>
213 </ul>
214 </li>
215 <li><a href="#h2-FILES">FILES</a></li>
216 <li><a href="#h2-NOTES">NOTES</a></li>
217 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
218 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
219 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
220 </ul>
221 </div>
222 </BODY>
223 </HTML>