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.44 2023/09/16 23:39:05 tom Exp $
  32 .TH @CAPTOINFO@ 1M 2023-09-16 "ncurses 6.4" "User commands"
  33 .ds n 5
  34 .ds d @TERMINFO@
  35 .SH NAME
  36 \fB\%@CAPTOINFO@\fP \-
  37 convert a \fItermcap\fR description into a \fIterminfo\fR description
  38 .SH SYNOPSIS
  39 .B @CAPTOINFO@
  40 .RI [ tic-option ]
  41 .I file
  42 \&.\|.\|.
  43 .P
  44 \fB@CAPTOINFO@\fR \fB\-V\fR
  45 .SH DESCRIPTION
  46 \fB@CAPTOINFO@\fP looks in each given text
  47 \fIfile\fP for \fBtermcap\fP descriptions.
  48 For each
  49 one found, an equivalent \fBterminfo\fP description is written to standard
  50 output.
  51 Termcap \fBtc\fP capabilities are translated directly to terminfo
  52 \fBuse\fP capabilities.
  53 .PP
  54 If no \fIfile\fP is given, then the environment variable \fBTERMCAP\fP is used
  55 for the filename or entry.
  56 If \fBTERMCAP\fP is a full pathname to a file, only
  57 the terminal whose name is specified in the environment variable \fBTERM\fP is
  58 extracted from that file.
  59 If the environment variable \fBTERMCAP\fP is not
  60 set, then the file \fB\*d\fP is read.
  61 .PP
  62 This utility is implemented as a link to \fB@TIC@\fP(1M),
  63 with the latter's
  64 .B \-I
  65 option implied.
  66 You can use other \fB@TIC@\fP options such as
  67 .BR \-1 ,
  68 .BR \-f ,
  69 .BR \-v ,
  70 .BR \-w ,
  71 and
  72 .BR \-x .
  73 .SH FILES
  74 .TP 20
  75 \*d
  76 Compiled terminal description database.
  77 .SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES
  78 Some obsolete nonstandard capabilities will automatically be translated
  79 into standard (SVr4/XSI Curses) terminfo capabilities by \fB@CAPTOINFO@\fP.
  80 Whenever one of these automatic translations is done, the program
  81 will issue an notification to stderr, inviting the user to check that
  82 it has not mistakenly translated a completely unknown and random
  83 capability and/or syntax error.
  84 .PP
  85 .TS
  86 cb cb cb cb
  87 cb cb cb cb
  88 l  l  l  l .
  89 Nonstd  Std     \&      Terminfo
  90 name    name    From    capability
  91 _
  92 BO      mr      AT&T    enter_reverse_mode
  93 CI      vi      AT&T    cursor_invisible
  94 CV      ve      AT&T    cursor_normal
  95 DS      mh      AT&T    enter_dim_mode
  96 EE      me      AT&T    exit_attribute_mode
  97 FE      LF      AT&T    label_on
  98 FL      LO      AT&T    label_off
  99 XS      mk      AT&T    enter_secure_mode
 100 EN      @7      XENIX   key_end
 101 GE      ae      XENIX   exit_alt_charset_mode
 102 GS      as      XENIX   enter_alt_charset_mode
 103 HM      kh      XENIX   key_home
 104 LD      kL      XENIX   key_dl
 105 PD      kN      XENIX   key_npage
 106 PN      po      XENIX   prtr_off
 107 PS      pf      XENIX   prtr_on
 108 PU      kP      XENIX   key_ppage
 109 RT      @8      XENIX   kent
 110 UP      ku      XENIX   kcuu1
 111 KA      k;      Tek     key_f10
 112 KB      F1      Tek     key_f11
 113 KC      F2      Tek     key_f12
 114 KD      F3      Tek     key_f13
 115 KE      F4      Tek     key_f14
 116 KF      F5      Tek     key_f15
 117 BC      Sb      Tek     set_background
 118 FC      Sf      Tek     set_foreground
 119 HS      mh      Iris    enter_dim_mode
 120 .TE
 121 .PP
 122 XENIX termcap also used to have a set of extension capabilities
 123 for forms drawing, designed to take advantage of the IBM PC
 124 high-half graphics.
 125 They were as follows:
 126 .PP
 127 .TS
 128 cb cb
 129 l l.
 130 Cap     Graphic
 131 _
 132 G2      upper left
 133 G3      lower left
 134 G1      upper right
 135 G4      lower right
 136 GR      pointing right
 137 GL      pointing left
 138 GU      pointing up
 139 GD      pointing down
 140 GH      horizontal line
 141 GV      vertical line
 142 GC      intersection
 143 G6      upper left
 144 G7      lower left
 145 G5      upper right
 146 G8      lower right
 147 Gr      tee pointing right
 148 Gr      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 GG      acs magic cookie count
 155 .TE
 156 .PP
 157 If the single-line capabilities occur in an entry, they will automatically
 158 be composed into an \fBacsc\fP string.
 159 The double-line capabilities and
 160 \fBGG\fP are discarded with a warning message.
 161 .PP
 162 IBM's AIX has a terminfo facility descended from SVr1 terminfo but incompatible
 163 with the SVr4 format.
 164 The following AIX extensions are automatically
 165 translated:
 166 .PP
 167 .TS
 168 cb cb
 169 l  l .
 170 IBM     XSI
 171 _
 172 ksel    kslt
 173 kbtab   kcbt
 174 font0   s0ds
 175 font1   s1ds
 176 font2   s2ds
 177 font3   s3ds
 178 .TE
 179 .PP
 180 Additionally, the AIX \fIbox1\fP capability will be automatically translated to
 181 an \fBacsc\fP string.
 182 .PP
 183 Hewlett-Packard's terminfo library supports two nonstandard terminfo
 184 capabilities \fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
 185 These will be discarded with a warning message.
 186 .SH NOTES
 187 The verbose option is not identical to SVr4's.
 188 Under SVr4, instead of following
 189 the \fB\-v\fP with a trace level n, you repeat it n times.
 190 .SH PORTABILITY
 191 X/Open Curses, Issue 7 (2009) describes \fBtic\fP briefly,
 192 but omits this program.
 193 SVr4 systems provide \fBcaptoinfo\fP as a separate application from \fBtic\fP.
 194 .PP
 195 NetBSD does not provide this application.
 196 .SH SEE ALSO
 197 \fB@INFOCMP@\fP(1M),
 198 \fBcurses\fP(3X),
 199 \fBterminfo\fP(\*n)
 200 .PP
 201 This describes \fBncurses\fP
 202 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
 203 .SH AUTHOR
 204 Eric S. Raymond <esr@snark.thyrsus.com>
 205 and
 206 .br
 207 Thomas E. Dickey <dickey@invisible-island.net>