man/captoinfo.1m

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2022,2023 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.58 2023/12/23 16:28:31 tom Exp $
  32 .TH @CAPTOINFO@ 1M 2023-12-23 "ncurses 6.4" "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 .I \%/etc/termcap.
  70 .PP
  71 This utility is implemented as a link to \fB\%@TIC@\fP(1M),
  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 (SVr4/XSI Curses)
  88 \fI\%\%term\%info\fP capabilities.
  89 It issues a diagnostic to the standard error stream for each,
  90 inviting the user to check that it has not mistakenly translated an
  91 unknown or mistyped capability name.
  92 .PP
  93 .TS
  94 center;
  95 Cb S
  96 Cb Cb Cb Cb
  97 Cb Cb C  Lb.
  98 Name
  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 Name    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     XSI
 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,
 210 Issue 7 (2009) describes \fBtic\fP briefly,
 211 but omits this program.
 212 .PP
 213 SVr4 systems provide \fB\%captoinfo\fP as a separate application from
 214 \fBtic\fP.
 215 Its
 216 .B \-v
 217 option does not accept a trace level argument
 218 .I n;
 219 repeat
 220 .B \-v
 221 .I n
 222 times instead.
 223 .PP
 224 NetBSD does not provide this application.
 225 .SH AUTHORS
 226 Eric S. Raymond <esr@snark.thyrsus.com>
 227 and
 228 .br
 229 Thomas E. Dickey <dickey@invisible\-island.net>
 230 .SH SEE ALSO
 231 \fB\%@INFOCMP@\fP(1M),
 232 \fB\%@TIC@\fP(1M),
 233 \fB\%curses\fP(3X),
 234 \fB\%terminfo\fP(5)