ncurses 6.0 - patch 20161015
[ncurses.git] / man / captoinfo.1m
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2016 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: captoinfo.1m,v 1.26 2016/10/15 17:26:09 tom Exp $
31 .TH @CAPTOINFO@ 1M ""
32 .ds n 5
33 .ds d @TERMINFO@
34 .SH NAME
35 \fB@CAPTOINFO@\fR \- convert a \fItermcap\fR description into a \fIterminfo\fR description
36 .SH SYNOPSIS
37 \fB@CAPTOINFO@\fR [\fB\-v\fR\fIn\fR \fIwidth\fR]  [\fB\-V\fR] [\fB\-1\fR] [\fB\-w\fR \fIwidth\fR] \fIfile\fR . . .
38 .SH DESCRIPTION
39 \fB@CAPTOINFO@\fR looks in each given text
40 \fIfile\fR for \fBtermcap\fR descriptions.
41 For each
42 one found, an equivalent \fBterminfo\fR description is written to standard
43 output.
44 Termcap \fBtc\fR capabilities are translated directly to terminfo
45 \fBuse\fR capabilities.
46 .PP
47 If no \fIfile\fR is given, then the environment variable \fBTERMCAP\fR is used
48 for the filename or entry.
49 If \fBTERMCAP\fR is a full pathname to a file, only
50 the terminal whose name is specified in the environment variable \fBTERM\fR is
51 extracted from that file.
52 If the environment variable \fBTERMCAP\fR is not
53 set, then the file \fB\*d\fR is read.
54 .TP 5
55 \fB\-v\fR
56 print out tracing information on standard error as the program runs.
57 .TP 5
58 \fB\-V\fR
59 print out the version of the program in use on standard error and exit.
60 .TP 5
61 \fB\-1\fR
62 cause the fields to print out one to a line.
63 Otherwise, the fields
64 will be printed several to a line to a maximum width of 60
65 characters.
66 .TP 5
67 \fB\-w\fR
68 change the output to \fIwidth\fR characters.
69 .SH FILES
70 .TP 20
71 \*d
72 Compiled terminal description database.
73 .SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES
74 .PP
75 Some obsolete nonstandard capabilities will automatically be translated
76 into standard (SVr4/XSI Curses) terminfo capabilities by \fB@CAPTOINFO@\fR.
77 Whenever one of these automatic translations is done, the program
78 will issue an notification to stderr, inviting the user to check that
79 it has not mistakenly translated a completely unknown and random
80 capability and/or syntax error.
81 .PP
82 .TS H
83 c c c c
84 c c c c
85 l l l l.
86 Nonstd  Std     From    Terminfo
87 name    name            capability
88 _
89 BO      mr      AT&T    enter_reverse_mode
90 CI      vi      AT&T    cursor_invisible
91 CV      ve      AT&T    cursor_normal
92 DS      mh      AT&T    enter_dim_mode
93 EE      me      AT&T    exit_attribute_mode
94 FE      LF      AT&T    label_on
95 FL      LO      AT&T    label_off
96 XS      mk      AT&T    enter_secure_mode
97 EN      @7      XENIX   key_end
98 GE      ae      XENIX   exit_alt_charset_mode
99 GS      as      XENIX   enter_alt_charset_mode
100 HM      kh      XENIX   key_home
101 LD      kL      XENIX   key_dl
102 PD      kN      XENIX   key_npage
103 PN      po      XENIX   prtr_off
104 PS      pf      XENIX   prtr_on
105 PU      kP      XENIX   key_ppage
106 RT      @8      XENIX   kent
107 UP      ku      XENIX   kcuu1
108 KA      k;      Tek     key_f10
109 KB      F1      Tek     key_f11
110 KC      F2      Tek     key_f12
111 KD      F3      Tek     key_f13
112 KE      F4      Tek     key_f14
113 KF      F5      Tek     key_f15
114 BC      Sb      Tek     set_background
115 FC      Sf      Tek     set_foreground
116 HS      mh      Iris    enter_dim_mode
117 .TE
118 .PP
119 XENIX termcap also used to have a set of extension capabilities
120 for forms drawing, designed to take advantage of the IBM PC
121 high-half graphics.
122 They were as follows:
123 .PP
124 .TS H
125 c c
126 l l.
127 Cap     Graphic
128 _
129 G2      upper left
130 G3      lower left
131 G1      upper right
132 G4      lower right
133 GR      pointing right
134 GL      pointing left
135 GU      pointing up
136 GD      pointing down
137 GH      horizontal line
138 GV      vertical line
139 GC      intersection
140 G6      upper left
141 G7      lower left
142 G5      upper right
143 G8      lower right
144 Gr      tee pointing right
145 Gr      tee pointing left
146 Gu      tee pointing up
147 Gd      tee pointing down
148 Gh      horizontal line
149 Gv      vertical line
150 Gc      intersection
151 GG      acs magic cookie count
152 .TE
153 .PP
154 If the single-line capabilities occur in an entry, they will automatically
155 be composed into an \fBacsc\fR string.
156 The double-line capabilities and
157 \fBGG\fR are discarded with a warning message.
158 .PP
159 IBM's AIX has a terminfo facility descended from SVr1 terminfo but incompatible
160 with the SVr4 format.
161 The following AIX extensions are automatically
162 translated:
163 .TS
164 c c
165 l l.
166 IBM     XSI
167 _
168 ksel    kslt
169 kbtab   kcbt
170 font0   s0ds
171 font1   s1ds
172 font2   s2ds
173 font3   s3ds
174 .TE
175 .PP
176 Additionally, the AIX \fIbox1\fR capability will be automatically translated to
177 an \fBacsc\fR string.
178 .PP
179 Hewlett-Packard's terminfo library supports two nonstandard terminfo
180 capabilities \fBmeml\fR (memory lock) and \fBmemu\fR (memory unlock).
181 These will be discarded with a warning message.
182 .SH NOTES
183 This utility is actually a link to \fB@TIC@\fR(1M), running in \fI\-I\fR mode.
184 You can use other \fB@TIC@\fR options such as \fB\-f\fR and  \fB\-x\fR.
185 .PP
186 The trace option is not identical to SVr4's.
187 Under SVr4, instead of following
188 the \fB\-v\fR with a trace level n, you repeat it n times.
189 .SH SEE ALSO
190 \fB@INFOCMP@\fR(1M),
191 \fBcurses\fR(3X),
192 \fBterminfo\fR(\*n)
193 .PP
194 This describes \fBncurses\fR
195 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
196 .SH AUTHOR
197 Eric S. Raymond <esr@snark.thyrsus.com>
198 and
199 .br
200 Thomas E. Dickey <dickey@invisible-island.net>