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