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.54 2023/11/25 14:32:36 tom Exp $
  32 .TH @CAPTOINFO@ 1M 2023-11-25 "ncurses 6.4" "User commands"
  33 .ie \n(.g \{\
  34 .ds `` \(lq
  35 .ds '' \(rq
  36 .ds '  \(aq
  37 .\}
  38 .el \{\
  39 .ie t .ds `` ``
  40 .el   .ds `` ""
  41 .ie t .ds '' ''
  42 .el   .ds '' ""
  43 .ie t .ds '  \(aq
  44 .el   .ds '  '
  45 .\}
  46 .
  47 .ds d /etc/termcap
  48 .SH NAME
  49 \fB\%@CAPTOINFO@\fP \-
  50 convert a \fItermcap\fR description into a \fIterminfo\fR description
  51 .SH SYNOPSIS
  52 .B @CAPTOINFO@
  53 .RI [ tic-option ]
  54 .RI [ file
  55 \&.\|.\|.]
  56 .P
  57 .B "@CAPTOINFO@ \-V"
  58 .SH DESCRIPTION
  59 \fB\%@CAPTOINFO@\fP translates terminal descriptions.
  60 It looks in each given text \fIfile\fP for \fI\%termcap\fP entries and,
  61 for each one found,
  62 writes an equivalent \fI\%terminfo\fP description to the standard output
  63 stream.
  64 \fI\%termcap\fP \fBtc\fP capabilities translate to \fI\%terminfo\fP
  65 \*(``\fBuse\fP\*('' capabilities.
  66 .PP
  67 If no \fIfile\fPs are specified,
  68 \fB\%@CAPTOINFO@\fP interprets the content of the environment variable
  69 \fI\%TERMCAP\fP as a file name,
  70 and extracts only the entry for the terminal named in the environment
  71 variable \fITERM\fP from it.
  72 If the environment variable \fI\%TERMCAP\fP is not set,
  73 \fB\%@CAPTOINFO@\fP reads \fI\%\*d\fP.
  74 .PP
  75 This utility is implemented as a link to \fB\%@TIC@\fP(1M),
  76 with the latter's
  77 .B \-I
  78 option implied.
  79 You can use other \fB\%@TIC@\fP options such as
  80 .BR \-1 ,
  81 .BR \-f ,
  82 .BR \-v ,
  83 .BR \-w ,
  84 and
  85 .BR \-x .
  86 The \fB\-V\fP option reports the version of \fI\%ncurses\fP associated
  87 with this program and exits with a successful status.
  88 .SS "Translations from nonstandard capabilities"
  89 \fB\%@CAPTOINFO@\fP translates some obsolete,
  90 nonstandard capabilities into standard
  91 (SVr4/XSI Curses)
  92 \fI\%terminfo\fP capabilities.
  93 It issues a diagnostic to the standard error stream for each,
  94 inviting the user to check that it has not mistakenly translated an
  95 unknown or mistyped capability name.
  96 .PP
  97 .TS
  98 Cb S
  99 Cb Cb Cb Cb
 100 Cb Cb C  Lb.
 101 Name
 102 Obsolete        Standard        Origin  \f(BIterminfo\fP capability
 103 _
 104 BO      mr      AT&T    enter_reverse_mode
 105 CI      vi      AT&T    cursor_invisible
 106 CV      ve      AT&T    cursor_normal
 107 DS      mh      AT&T    enter_dim_mode
 108 EE      me      AT&T    exit_attribute_mode
 109 FE      LF      AT&T    label_on
 110 FL      LO      AT&T    label_off
 111 XS      mk      AT&T    enter_secure_mode
 112 EN      @7      XENIX   key_end
 113 GE      ae      XENIX   exit_alt_charset_mode
 114 GS      as      XENIX   enter_alt_charset_mode
 115 HM      kh      XENIX   key_home
 116 LD      kL      XENIX   key_dl
 117 PD      kN      XENIX   key_npage
 118 PN      po      XENIX   prtr_off
 119 PS      pf      XENIX   prtr_on
 120 PU      kP      XENIX   key_ppage
 121 RT      @8      XENIX   kent
 122 UP      ku      XENIX   kcuu1
 123 KA      k;      Tektronix       key_f10
 124 KB      F1      Tektronix       key_f11
 125 KC      F2      Tektronix       key_f12
 126 KD      F3      Tektronix       key_f13
 127 KE      F4      Tektronix       key_f14
 128 KF      F5      Tektronix       key_f15
 129 BC      Sb      Tektronix       set_background
 130 FC      Sf      Tektronix       set_foreground
 131 HS      mh      IRIX    enter_dim_mode
 132 .TE
 133 .PP
 134 XENIX \fI\%termcap\fP had a set of extension capabilities,
 135 corresponding to box drawing characters of CCSID
 136 (\*(``code page\*('') 437,
 137 as follows.
 138 .PP
 139 .TS
 140 cb cb
 141 cb l .
 142 \f(BItermcap\fP Name    Graphic
 143 _
 144 G2      upper left corner
 145 G3      lower left corner
 146 G1      upper right corner
 147 G4      lower right corner
 148 GR      tee pointing right
 149 GL      tee pointing left
 150 GU      tee pointing up
 151 GD      tee pointing down
 152 GH      horizontal line
 153 GV      vertical line
 154 GC      intersection
 155 G6      double upper left corner
 156 G7      double lower left corner
 157 G5      double upper right corner
 158 G8      double lower right corner
 159 Gr      double tee pointing right
 160 Gr      double tee pointing left
 161 Gu      double tee pointing up
 162 Gd      double tee pointing down
 163 Gh      double horizontal line
 164 Gv      double vertical line
 165 Gc      double intersection
 166 .\" TODO: There are about 40 box drawing code points in CCSID 437;
 167 .\" were there no XENIX capabilities for the mixed single- and double-
 168 .\" line intersections?
 169 .\"
 170 .\" TODO: GG doesn't seem to fit with the others; explain it.
 171 GG      ACS magic cookie count
 172 .TE
 173 .PP
 174 \fB\%@CAPTOINFO@\fP composes single-line capabilities into an \fBacsc\fP
 175 string,
 176 and discards \fBGG\fP and double-line capabilities with a warning
 177 diagnostic.
 178 .PP
 179 IBM's AIX has a \fI\%terminfo\fP facility descended from SVr1
 180 \fI\%terminfo\fP,
 181 but which is incompatible with the SVr4 format.
 182 \fB\%@CAPTOINFO@\fP translates the following AIX extensions.
 183 .PP
 184 .TS
 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\%terminfo\fP library supports two nonstandard
 202 \fI\%terminfo\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 \fI\*d\fP
 208 default \fI\%termcap\fP terminal capability database
 209 .SH NOTES
 210 The verbose option is not identical to SVr4's.
 211 Under SVr4,
 212 instead of following the \fB\-v\fP with a trace level \fIn\fP,
 213 you repeat it \fIn\fP times.
 214 .SH PORTABILITY
 215 X/Open Curses,
 216 Issue 7 (2009) describes \fBtic\fP briefly,
 217 but omits this program.
 218 SVr4 systems provide \fB\%captoinfo\fP as a separate application from
 219 \fBtic\fP.
 220 .PP
 221 NetBSD does not provide this application.
 222 .SH AUTHORS
 223 Eric S. Raymond <esr@snark.thyrsus.com>
 224 and
 225 .br
 226 Thomas E. Dickey <dickey@invisible\-island.net>
 227 .SH SEE ALSO
 228 \fB\%@INFOCMP@\fP(1M),
 229 \fB\%@TIC@\fP(1M),
 230 \fB\%curses\fP(3X),
 231 \fB\%terminfo\fP(5)