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