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.62 2024/01/13 22:05:39 tom Exp $
  32 .TH @TOE@ 1M 2024-01-13 "ncurses 6.4" "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 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 \fI\%ncurses\fP is built without tracing support,
 136 \fIn\fP is ignored.
 137 .TP
 138 \fB\-V\fP
 139 reports the version of \fI\%ncurses\fP associated
 140 with this program and exits with a successful status.
 141 .SH FILES
 142 .TP
 143 .I \*d
 144 compiled terminal description database
 145 .SH PORTABILITY
 146 \fB\%@TOE@\fP is not provided by other implementations.
 147 There is no applicable X/Open or POSIX standard for it.
 148 .SH HISTORY
 149 \fB\%@TOE@\fP replaces a \fB\-T\fP option that was briefly supported by
 150 the \fI\%ncurses\fP \fB\%infocmp\fP utility in 1995.
 151 .PP
 152 The \fB\-a\fP and \fB\-s\fP options were added in 2006 and 2011,
 153 respectively.
 154 .PP
 155 The program's name originates with a developer's pun:
 156 .bP
 157 \fBtic\fP,
 158 .bP
 159 \fBtac\fP (now \fBtack\fP),
 160 .bP
 161 \fBtoe\fP.
 162 .SH EXAMPLES
 163 When not sorting with the \fB\-s\fP option,
 164 the \fB\-a\fP option reports all of the names found in all of the
 165 terminal database directories named in the \fI\%TERMINFO\fP and
 166 \fI\%TERMINFO_DIRS\fP environment variables.
 167 .RS 4
 168 .PP
 169 .\" toe -a | grep -E '^(xterm|vt)'
 170 .TS
 171 Lf(\*(CW)2 Lf(\*(CW).
 172 xterm\-color    generic color xterm
 173 xterm\-xfree86  xterm terminal emulator (XFree86)
 174 xterm\-vt220    xterm emulating vt220
 175 xterm\-256color xterm with 256 colors
 176 xterm\-r6       xterm X11R6 version
 177 xterm\-r5       xterm R5 version
 178 xterm\-mono     monochrome xterm
 179 xterm   T{
 180 .ad l
 181 xterm terminal emulator (X Window System)
 182 T}
 183 vt220   dec vt220
 184 vt102   dec vt102
 185 vt100   dec vt100 (w/advanced video)
 186 vt52    dec vt52
 187 .T&
 188 L.
 189 \&.\|.\|.
 190 .TE
 191 .RE
 192 .PP
 193 Use the \fB\-a\fP and \fB\-s\fP options together to show where each
 194 terminal description was found.
 195 .RS 4
 196 .PP
 197 .\" toe -as | grep -E '(^-+>|:.(xterm|vt))'
 198 .TS
 199 lf(\*(CW).
 200 \-\-> /etc/terminfo
 201 \-\-\-\-> /lib/terminfo
 202 \-\-\-\-\-\-> /usr/share/terminfo
 203 .TE
 204 .TS
 205 lf(\*(CW)1 lf(\*(CW)2 lf(\*(CW).
 206 \-\-*\-\-\-:    vt100   dec vt100 (w/advanced video)
 207 \-\-*\-\-\-:    vt102   dec vt102
 208 \-\-*\-\-\-:    vt220   dec vt220
 209 \-\-*\-\-\-:    vt52    dec vt52
 210 \-\-*\-\-\-:    xterm   T{
 211 .ad l
 212 xterm terminal emulator (X Window System)
 213 T}
 214 \-\-*\-\-\-:    xterm\-256color xterm with 256 colors
 215 \-\-*\-\-\-:    xterm\-color    generic color xterm
 216 \-\-*\-\-\-:    xterm\-mono     monochrome xterm
 217 \-\-*\-\-\-:    xterm\-r5       xterm R5 version
 218 \-\-*\-\-\-:    xterm\-r6       xterm X11R6 version
 219 \-\-*\-\-\-:    xterm\-vt220    xterm emulating vt220
 220 \-\-*\-\-\-:    xterm\-xfree86  T{
 221 .ad l
 222 xterm terminal emulator (XFree86)
 223 T}
 224 .T&
 225 l.
 226 \&.\|.\|.
 227 .TE
 228 .RE
 229 .SH SEE ALSO
 230 \fB\%@CAPTOINFO@\fP(1M),
 231 \fB\%@INFOCMP@\fP(1M),
 232 \fB\%@INFOTOCAP@\fP(1M),
 233 \fB\%@TIC@\fP(1M),
 234 \fB\%curses\fP(3X),
 235 \fB\%terminfo\fP(5)