Debian Codegraph @

upstream/debian-trixie/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.69 2025/01/19 00:49:39 tom Exp $
32 .TH captoinfo 1 2025-01-18 "ncurses 6.5" "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 \fB\%captoinfo\fP translates terminal descriptions.
55 It looks in each given text \fIfile\fP for \fI\%termcap\fP entries and,
56 for each one found,
57 writes an equivalent \fI\%\%term\%info\fP description to the standard
58 output stream.
59 \fI\%termcap\fP \fBtc\fP capabilities translate to \fI\%\%term\%info\fP
60 \*(``\fBuse\fP\*('' capabilities.
61 .PP
62 If no \fIfile\fPs are specified,
63 \fB\%captoinfo\fP interprets the content of the environment variable
64 \fI\%TERMCAP\fP as a file name,
65 and extracts only the entry for the terminal named in the environment
66 variable \fITERM\fP from it.
67 If the environment variable \fI\%TERMCAP\fP is not set,
68 \fB\%captoinfo\fP reads
69 .IR \%/etc/termcap .
70 .PP
71 This utility is implemented as a link to \fB\%tic\fP(1),
72 with the latter's
73 .B \-I
74 option implied.
75 You can use other \fB\%tic\fP options such as
76 .BR \-1 ,
77 .BR \-f ,
78 .BR \-v ,
79 .BR \-w ,
80 and
81 .BR \-x .
82 The \fB\-V\fP option reports the version of \fI\%ncurses\fP associated
83 with this program and exits with a successful status.
84 .SS "Translations from Nonstandard Capabilities"
85 \fB\%captoinfo\fP translates some obsolete,
86 nonstandard capabilities into standard
87 \fI\%\%term\%info\fP capabilities.
88 It issues a diagnostic to the standard error stream for each,
89 inviting the user to check that it has not mistakenly translated an
90 unknown or mistyped capability name.
91 .PP
92 .\" DWB 3.3 tbl requires the two junk "L" specifiers in the first row.
93 .TS
94 center;
95 Cb S L L
96 Cb Cb Cb Cb
97 Cb Cb C Lb.
98 \f(BItermcap\fP Code
99 Obsolete Standard Origin \f(BIterminfo\fP capability
100 _
101 BO mr AT&T enter_reverse_mode
102 CI vi AT&T cursor_invisible
103 CV ve AT&T cursor_normal
104 DS mh AT&T enter_dim_mode
105 EE me AT&T exit_attribute_mode
106 FE LF AT&T label_on
107 FL LO AT&T label_off
108 XS mk AT&T enter_secure_mode
109 EN @7 XENIX key_end
110 GE ae XENIX exit_alt_charset_mode
111 GS as XENIX enter_alt_charset_mode
112 HM kh XENIX key_home
113 LD kL XENIX key_dl
114 PD kN XENIX key_npage
115 PN po XENIX prtr_off
116 PS pf XENIX prtr_on
117 PU kP XENIX key_ppage
118 RT @8 XENIX kent
119 UP ku XENIX kcuu1
120 KA k; Tektronix key_f10
121 KB F1 Tektronix key_f11
122 KC F2 Tektronix key_f12
123 KD F3 Tektronix key_f13
124 KE F4 Tektronix key_f14
125 KF F5 Tektronix key_f15
126 BC Sb Tektronix set_background
127 FC Sf Tektronix set_foreground
128 HS mh IRIX enter_dim_mode
129 .TE
130 .PP
131 XENIX \fI\%termcap\fP had a set of extension capabilities,
132 corresponding to box drawing characters of CCSID
133 (\*(``code page\*('') 437,
134 as follows.
135 .PP
136 .TS
137 center;
138 cb cb
139 cb l .
140 \f(BItermcap\fP Code Graphic
141 _
142 G2 upper left corner
143 G3 lower left corner
144 G1 upper right corner
145 G4 lower right corner
146 GR tee pointing right
147 GL tee pointing left
148 GU tee pointing up
149 GD tee pointing down
150 GH horizontal line
151 GV vertical line
152 GC intersection
153 G6 double upper left corner
154 G7 double lower left corner
155 G5 double upper right corner
156 G8 double lower right corner
157 Gr double tee pointing right
158 Gr double tee pointing left
159 Gu double tee pointing up
160 Gd double tee pointing down
161 Gh double horizontal line
162 Gv double vertical line
163 Gc double intersection
164 .\" TODO: There are about 40 box drawing code points in CCSID 437;
165 .\" were there no XENIX capabilities for the mixed single- and double-
166 .\" line intersections?
167 .\"
168 .\" TODO: GG doesn't seem to fit with the others; explain it.
169 GG ACS magic cookie count
170 .TE
171 .PP
172 \fB\%captoinfo\fP composes single-line capabilities into an \fBacsc\fP
173 string,
174 and discards \fBGG\fP and double-line capabilities with a warning
175 diagnostic.
176 .PP
177 IBM's AIX has a \fI\%\%term\%info\fP facility descended from SVr1
178 \fI\%\%term\%info\fP,
179 but which is incompatible with the SVr4 format.
180 \fB\%captoinfo\fP translates the following AIX extensions.
181 .PP
182 .TS
183 center;
184 cb cb
185 l l .
186 IBM X/Open
187 _
188 ksel kslt
189 kbtab kcbt
190 font0 s0ds
191 font1 s1ds
192 font2 s2ds
193 font3 s3ds
194 .TE
195 .PP
196 Additionally,
197 this program translates the AIX \fBbox1\fP capability to an \fBacsc\fP
198 string.
199 .PP
200 The HP-UX \fI\%\%term\%info\fP library supports two nonstandard
201 \fI\%\%term\%info\fP capabilities,
202 \fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
203 \fB\%captoinfo\fP discards these with a warning message.
204 .SH FILES
205 .TP
206 .I /etc/termcap
207 default \fI\%termcap\fP terminal capability database
208 .SH PORTABILITY
209 X/Open Curses Issue\ 7 (2009) describes \fBtic\fP briefly,
210 but omits this program.
211 .PP
212 SVr4 systems provide \fB\%captoinfo\fP as a separate application from
213 \fBtic\fP.
214 Its
215 .B \-v
216 option does not accept a trace level argument
217 .IR n ;
218 repeat
219 .B \-v
220 .I n
221 times instead.
222 .PP
223 NetBSD does not provide this application.
224 .SH AUTHORS
225 Eric S. Raymond <[email protected]>
226 and
227 .br
228 Thomas E. Dickey <dickey@invisible\-island.net>
229 .SH SEE ALSO
230 \fB\%infocmp\fP(1),
231 \fB\%tic\fP(1),
232 \fB\%ncurses\fP(3NCURSES),
233 \fB\%terminfo\fP(5)