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