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.52 2023/10/14 19:25:26 tom Exp $
  32 .TH @CAPTOINFO@ 1M 2023-10-14 "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 n 5
  48 .ds d /etc/termcap
  49 .SH NAME
  50 \fB\%@CAPTOINFO@\fP \-
  51 convert a \fItermcap\fR description into a \fIterminfo\fR description
  52 .SH SYNOPSIS
  53 .B @CAPTOINFO@
  54 .RI [ tic-option ]
  55 .RI [ file
  56 \&.\|.\|.]
  57 .P
  58 .B "@CAPTOINFO@ \-V"
  59 .SH DESCRIPTION
  60 \fB\%@CAPTOINFO@\fP looks in each given text
  61 \fIfile\fP for \fItermcap\fP descriptions.
  62 For each one found,
  63 it writes an equivalent \fIterminfo\fP description to the standard
  64 output stream.
  65 \fItermcap\fP \fBtc\fP capabilities are translated directly to
  66 \fIterminfo\fP \*(``\fBuse\fP\*('' capabilities.
  67 .PP
  68 If no \fIfile\fPs are specified,
  69 \fB\%@CAPTOINFO@\fP interprets the content of the environment variable
  70 \fB\%TERMCAP\fP as a file name,
  71 and extracts only the entry for the terminal named in the environment
  72 variable \fB\%TERM\fP from it.
  73 If the environment variable \fB\%TERMCAP\fP is not set,
  74 \fB\%@CAPTOINFO@\fP reads \fI\%\*d\fP.
  75 .PP
  76 This utility is implemented as a link to \fB\%@TIC@\fP(1M),
  77 with the latter's
  78 .B \-I
  79 option implied.
  80 You can use other \fB\%@TIC@\fP options such as
  81 .BR \-1 ,
  82 .BR \-f ,
  83 .BR \-v ,
  84 .BR \-w ,
  85 and
  86 .BR \-x .
  87 The \fB\-V\fP option reports the version of \fIncurses\fP associated
  88 with this program and exits with a successful status.
  89 .SS "Translations from nonstandard capabilities"
  90 \fB\%@CAPTOINFO@\fP translates some obsolete,
  91 nonstandard capabilities into standard (SVr4/XSI Curses) \fIterminfo\fP
  92 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 cb cb cb
  99 cb cb cb cb
 100 cb cb l  lb.
 101 Nonstandard     Standard        \&      \f(BIterminfo\fP
 102 name    name    From    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;      Tek     key_f10
 124 KB      F1      Tek     key_f11
 125 KC      F2      Tek     key_f12
 126 KD      F3      Tek     key_f13
 127 KE      F4      Tek     key_f14
 128 KF      F5      Tek     key_f15
 129 BC      Sb      Tek     set_background
 130 FC      Sf      Tek     set_foreground
 131 HS      mh      Iris    enter_dim_mode
 132 .TE
 133 .PP
 134 XENIX \fItermcap\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 cb
 142 cb l .
 143 Termcap
 144 Name    Graphic
 145 _
 146 G2      upper left corner
 147 G3      lower left corner
 148 G1      upper right corner
 149 G4      lower right corner
 150 GR      tee pointing right
 151 GL      tee pointing left
 152 GU      tee pointing up
 153 GD      tee pointing down
 154 GH      horizontal line
 155 GV      vertical line
 156 GC      intersection
 157 G6      double upper left corner
 158 G7      double lower left corner
 159 G5      double upper right corner
 160 G8      double lower right corner
 161 Gr      double tee pointing right
 162 Gr      double tee pointing left
 163 Gu      double tee pointing up
 164 Gd      double tee pointing down
 165 Gh      double horizontal line
 166 Gv      double vertical line
 167 Gc      double intersection
 168 .\" TODO: There are about 40 box drawing code points in CCSID 437;
 169 .\" were there no XENIX capabilities for the mixed single- and double-
 170 .\" line intersections?
 171 .\"
 172 .\" TODO: GG doesn't seem to fit with the others; explain it.
 173 GG      ACS magic cookie count
 174 .TE
 175 .PP
 176 If the single-line capabilities occur in an entry,
 177 they are composed into an \fBacsc\fP string.
 178 The double-line capabilities and
 179 \fBGG\fP are discarded with a warning message.
 180 .PP
 181 IBM's AIX has a \fIterminfo\fP facility descended from SVr1
 182 \fIterminfo\fP,
 183 but which is incompatible with the SVr4 format.
 184 \fB\%@CAPTOINFO@\fP translates the following AIX extensions.
 185 .PP
 186 .TS
 187 cb cb
 188 l  l .
 189 IBM     XSI
 190 _
 191 ksel    kslt
 192 kbtab   kcbt
 193 font0   s0ds
 194 font1   s1ds
 195 font2   s2ds
 196 font3   s3ds
 197 .TE
 198 .PP
 199 Additionally,
 200 this program translates the AIX \fBbox1\fP capability to an \fBacsc\fP
 201 string.
 202 .PP
 203 The HP-UX \fIterminfo\fP library supports two nonstandard \fIterminfo\fP
 204 capabilities,
 205 \fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
 206 \fB\%@CAPTOINFO@\fP discards these with a warning message.
 207 .SH FILES
 208 .TP
 209 \fI\*d\fP
 210 default \fItermcap\fP terminal capability database
 211 .SH NOTES
 212 The verbose option is not identical to SVr4's.
 213 Under SVr4, instead of following
 214 the \fB\-v\fP with a trace level \fIn\fP,
 215 you repeat it \fIn\fP times.
 216 .SH PORTABILITY
 217 X/Open Curses, Issue 7 (2009) describes \fBtic\fP briefly,
 218 but omits this program.
 219 SVr4 systems provide \fB\%captoinfo\fP as a separate application from
 220 \fBtic\fP.
 221 .PP
 222 NetBSD does not provide this application.
 223 .SH AUTHOR
 224 Eric S. Raymond <esr@snark.thyrsus.com>
 225 and
 226 .br
 227 Thomas E. Dickey <dickey@invisible\-island.net>
 228 .SH SEE ALSO
 229 \fB\%@INFOCMP@\fP(1M),
 230 \fB\%@TIC@\fP(1M),
 231 \fB\%curses\fP(3X),
 232 \fB\%terminfo\fP(\*n)