man/toe.1m

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2019-2022,2023 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.54 2023/10/21 15:30:27 tom Exp $
  32 .TH @TOE@ 1M 2023-10-21 "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 n 5
  54 .ds d @TERMINFO@
  55 .SH NAME
  56 \fB\%@TOE@\fP \-
  57 list table of entries of \fIterminfo\fR terminal types
  58 .SH SYNOPSIS
  59 .B @TOE@
  60 .RB [ \-ahs ]
  61 .RB [ \-v\ \c
  62 .RI [ n ]]
  63 .RI [ directory
  64 \&.\|.\|.]
  65 .PP
  66 .B @TOE@
  67 .RB [ \-u | \-U ]
  68 .I file
  69 .PP
  70 .B "@TOE@ \-V"
  71 .SH DESCRIPTION
  72 \fB\%@TOE@\fP reports to the standard output stream the (primary) names
  73 and descriptions of the terminal types available to the \fIterminfo\fP
  74 library.
  75 Each \fIdirectory\fP operand is scanned;
  76 if none are given,
  77 \fB\%@TOE@\fP scans the the default \fIterminfo\fP directory.
  78 .SH OPTIONS
  79 The \fB\-h\fP option can be helpful to observe where \fB\%@TOE@\fP is
  80 looking for terminal descriptions.
  81 Other options support maintainers of \fIterminfo\fP terminal
  82 descriptions.
  83 .TP 9 \" "-u file" + 2n
  84 .B \-a
  85 lists entries from all terminal database directories that \fIterminfo\fP
  86 would search,
  87 instead of only the first that it finds.
  88 .IP
  89 If the \fB\-s\fP option is also given,
  90 \fB\%@TOE@\fP adds a column to the report,
  91 showing (like \fB\%conflict\fP(1)) which entries belong to a given
  92 terminal database.
  93 An \*(``*\*('' marks entries that differ,
  94 and \*(``+\*('' marks equivalent entries.
  95 .IP
  96 Without the \fB\-s\fP option,
  97 \fB\%@TOE@\fP does not attempt to merge duplicates in its report.
  98 .TP
  99 .B \-h
 100 writes a heading naming each each directory as it is accessed.
 101 .TP
 102 .B \-s
 103 sorts the output by the entry names.
 104 .TP
 105 .BI \-u\  file
 106 lists terminal type dependencies in \fIfile\fP,
 107 a \fIterminfo\fP entry source or \fItermcap\fP database file.
 108 The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and
 109 \fBtc\fP (\fItermcap\fP) relations:
 110 each line comprises the primary name of a terminal type employing
 111 \fBuse\fP/\fBtc\fP capabilities,
 112 a colon,
 113 a space- and tab-separated list of primary names of terminal types thus
 114 named,
 115 and a newline.
 116 .TP
 117 .BI \-U\  file
 118 lists terminal type reverse dependencies in \fIfile\fP,
 119 a \fIterminfo\fP entry source or \fItermcap\fP database file.
 120 The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and
 121 \fBtc\fP (\fItermcap\fP) reverse relations:
 122 each line comprises the primary name of a terminal type occurring in
 123 \fBuse\fP/\fBtc\fP capabilities,
 124 a colon,
 125 a space- and tab-separated list of primary names of terminal types
 126 naming them thus,
 127 and a newline.
 128 .TP
 129 .BR \-v\  [\c
 130 .IR n ]
 131 reports verbose status information to the standard error stream,
 132 showing \fB\%@TOE@\fP's progress.
 133 .IP
 134 The optional parameter \fIn\fP is an integer between 1 and 10 inclusive,
 135 interpreted as for \fB\%@TIC@\fP(1M).
 136 If \fIncurses\fP is built without tracing support,
 137 \fIn\fP is ignored.
 138 .TP
 139 \fB\-V\fP
 140 reports the version of \fIncurses\fP associated
 141 with this program and exits with a successful status.
 142 .SH EXAMPLES
 143 When not sorting with the \fB\-s\fP option,
 144 the \fB\-a\fP option reports all of the names found in all of the
 145 terminal database directories named in the \fB\%TERMINFO\fP and
 146 \fB\%TERMINFO_DIRS\fP environment variables.
 147 .RS 4
 148 .PP
 149 .\" toe -a | grep -E '^(xterm|vt)'
 150 .TS
 151 Lf(\*(CW)2 Lf(\*(CW).
 152 xterm\-color    generic color xterm
 153 xterm\-xfree86  xterm terminal emulator (XFree86)
 154 xterm\-vt220    xterm emulating vt220
 155 xterm\-256color xterm with 256 colors
 156 xterm\-r6       xterm X11R6 version
 157 xterm\-r5       xterm R5 version
 158 xterm\-mono     monochrome xterm
 159 .\" The next row overruns the line length on DWB nroff (65n).
 160 xterm   xterm terminal emulator (X Window System)
 161 vt220   dec vt220
 162 vt102   dec vt102
 163 vt100   dec vt100 (w/advanced video)
 164 vt52    dec vt52
 165 .T&
 166 L.
 167 \&.\|.\|.
 168 .TE
 169 .RE
 170 .PP
 171 Use the \fB\-a\fP and \fB\-s\fP options together to show where each
 172 terminal description was found.
 173 .RS 4
 174 .PP
 175 .\" toe -as | grep -E '(^-+>|:.(xterm|vt))'
 176 .TS
 177 lf(\*(CW).
 178 \-\-> /etc/terminfo
 179 \-\-\-\-> /lib/terminfo
 180 \-\-\-\-\-\-> /usr/share/terminfo
 181 .TE
 182 .TS
 183 lf(\*(CW)1 lf(\*(CW)2 lf(\*(CW).
 184 \-\-*\-\-\-:    vt100   dec vt100 (w/advanced video)
 185 \-\-*\-\-\-:    vt102   dec vt102
 186 \-\-*\-\-\-:    vt220   dec vt220
 187 \-\-*\-\-\-:    vt52    dec vt52
 188 .\" The next row overruns the line length on DWB nroff (65n).
 189 \-\-*\-\-\-:    xterm   xterm terminal emulator (X Window System)
 190 \-\-*\-\-\-:    xterm\-256color xterm with 256 colors
 191 \-\-*\-\-\-:    xterm\-color    generic color xterm
 192 \-\-*\-\-\-:    xterm\-mono     monochrome xterm
 193 \-\-*\-\-\-:    xterm\-r5       xterm R5 version
 194 \-\-*\-\-\-:    xterm\-r6       xterm X11R6 version
 195 \-\-*\-\-\-:    xterm\-vt220    xterm emulating vt220
 196 .\" The next row overruns the line length on DWB nroff (65n).
 197 \-\-*\-\-\-:    xterm\-xfree86  xterm terminal emulator (XFree86)
 198 .T&
 199 l.
 200 \&.\|.\|.
 201 .TE
 202 .RE
 203 .SH FILES
 204 .TP
 205 .I \*d
 206 compiled terminal description database
 207 .SH HISTORY
 208 \fB\%@TOE@\fP is not provided by other implementations.
 209 There is no applicable X/Open or POSIX standard for it.
 210 .PP
 211 It replaces a \fB\-T\fP option that was briefly supported by
 212 the \fIncurses\fP \fB\%infocmp\fP utility in 1995.
 213 .PP
 214 The \fB\-a\fP and \fB\-s\fP options were added in 2006 and 2011,
 215 respectively.
 216 .PP
 217 The program's name originates with a developer's pun:
 218 .bP
 219 \fBtic\fP,
 220 .bP
 221 \fBtac\fP (now \fBtack\fP),
 222 .bP
 223 \fBtoe\fP.
 224 .SH SEE ALSO
 225 \fB\%@CAPTOINFO@\fP(1M),
 226 \fB\%@INFOCMP@\fP(1M),
 227 \fB\%@INFOTOCAP@\fP(1M),
 228 \fB\%@TIC@\fP(1M),
 229 \fB\%curses\fP(3X),
 230 \fB\%terminfo\fP(\*n)