ncurses 6.2 - patch 20201219
[ncurses.git] / man / captoinfo.1m
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2010,2016 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 .\"
31 .\" $Id: captoinfo.1m,v 1.30 2020/02/02 23:34:34 tom Exp $
32 .TH @CAPTOINFO@ 1M ""
33 .ds n 5
34 .ds d @TERMINFO@
35 .SH NAME
36 \fB@CAPTOINFO@\fR \- convert a \fItermcap\fR description into a \fIterminfo\fR description
37 .SH SYNOPSIS
38 \fB@CAPTOINFO@\fR [\fB\-v\fR\fIn\fR \fIwidth\fR]  [\fB\-V\fR] [\fB\-1\fR] [\fB\-w\fR \fIwidth\fR] \fIfile\fR ...
39 .SH DESCRIPTION
40 \fB@CAPTOINFO@\fR looks in each given text
41 \fIfile\fR for \fBtermcap\fR descriptions.
42 For each
43 one found, an equivalent \fBterminfo\fR description is written to standard
44 output.
45 Termcap \fBtc\fR capabilities are translated directly to terminfo
46 \fBuse\fR capabilities.
47 .PP
48 If no \fIfile\fR is given, then the environment variable \fBTERMCAP\fR is used
49 for the filename or entry.
50 If \fBTERMCAP\fR is a full pathname to a file, only
51 the terminal whose name is specified in the environment variable \fBTERM\fR is
52 extracted from that file.
53 If the environment variable \fBTERMCAP\fR is not
54 set, then the file \fB\*d\fR is read.
55 .TP 5
56 \fB\-v\fR
57 print out tracing information on standard error as the program runs.
58 .TP 5
59 \fB\-V\fR
60 print out the version of the program in use on standard error and exit.
61 .TP 5
62 \fB\-1\fR
63 cause the fields to print out one to a line.
64 Otherwise, the fields
65 will be printed several to a line to a maximum width of 60
66 characters.
67 .TP 5
68 \fB\-w\fR
69 change the output to \fIwidth\fR characters.
70 .SH FILES
71 .TP 20
72 \*d
73 Compiled terminal description database.
74 .SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES
75 .PP
76 Some obsolete nonstandard capabilities will automatically be translated
77 into standard (SVr4/XSI Curses) terminfo capabilities by \fB@CAPTOINFO@\fR.
78 Whenever one of these automatic translations is done, the program
79 will issue an notification to stderr, inviting the user to check that
80 it has not mistakenly translated a completely unknown and random
81 capability and/or syntax error.
82 .PP
83 .TS H
84 c c c c
85 c c c c
86 l l l l.
87 Nonstd  Std     From    Terminfo
88 name    name            capability
89 _
90 BO      mr      AT&T    enter_reverse_mode
91 CI      vi      AT&T    cursor_invisible
92 CV      ve      AT&T    cursor_normal
93 DS      mh      AT&T    enter_dim_mode
94 EE      me      AT&T    exit_attribute_mode
95 FE      LF      AT&T    label_on
96 FL      LO      AT&T    label_off
97 XS      mk      AT&T    enter_secure_mode
98 EN      @7      XENIX   key_end
99 GE      ae      XENIX   exit_alt_charset_mode
100 GS      as      XENIX   enter_alt_charset_mode
101 HM      kh      XENIX   key_home
102 LD      kL      XENIX   key_dl
103 PD      kN      XENIX   key_npage
104 PN      po      XENIX   prtr_off
105 PS      pf      XENIX   prtr_on
106 PU      kP      XENIX   key_ppage
107 RT      @8      XENIX   kent
108 UP      ku      XENIX   kcuu1
109 KA      k;      Tek     key_f10
110 KB      F1      Tek     key_f11
111 KC      F2      Tek     key_f12
112 KD      F3      Tek     key_f13
113 KE      F4      Tek     key_f14
114 KF      F5      Tek     key_f15
115 BC      Sb      Tek     set_background
116 FC      Sf      Tek     set_foreground
117 HS      mh      Iris    enter_dim_mode
118 .TE
119 .PP
120 XENIX termcap also used to have a set of extension capabilities
121 for forms drawing, designed to take advantage of the IBM PC
122 high-half graphics.
123 They were as follows:
124 .PP
125 .TS H
126 c c
127 l l.
128 Cap     Graphic
129 _
130 G2      upper left
131 G3      lower left
132 G1      upper right
133 G4      lower right
134 GR      pointing right
135 GL      pointing left
136 GU      pointing up
137 GD      pointing down
138 GH      horizontal line
139 GV      vertical line
140 GC      intersection
141 G6      upper left
142 G7      lower left
143 G5      upper right
144 G8      lower right
145 Gr      tee pointing right
146 Gr      tee pointing left
147 Gu      tee pointing up
148 Gd      tee pointing down
149 Gh      horizontal line
150 Gv      vertical line
151 Gc      intersection
152 GG      acs magic cookie count
153 .TE
154 .PP
155 If the single-line capabilities occur in an entry, they will automatically
156 be composed into an \fBacsc\fR string.
157 The double-line capabilities and
158 \fBGG\fR are discarded with a warning message.
159 .PP
160 IBM's AIX has a terminfo facility descended from SVr1 terminfo but incompatible
161 with the SVr4 format.
162 The following AIX extensions are automatically
163 translated:
164 .TS
165 c c
166 l l.
167 IBM     XSI
168 _
169 ksel    kslt
170 kbtab   kcbt
171 font0   s0ds
172 font1   s1ds
173 font2   s2ds
174 font3   s3ds
175 .TE
176 .PP
177 Additionally, the AIX \fIbox1\fR capability will be automatically translated to
178 an \fBacsc\fR string.
179 .PP
180 Hewlett-Packard's terminfo library supports two nonstandard terminfo
181 capabilities \fBmeml\fR (memory lock) and \fBmemu\fR (memory unlock).
182 These will be discarded with a warning message.
183 .SH NOTES
184 This utility is actually a link to \fB@TIC@\fR(1M), running in \fI\-I\fR mode.
185 You can use other \fB@TIC@\fR options such as \fB\-f\fR and  \fB\-x\fR.
186 .PP
187 The verbose option is not identical to SVr4's.
188 Under SVr4, instead of following
189 the \fB\-v\fR with a trace level n, you repeat it n times.
190 .SH PORTABILITY
191 X/Open Curses, Issue 7 (2009) describes \fBtic\fP briefly,
192 but omits this program.
193 SVr4 systems provide \fBcaptoinfo\fP as a separate application from \fBtic\fP.
194 .PP
195 NetBSD does not provide this application.
196 .SH SEE ALSO
197 \fB@INFOCMP@\fR(1M),
198 \fBcurses\fR(3X),
199 \fBterminfo\fR(\*n)
200 .PP
201 This describes \fBncurses\fR
202 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
203 .SH AUTHOR
204 Eric S. Raymond <esr@snark.thyrsus.com>
205 and
206 .br
207 Thomas E. Dickey <dickey@invisible-island.net>