]> ncurses.scripts.mit.edu Git - ncurses.git/blob - doc/html/man/captoinfo.1m.html
ncurses 6.4 - patch 20231223
[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.58 2023/12/23 16:28:31 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-12-23 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-12-23 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>  translates  terminal  descriptions.   It looks in each given
66        text <EM>file</EM> for <EM>termcap</EM> entries  and,  for  each  one  found,  writes  an
67        equivalent <EM>terminfo</EM> description to the standard output stream.  <EM>termcap</EM>
68        <STRONG>tc</STRONG> capabilities translate 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  <EM>TERMCAP</EM>  as  a  file name, and extracts only the
72        entry for the terminal named in the environment variable <EM>TERM</EM> from  it.
73        If  the  environment  variable  <EM>TERMCAP</EM>  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>.  The <STRONG>-V</STRONG> option reports the version of <EM>ncurses</EM>  associated  with
79        this program and exits with a successful status.
80
81
82 </PRE><H3><a name="h3-Translations-from-Nonstandard-Capabilities">Translations from Nonstandard Capabilities</a></H3><PRE>
83        <STRONG>captoinfo</STRONG>  translates  some  obsolete,  nonstandard  capabilities  into
84        standard  (SVr4/XSI  Curses)  <EM>terminfo</EM>  capabilities.   It   issues   a
85        diagnostic  to the standard error stream for each, inviting the user to
86        check that it has not mistakenly  translated  an  unknown  or  mistyped
87        capability name.
88
89                      <STRONG>Name</STRONG>
90               <STRONG>Obsolete</STRONG>   <STRONG>Standard</STRONG>    <STRONG>Origin</STRONG>      <STRONG><EM>terminfo</EM></STRONG> <STRONG>capability</STRONG>
91               ---------------------------------------------------------
92                  <STRONG>BO</STRONG>         <STRONG>mr</STRONG>        AT&amp;T      <STRONG>enter_reverse_mode</STRONG>
93                  <STRONG>CI</STRONG>         <STRONG>vi</STRONG>        AT&amp;T      <STRONG>cursor_invisible</STRONG>
94                  <STRONG>CV</STRONG>         <STRONG>ve</STRONG>        AT&amp;T      <STRONG>cursor_normal</STRONG>
95                  <STRONG>DS</STRONG>         <STRONG>mh</STRONG>        AT&amp;T      <STRONG>enter_dim_mode</STRONG>
96                  <STRONG>EE</STRONG>         <STRONG>me</STRONG>        AT&amp;T      <STRONG>exit_attribute_mode</STRONG>
97                  <STRONG>FE</STRONG>         <STRONG>LF</STRONG>        AT&amp;T      <STRONG>label_on</STRONG>
98                  <STRONG>FL</STRONG>         <STRONG>LO</STRONG>        AT&amp;T      <STRONG>label_off</STRONG>
99                  <STRONG>XS</STRONG>         <STRONG>mk</STRONG>        AT&amp;T      <STRONG>enter_secure_mode</STRONG>
100                  <STRONG>EN</STRONG>         <STRONG>@7</STRONG>        XENIX     <STRONG>key_end</STRONG>
101                  <STRONG>GE</STRONG>         <STRONG>ae</STRONG>        XENIX     <STRONG>exit_alt_charset_mode</STRONG>
102                  <STRONG>GS</STRONG>         <STRONG>as</STRONG>        XENIX     <STRONG>enter_alt_charset_mode</STRONG>
103                  <STRONG>HM</STRONG>         <STRONG>kh</STRONG>        XENIX     <STRONG>key_home</STRONG>
104                  <STRONG>LD</STRONG>         <STRONG>kL</STRONG>        XENIX     <STRONG>key_dl</STRONG>
105                  <STRONG>PD</STRONG>         <STRONG>kN</STRONG>        XENIX     <STRONG>key_npage</STRONG>
106                  <STRONG>PN</STRONG>         <STRONG>po</STRONG>        XENIX     <STRONG>prtr_off</STRONG>
107                  <STRONG>PS</STRONG>         <STRONG>pf</STRONG>        XENIX     <STRONG>prtr_on</STRONG>
108                  <STRONG>PU</STRONG>         <STRONG>kP</STRONG>        XENIX     <STRONG>key_ppage</STRONG>
109                  <STRONG>RT</STRONG>         <STRONG>@8</STRONG>        XENIX     <STRONG>kent</STRONG>
110                  <STRONG>UP</STRONG>         <STRONG>ku</STRONG>        XENIX     <STRONG>kcuu1</STRONG>
111                  <STRONG>KA</STRONG>         <STRONG>k;</STRONG>      Tektronix   <STRONG>key_f10</STRONG>
112                  <STRONG>KB</STRONG>         <STRONG>F1</STRONG>      Tektronix   <STRONG>key_f11</STRONG>
113                  <STRONG>KC</STRONG>         <STRONG>F2</STRONG>      Tektronix   <STRONG>key_f12</STRONG>
114                  <STRONG>KD</STRONG>         <STRONG>F3</STRONG>      Tektronix   <STRONG>key_f13</STRONG>
115                  <STRONG>KE</STRONG>         <STRONG>F4</STRONG>      Tektronix   <STRONG>key_f14</STRONG>
116                  <STRONG>KF</STRONG>         <STRONG>F5</STRONG>      Tektronix   <STRONG>key_f15</STRONG>
117                  <STRONG>BC</STRONG>         <STRONG>Sb</STRONG>      Tektronix   <STRONG>set_background</STRONG>
118
119                  <STRONG>FC</STRONG>         <STRONG>Sf</STRONG>      Tektronix   <STRONG>set_foreground</STRONG>
120                  <STRONG>HS</STRONG>         <STRONG>mh</STRONG>        IRIX      <STRONG>enter_dim_mode</STRONG>
121
122        XENIX <EM>termcap</EM> had a set of extension capabilities, corresponding to box
123        drawing characters of CCSID ("code page") 437, as follows.
124
125                       <STRONG><EM>termcap</EM></STRONG> <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        <STRONG>captoinfo</STRONG> composes single-line capabilities into an  <STRONG>acsc</STRONG>  string,  and
152        discards <STRONG>GG</STRONG> and double-line capabilities with a warning diagnostic.
153
154        IBM's  AIX  has  a  <EM>terminfo</EM> facility descended from SVr1 <EM>terminfo</EM>, but
155        which is incompatible with the SVr4 format.  <STRONG>captoinfo</STRONG>  translates  the
156        following AIX extensions.
157
158                                      <STRONG>IBM</STRONG>    <STRONG>XSI</STRONG>
159                                     -------------
160                                     ksel    kslt
161                                     kbtab   kcbt
162                                     font0   s0ds
163                                     font1   s1ds
164                                     font2   s2ds
165                                     font3   s3ds
166
167        Additionally,  this  program  translates  the AIX <STRONG>box1</STRONG> capability to an
168        <STRONG>acsc</STRONG> string.
169
170        The  HP-UX  <EM>terminfo</EM>  library   supports   two   nonstandard   <EM>terminfo</EM>
171        capabilities,  <STRONG>meml</STRONG>  (memory lock) and <STRONG>memu</STRONG> (memory unlock).  <STRONG>captoinfo</STRONG>
172        discards these with a warning message.
173
174
175 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
176        <EM>/etc/termcap</EM>
177               default <EM>termcap</EM> terminal capability database
178
179
180 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
181        X/Open Curses, Issue 7 (2009) describes <STRONG>tic</STRONG>  briefly,  but  omits  this
182        program.
183
184        SVr4 systems provide <STRONG>captoinfo</STRONG> as a separate application from <STRONG>tic</STRONG>.  Its
185        <STRONG>-v</STRONG> option does not accept a trace level argument <EM>n;</EM> repeat <STRONG>-v</STRONG>  <EM>n</EM>  times
186        instead.
187
188        NetBSD does not provide this application.
189
190
191 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
192        Eric S. Raymond &lt;esr@snark.thyrsus.com&gt; and
193        Thomas E. Dickey &lt;dickey@invisible-island.net&gt;
194
195
196 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
197        <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>
198
199
200
201 ncurses 6.4                       2023-12-23                     <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>
202 </PRE>
203 <div class="nav">
204 <ul>
205 <li><a href="#h2-NAME">NAME</a></li>
206 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
207 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
208 <ul>
209 <li><a href="#h3-Translations-from-Nonstandard-Capabilities">Translations from Nonstandard Capabilities</a></li>
210 </ul>
211 </li>
212 <li><a href="#h2-FILES">FILES</a></li>
213 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
214 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
215 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
216 </ul>
217 </div>
218 </BODY>
219 </HTML>