man/toe.1m

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2019-2023,2024 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2015,2017 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: toe.1m,v 1.68 2024/04/20 18:59:26 tom Exp $
  32 .TH @TOE@ 1M 2024-04-20 "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 .ie n .ds CW R
  44 .el   \{
  45 .ie \n(.g .ds CW CR
  46 .el       .ds CW CW
  47 .\}
  48 .
  49 .de bP
  50 .ie n  .IP \(bu 4
  51 .el    .IP \(bu 2
  52 ..
  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 is scanned;
  75 if none are given,
  76 \fB\%@TOE@\fP scans 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
  89 .B \-s
  90 is also given,
  91 \fB\%@TOE@\fP
  92 additionally reports,
  93 like \fI\%conflict\fP(1),
  94 which entries correspond to a given terminal database.
  95 An \*(``*\*('' marks entries that differ,
  96 and \*(``+\*('' marks equivalent entries.
  97 .IP
  98 Without the \fB\-s\fP option,
  99 \fB\%@TOE@\fP does not attempt to merge duplicates in its report.
 100 .TP
 101 .B \-h
 102 writes a heading naming each each directory as it is accessed.
 103 .TP
 104 .B \-s
 105 sorts the output by the entry names.
 106 .TP
 107 .BI \-u\  file
 108 lists terminal type dependencies in \fIfile\fP,
 109 a \fIterminfo\fP entry source or \fItermcap\fP database file.
 110 The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and
 111 \fBtc\fP (\fItermcap\fP) relations:
 112 each line comprises the primary name of a terminal type employing
 113 \fBuse\fP/\fBtc\fP capabilities,
 114 a colon,
 115 a space- and tab-separated list of primary names of terminal types thus
 116 named,
 117 and a newline.
 118 .TP
 119 .BI \-U\  file
 120 lists terminal type reverse dependencies in \fIfile\fP,
 121 a \fIterminfo\fP entry source or \fItermcap\fP database file.
 122 The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and
 123 \fBtc\fP (\fItermcap\fP) reverse relations:
 124 each line comprises the primary name of a terminal type occurring in
 125 \fBuse\fP/\fBtc\fP capabilities,
 126 a colon,
 127 a space- and tab-separated list of primary names of terminal types
 128 naming them thus,
 129 and a newline.
 130 .TP
 131 .BR \-v\  [\c
 132 .IR n ]
 133 reports verbose status information to the standard error stream,
 134 showing \fB\%@TOE@\fP's progress.
 135 .IP
 136 The optional parameter \fIn\fP is an integer between 1 and 10 inclusive,
 137 interpreted as for \fB\%@TIC@\fP(1M).
 138 If \fI\%ncurses\fP is built without tracing support,
 139 \fIn\fP is ignored.
 140 .TP
 141 \fB\-V\fP
 142 reports the version of \fI\%ncurses\fP associated
 143 with this program and exits with a successful status.
 144 .SH FILES
 145 .TP
 146 .I \*d
 147 compiled terminal description database
 148 .SH PORTABILITY
 149 \fB\%@TOE@\fP is not provided by other implementations.
 150 There is no applicable X/Open or POSIX standard for it.
 151 .SH HISTORY
 152 \fB\%@TOE@\fP replaces a \fB\-T\fP option that was briefly supported by
 153 the \fI\%ncurses\fP \fB\%infocmp\fP utility in 1995.
 154 .PP
 155 The \fB\-a\fP and \fB\-s\fP options were added in 2006 and 2011,
 156 respectively.
 157 .PP
 158 The program's name originates with a developer's pun:
 159 .bP
 160 \fBtic\fP,
 161 .bP
 162 \fBtac\fP (now \fBtack\fP),
 163 .bP
 164 \fBtoe\fP.
 165 .SH EXAMPLES
 166 When not sorting with the \fB\-s\fP option,
 167 the \fB\-a\fP option reports all of the names found in all of the
 168 terminal database directories named in the \fI\%TERMINFO\fP and
 169 \fI\%TERMINFO_DIRS\fP environment variables.
 170 .RS 4
 171 .PP
 172 .\" toe -a | grep -E '^(xterm|vt)'
 173 .ft \*(CW
 174 .TS
 175 L2 Lx.
 176 xterm\-color    generic color xterm
 177 xterm\-xfree86  xterm terminal emulator (XFree86)
 178 xterm\-vt220    xterm emulating vt220
 179 xterm\-256color xterm with 256 colors
 180 xterm\-r6       xterm X11R6 version
 181 xterm\-r5       xterm R5 version
 182 xterm\-mono     monochrome xterm
 183 xterm   T{
 184 .ad l
 185 xterm terminal emulator (X Window System)
 186 T}
 187 vt220   dec vt220
 188 vt102   dec vt102
 189 vt100   dec vt100 (w/advanced video)
 190 vt52    dec vt52
 191 .T&
 192 L.
 193 \&.\|.\|.
 194 .TE
 195 .ft
 196 .RE
 197 .PP
 198 Use the \fB\-a\fP and \fB\-s\fP options together to show where each
 199 terminal description was found.
 200 .RS 4
 201 .PP
 202 .\" toe -as | grep -E '(^-+>|:.(xterm|vt))'
 203 .ft \*(CW
 204 .TS
 205 Lx.
 206 \-\-> /etc/terminfo
 207 \-\-\-\-> /lib/terminfo
 208 \-\-\-\-\-\-> /usr/share/terminfo
 209 .TE
 210 .TS
 211 L1 L2 Lx.
 212 \-\-*\-\-\-:    vt100   dec vt100 (w/advanced video)
 213 \-\-*\-\-\-:    vt102   dec vt102
 214 \-\-*\-\-\-:    vt220   dec vt220
 215 \-\-*\-\-\-:    vt52    dec vt52
 216 \-\-*\-\-\-:    xterm   T{
 217 .ad l
 218 xterm terminal emulator (X Window System)
 219 T}
 220 \-\-*\-\-\-:    xterm\-256color xterm with 256 colors
 221 \-\-*\-\-\-:    xterm\-color    generic color xterm
 222 \-\-*\-\-\-:    xterm\-mono     monochrome xterm
 223 \-\-*\-\-\-:    xterm\-r5       xterm R5 version
 224 \-\-*\-\-\-:    xterm\-r6       xterm X11R6 version
 225 \-\-*\-\-\-:    xterm\-vt220    xterm emulating vt220
 226 \-\-*\-\-\-:    xterm\-xfree86  T{
 227 .ad l
 228 xterm terminal emulator (XFree86)
 229 T}
 230 .T&
 231 L.
 232 \&.\|.\|.
 233 .TE
 234 .ft
 235 .RE
 236 .SH SEE ALSO
 237 \fB\%@CAPTOINFO@\fP(1M),
 238 \fB\%@INFOCMP@\fP(1M),
 239 \fB\%@INFOTOCAP@\fP(1M),
 240 \fB\%@TIC@\fP(1M),
 241 \fB\%curses\fP(3X),
 242 \fB\%terminfo\fP(5)