Debian Codegraph @

upstream/debian-unstable/man1/captoinfo.1

raw
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2024,2025 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.77 2025/11/12 01:03:56 tom Exp $
32 .TH captoinfo 1 2025-11-11 "ncurses 6.6" "User commands"
33 .ie \n(.g \{\
34 .ds `` \(lq
35 .ds '' \(rq
36 .\}
37 .el \{\
38 .ie t .ds `` ``
39 .el .ds `` ""
40 .ie t .ds '' ''
41 .el .ds '' ""
42 .\}
43 .SH NAME
44 \fB\%captoinfo\fP \-
45 convert a \fItermcap\fP description into a \fI\%term\%info\fP description
46 .SH SYNOPSIS
47 .B captoinfo
48 .RI [ tic-option ]
49 .RI [ file
50 \&.\|.\|.]
51 .P
52 .B "captoinfo \-V"
53 .SH DESCRIPTION
54 .B \%captoinfo
55 translates terminal descriptions.
56 It looks in each given text
57 .I file
58 for
59 .I termcap
60 entries and,
61 for each one found,
62 writes an equivalent
63 .I term\%info
64 description to the standard output stream.
65 .I termcap
66 .B tc
67 capabilities translate to
68 .I term\%info
69 .RB \*(`` use \*(''
70 capabilities.
71 .PP
72 If no
73 .IR file s
74 are specified,
75 .B \%captoinfo
76 interprets the content of the environment variable
77 .I \%TERMCAP
78 as a file name,
79 and extracts only the entry for the terminal type named
80 in the environment variable
81 .I TERM
82 from it.
83 If the environment variable
84 .I \%TERMCAP
85 is not set,
86 .B \%captoinfo
87 reads
88 .IR \%/etc/termcap "."
89 .PP
90 This utility is implemented as a link to \fB\%tic\fP(1),
91 with the latter's
92 .B \-I
93 option implied.
94 You can use other
95 .B \%tic
96 options such as
97 .BR \-1 ,
98 .BR \-f ,
99 .BR \-v ,
100 .BR \-w ,
101 and
102 .BR \-x .
103 The
104 .B \-V
105 option reports the version of
106 .I \%ncurses
107 associated with this program and exits with a successful status.
108 .SS "Translations from Nonstandard Capabilities"
109 .B \%captoinfo
110 translates some obsolete,
111 nonstandard capabilities into standard
112 .I term\%info
113 capabilities.
114 It issues a diagnostic to the standard error stream for each,
115 inviting the user to check that it has not mistakenly translated an
116 unknown or mistyped capability name.
117 .PP
118 .\" DWB 3.3 and Plan 9 tbl require the two junk "L" specifiers in the
119 .\" first row description. System V, GNU, and Heirloom Doctools tbl do
120 .\" not; they "rectangularize" the table geometry.
121 .TS
122 center;
123 Cb S L L
124 Cb Cb Cb Cb
125 Cb Cb C Lb.
126 \f(BItermcap\fP Code
127 Obsolete Standard Origin \f(BIterminfo\fP capability
128 _
129 BO mr AT&T enter_reverse_mode
130 CI vi AT&T cursor_invisible
131 CV ve AT&T cursor_normal
132 DS mh AT&T enter_dim_mode
133 EE me AT&T exit_attribute_mode
134 FE LF AT&T label_on
135 FL LO AT&T label_off
136 XS mk AT&T enter_secure_mode
137 EN @7 XENIX key_end
138 GE ae XENIX exit_alt_charset_mode
139 GS as XENIX enter_alt_charset_mode
140 HM kh XENIX key_home
141 LD kL XENIX key_dl
142 PD kN XENIX key_npage
143 PN po XENIX prtr_off
144 PS pf XENIX prtr_on
145 PU kP XENIX key_ppage
146 RT @8 XENIX kent
147 UP ku XENIX kcuu1
148 KA k; Tektronix key_f10
149 KB F1 Tektronix key_f11
150 KC F2 Tektronix key_f12
151 KD F3 Tektronix key_f13
152 KE F4 Tektronix key_f14
153 KF F5 Tektronix key_f15
154 BC Sb Tektronix set_background
155 FC Sf Tektronix set_foreground
156 HS mh IRIX enter_dim_mode
157 .TE
158 .PP
159 XENIX
160 .I termcap
161 had a set of extension capabilities,
162 corresponding to box drawing characters of CCSID
163 (\*(``code page\*('') 437,
164 as follows.
165 .PP
166 .TS
167 center;
168 Cb Cb
169 Cb L .
170 \f(BItermcap\fP Code Graphic
171 _
172 G2 upper left corner
173 G3 lower left corner
174 G1 upper right corner
175 G4 lower right corner
176 GR tee pointing right
177 GL tee pointing left
178 GU tee pointing up
179 GD tee pointing down
180 GH horizontal line
181 GV vertical line
182 GC intersection
183 G6 double upper left corner
184 G7 double lower left corner
185 G5 double upper right corner
186 G8 double lower right corner
187 Gr double tee pointing right
188 Gr double tee pointing left
189 Gu double tee pointing up
190 Gd double tee pointing down
191 Gh double horizontal line
192 Gv double vertical line
193 Gc double intersection
194 .\" TODO: There are about 40 box drawing code points in CCSID 437;
195 .\" were there no XENIX capabilities for the mixed single- and double-
196 .\" line intersections?
197 .\"
198 .\" TODO: GG doesn't seem to fit with the others; explain it.
199 GG ACS magic cookie count
200 .TE
201 .PP
202 .B \%captoinfo
203 composes single-line box-drawing capabilities into a
204 .I term\%info
205 .B \%acs_chars
206 .RB \%( acsc )
207 string capability,
208 and discards
209 .B GG
210 and double-line capabilities with a warning
211 diagnostic.
212 .PP
213 AIX has a
214 .I term\%info
215 facility descended from SVr2
216 .IR term\%info ","
217 but which is incompatible with the SVr4 format.
218 .B \%captoinfo
219 translates the following AIX extensions.
220 .PP
221 .TS
222 center;
223 Cb Cb
224 L L .
225 IBM X/Open
226 _
227 ksel kslt
228 kbtab kcbt
229 font0 s0ds
230 font1 s1ds
231 font2 s2ds
232 font3 s3ds
233 .TE
234 .PP
235 It furthermore translates the AIX
236 .B box1
237 capability to an
238 .B \%acs_chars
239 .RB \%( acsc )
240 string capability.
241 .PP
242 The HP-UX
243 .I \%term\%info
244 library supports two nonstandard
245 .I \%term\%info
246 capabilities:
247 .B \%memory_lock
248 .RB ( meml )
249 and
250 .B \%memory_unlock
251 .RB ( memu ).
252 .B \%captoinfo
253 discards these with a warning message.
254 .SH FILES
255 .TP
256 .I /etc/termcap
257 default
258 .I termcap
259 terminal capability database
260 .SH EXTENSIONS
261 This command is an SVr4
262 .I curses
263 and
264 .I \%ncurses
265 extension.
266 .SH PORTABILITY
267 X/Open Curses Issue\ 7 (2009) does not specify this command.
268 .PP
269 SVr4 systems provide
270 .I \%captoinfo
271 as a separate application from
272 .IR \%tic "."
273 Its
274 .B \-v
275 option does not accept a trace level argument
276 .IR n ;
277 repeat
278 .B \-v
279 .I n
280 times instead.
281 .PP
282 NetBSD does not provide this application.
283 .SH AUTHORS
284 Eric S. Raymond <[email protected]>
285 and
286 .br
287 Thomas E. Dickey <dickey@invisible\-island.net>
288 .SH SEE ALSO
289 \fB\%infocmp\fP(1),
290 \fB\%tic\fP(1),
291 \fB\%ncurses\fP(3NCURSES),
292 \fB\%terminfo\fP(5)