man/captoinfo.1m

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2023,2024 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.63 2024/03/23 20:37:25 tom Exp $
  32 .TH @CAPTOINFO@ 1M 2024-03-23 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "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(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 .\" DWB 3.3 tbl requires the two junk "L" specifiers in the first row.
  94 .TS
  95 center;
  96 Cb S  L  L
  97 Cb Cb Cb Cb
  98 Cb Cb C  Lb.
  99 Name
 100 Obsolete        Standard        Origin  \f(BIterminfo\fP capability
 101 _
 102 BO      mr      AT&T    enter_reverse_mode
 103 CI      vi      AT&T    cursor_invisible
 104 CV      ve      AT&T    cursor_normal
 105 DS      mh      AT&T    enter_dim_mode
 106 EE      me      AT&T    exit_attribute_mode
 107 FE      LF      AT&T    label_on
 108 FL      LO      AT&T    label_off
 109 XS      mk      AT&T    enter_secure_mode
 110 EN      @7      XENIX   key_end
 111 GE      ae      XENIX   exit_alt_charset_mode
 112 GS      as      XENIX   enter_alt_charset_mode
 113 HM      kh      XENIX   key_home
 114 LD      kL      XENIX   key_dl
 115 PD      kN      XENIX   key_npage
 116 PN      po      XENIX   prtr_off
 117 PS      pf      XENIX   prtr_on
 118 PU      kP      XENIX   key_ppage
 119 RT      @8      XENIX   kent
 120 UP      ku      XENIX   kcuu1
 121 KA      k;      Tektronix       key_f10
 122 KB      F1      Tektronix       key_f11
 123 KC      F2      Tektronix       key_f12
 124 KD      F3      Tektronix       key_f13
 125 KE      F4      Tektronix       key_f14
 126 KF      F5      Tektronix       key_f15
 127 BC      Sb      Tektronix       set_background
 128 FC      Sf      Tektronix       set_foreground
 129 HS      mh      IRIX    enter_dim_mode
 130 .TE
 131 .PP
 132 XENIX \fI\%termcap\fP had a set of extension capabilities,
 133 corresponding to box drawing characters of CCSID
 134 (\*(``code page\*('') 437,
 135 as follows.
 136 .PP
 137 .TS
 138 center;
 139 cb cb
 140 cb l .
 141 \f(BItermcap\fP Name    Graphic
 142 _
 143 G2      upper left corner
 144 G3      lower left corner
 145 G1      upper right corner
 146 G4      lower right corner
 147 GR      tee pointing right
 148 GL      tee pointing left
 149 GU      tee pointing up
 150 GD      tee pointing down
 151 GH      horizontal line
 152 GV      vertical line
 153 GC      intersection
 154 G6      double upper left corner
 155 G7      double lower left corner
 156 G5      double upper right corner
 157 G8      double lower right corner
 158 Gr      double tee pointing right
 159 Gr      double tee pointing left
 160 Gu      double tee pointing up
 161 Gd      double tee pointing down
 162 Gh      double horizontal line
 163 Gv      double vertical line
 164 Gc      double intersection
 165 .\" TODO: There are about 40 box drawing code points in CCSID 437;
 166 .\" were there no XENIX capabilities for the mixed single- and double-
 167 .\" line intersections?
 168 .\"
 169 .\" TODO: GG doesn't seem to fit with the others; explain it.
 170 GG      ACS magic cookie count
 171 .TE
 172 .PP
 173 \fB\%@CAPTOINFO@\fP composes single-line capabilities into an \fBacsc\fP
 174 string,
 175 and discards \fBGG\fP and double-line capabilities with a warning
 176 diagnostic.
 177 .PP
 178 IBM's AIX has a \fI\%\%term\%info\fP facility descended from SVr1
 179 \fI\%\%term\%info\fP,
 180 but which is incompatible with the SVr4 format.
 181 \fB\%@CAPTOINFO@\fP translates the following AIX extensions.
 182 .PP
 183 .TS
 184 center;
 185 cb cb
 186 l  l .
 187 IBM     XSI
 188 _
 189 ksel    kslt
 190 kbtab   kcbt
 191 font0   s0ds
 192 font1   s1ds
 193 font2   s2ds
 194 font3   s3ds
 195 .TE
 196 .PP
 197 Additionally,
 198 this program translates the AIX \fBbox1\fP capability to an \fBacsc\fP
 199 string.
 200 .PP
 201 The HP-UX \fI\%\%term\%info\fP library supports two nonstandard
 202 \fI\%\%term\%info\fP capabilities,
 203 \fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
 204 \fB\%@CAPTOINFO@\fP discards these with a warning message.
 205 .SH FILES
 206 .TP
 207 .I /etc/termcap
 208 default \fI\%termcap\fP terminal capability database
 209 .SH PORTABILITY
 210 X/Open Curses,
 211 Issue 7 (2009) describes \fBtic\fP briefly,
 212 but omits this program.
 213 .PP
 214 SVr4 systems provide \fB\%captoinfo\fP as a separate application from
 215 \fBtic\fP.
 216 Its
 217 .B \-v
 218 option does not accept a trace level argument
 219 .IR n ;
 220 repeat
 221 .B \-v
 222 .I n
 223 times instead.
 224 .PP
 225 NetBSD does not provide this application.
 226 .SH AUTHORS
 227 Eric S. Raymond <esr@snark.thyrsus.com>
 228 and
 229 .br
 230 Thomas E. Dickey <dickey@invisible\-island.net>
 231 .SH SEE ALSO
 232 \fB\%@INFOCMP@\fP(1M),
 233 \fB\%@TIC@\fP(1M),
 234 \fB\%curses\fP(3X),
 235 \fB\%terminfo\fP(5)