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