man/toe.1m

   1 .\"***************************************************************************
   2 .\" Copyright 2019-2022,2023 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: toe.1m,v 1.52 2023/10/07 21:19:07 tom Exp $
  31 .TH @TOE@ 1M 2023-10-07 "ncurses 6.4" "User commands"
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .ie n .ds CW R
  43 .el   \{
  44 .ie \n(.g .ds CW CR
  45 .el       .ds CW CW
  46 .\}
  47 .
  48 .de bP
  49 .ie n  .IP \(bu 4
  50 .el    .IP \(bu 2
  51 ..
  52 .ds n 5
  53 .ds d @TERMINFO@
  54 .SH NAME
  55 \fB\%@TOE@\fP \-
  56 list table of entries of \fIterminfo\fR terminal types
  57 .SH SYNOPSIS
  58 .B @TOE@
  59 .RB [ \-ahs ]
  60 .RB [ \-v\ \c
  61 .RI [ n ]]
  62 .RI [ directory
  63 \&.\|.\|.]
  64 .PP
  65 .B @TOE@
  66 .RB [ \-u | \-U ]
  67 .I file
  68 .PP
  69 .B "@TOE@ \-V"
  70 .SH DESCRIPTION
  71 \fB\%@TOE@\fP reports to the standard output stream the (primary) names
  72 and descriptions of the terminal types available to the \fIterminfo\fP
  73 library.
  74 Each \fIdirectory\fP operand is scanned;
  75 if none are given,
  76 \fB\%@TOE@\fP scans the the default \fIterminfo\fP directory.
  77 .SH OPTIONS
  78 The \fB\-h\fP option can be helpful to observe where \fB\%@TOE@\fP is
  79 looking for terminal descriptions.
  80 Other options support maintainers of \fIterminfo\fP terminal
  81 descriptions.
  82 .TP 9 \" "-u file" + 2n
  83 .B \-a
  84 lists entries from all terminal database directories that \fIterminfo\fP
  85 would search,
  86 instead of only the first that it finds.
  87 .IP
  88 If the \fB\-s\fP option is also given,
  89 \fB\%@TOE@\fP adds a column to the report,
  90 showing (like \fB\%conflict\fP(1)) which entries belong to a given
  91 terminal database.
  92 An \*(``*\*('' marks entries that differ,
  93 and \*(``+\*('' marks equivalent entries.
  94 .IP
  95 Without the \fB\-s\fP option,
  96 \fB\%@TOE@\fP does not attempt to merge duplicates in its report.
  97 .TP
  98 .B \-h
  99 writes a heading naming each each directory as it is accessed.
 100 .TP
 101 .B \-s
 102 sorts the output by the entry names.
 103 .TP
 104 .BI \-u\  file
 105 lists terminal type dependencies in \fIfile\fP,
 106 a \fIterminfo\fP entry source or \fItermcap\fP database file.
 107 The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and
 108 \*(``\fBtc\fP\*('' (\fItermcap\fP) relations:
 109 each line comprises the primary name of a terminal type employing
 110 \fBuse\fP/\fBtc\fP capabilities,
 111 a colon,
 112 a space- and tab-separated list of primary names of terminal types thus
 113 named,
 114 and a newline.
 115 .TP
 116 .BI \-U\  file
 117 lists terminal type reverse dependencies in \fIfile\fP,
 118 a \fIterminfo\fP entry source or \fItermcap\fP database file.
 119 The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and
 120 \*(``\fBtc\fP\*('' (\fItermcap\fP) reverse relations:
 121 each line comprises the primary name of a terminal type occurring in
 122 \fBuse\fP/\fBtc\fP capabilities,
 123 a colon,
 124 a space- and tab-separated list of primary names of terminal types
 125 naming them thus,
 126 and a newline.
 127 .TP
 128 .BR \-v\  [\c
 129 .IR n ]
 130 reports verbose status information to the standard error stream,
 131 showing \fB\%@TOE@\fP's progress.
 132 .IP
 133 The optional parameter \fIn\fP is an integer between 1 and 10 inclusive,
 134 interpreted as for \fB\%@TIC@\fP(1M).
 135 If \fIncurses\fP is built without tracing support,
 136 \fIn\fP is ignored.
 137 .TP
 138 \fB\-V\fP
 139 reports the version of \fIncurses\fP associated
 140 with this program and exits with a successful status.
 141 .SH EXAMPLES
 142 When not sorting with the \fB\-s\fP option,
 143 the \fB\-a\fP option reports all of the names found in all of the
 144 terminal database directories named in the \fB\%TERMINFO\fP and
 145 \fB\%TERMINFO_DIRS\fP environment variables.
 146 .RS 4
 147 .PP
 148 .\" toe -a | grep -E '^(xterm|vt)'
 149 .TS
 150 Lf(\*(CW)2 Lf(\*(CW).
 151 xterm\-color    generic color xterm
 152 xterm\-xfree86  xterm terminal emulator (XFree86)
 153 xterm\-vt220    xterm emulating vt220
 154 xterm\-256color xterm with 256 colors
 155 xterm\-r6       xterm X11R6 version
 156 xterm\-r5       xterm R5 version
 157 xterm\-mono     monochrome xterm
 158 .\" The next row overruns the line length on DWB nroff (65n).
 159 xterm   xterm terminal emulator (X Window System)
 160 vt220   dec vt220
 161 vt102   dec vt102
 162 vt100   dec vt100 (w/advanced video)
 163 vt52    dec vt52
 164 .T&
 165 L.
 166 \&.\|.\|.
 167 .TE
 168 .RE
 169 .PP
 170 Use the \fB\-a\fP and \fB\-s\fP options together to show where each
 171 terminal description was found.
 172 .RS 4
 173 .PP
 174 .\" toe -as | grep -E '(^-+>|:.(xterm|vt))'
 175 .TS
 176 lf(\*(CW).
 177 \-\-> /etc/terminfo
 178 \-\-\-\-> /lib/terminfo
 179 \-\-\-\-\-\-> /usr/share/terminfo
 180 .TE
 181 .TS
 182 lf(\*(CW)1 lf(\*(CW)2 lf(\*(CW).
 183 \-\-*\-\-\-:    vt100   dec vt100 (w/advanced video)
 184 \-\-*\-\-\-:    vt102   dec vt102
 185 \-\-*\-\-\-:    vt220   dec vt220
 186 \-\-*\-\-\-:    vt52    dec vt52
 187 .\" The next row overruns the line length on DWB nroff (65n).
 188 \-\-*\-\-\-:    xterm   xterm terminal emulator (X Window System)
 189 \-\-*\-\-\-:    xterm\-256color xterm with 256 colors
 190 \-\-*\-\-\-:    xterm\-color    generic color xterm
 191 \-\-*\-\-\-:    xterm\-mono     monochrome xterm
 192 \-\-*\-\-\-:    xterm\-r5       xterm R5 version
 193 \-\-*\-\-\-:    xterm\-r6       xterm X11R6 version
 194 \-\-*\-\-\-:    xterm\-vt220    xterm emulating vt220
 195 .\" The next row overruns the line length on DWB nroff (65n).
 196 \-\-*\-\-\-:    xterm\-xfree86  xterm terminal emulator (XFree86)
 197 .T&
 198 l.
 199 \&.\|.\|.
 200 .TE
 201 .RE
 202 .SH FILES
 203 .TP
 204 \fI\*d\fP
 205 compiled terminal description database
 206 .SH HISTORY
 207 \fB\%@TOE@\fP is not provided by other implementations.
 208 There is no applicable X/Open or POSIX standard for it.
 209 .PP
 210 It replaces a \fB\-T\fP option that was briefly supported by
 211 the \fIncurses\fP \fB\%infocmp\fP utility in 1995.
 212 .PP
 213 The \fB\-a\fP and \fB\-s\fP options were added in 2006 and 2011,
 214 respectively.
 215 .PP
 216 The program's name originates with a developer's pun:
 217 .bP
 218 \fBtic\fP,
 219 .bP
 220 \fBtac\fP (now \fBtack\fP),
 221 .bP
 222 \fBtoe\fP.
 223 .SH SEE ALSO
 224 \fB\%@CAPTOINFO@\fP(1M),
 225 \fB\%@INFOCMP@\fP(1M),
 226 \fB\%@INFOTOCAP@\fP(1M),
 227 \fB\%@TIC@\fP(1M),
 228 \fB\%curses\fP(3X),
 229 \fB\%terminfo\fP(\*n)