xref: /freebsd/contrib/ncurses/man/toe.1m (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
t
***************************************************************************
Copyright 2019-2023,2024 Thomas E. Dickey *
Copyright 1998-2015,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: toe.1m,v 1.68 2024/04/20 18:59:26 tom Exp $
@TOE@ 1M 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"
.\} .\} .\} . ..
NAME
\%@TOE@ - list table of entries of terminfo terminal types
SYNOPSIS
@TOE@ [ -ahs ] [ -v \c [ n ]] [ directory .\|.\|.]

@TOE@ [ -u | -U ] file

"@TOE@ -V"

DESCRIPTION
\%@TOE@ reports to the standard output stream the (primary) names and descriptions of the terminal types available to the terminfo library. Each directory is scanned; if none are given, \%@TOE@ scans the default terminfo directory.
OPTIONS
The -h option can be helpful to observe where \%@TOE@ is looking for terminal descriptions. Other options support maintainers of terminfo terminal descriptions.

9 \" "-u file" + 2n -a lists entries from all terminal database directories that terminfo would search, instead of only the first that it finds.

If -s is also given, \%@TOE@ additionally reports, like \%conflict(1), which entries correspond to a given terminal database. An \*(``*\*('' marks entries that differ, and \*(``+\*('' marks equivalent entries.
Without the -s option, \%@TOE@ does not attempt to merge duplicates in its report.

-h writes a heading naming each each directory as it is accessed.

-s sorts the output by the entry names.

-u file lists terminal type dependencies in file, a terminfo entry source or termcap database file. The report summarizes the \*(``use\*('' (terminfo) and tc (termcap) relations: each line comprises the primary name of a terminal type employing use/tc capabilities, a colon, a space- and tab-separated list of primary names of terminal types thus named, and a newline.

-U file lists terminal type reverse dependencies in file, a terminfo entry source or termcap database file. The report summarizes the \*(``use\*('' (terminfo) and tc (termcap) reverse relations: each line comprises the primary name of a terminal type occurring in use/tc capabilities, a colon, a space- and tab-separated list of primary names of terminal types naming them thus, and a newline.

-v [\c n ] reports verbose status information to the standard error stream, showing \%@TOE@'s progress.

The optional parameter n is an integer between 1 and 10 inclusive, interpreted as for \%@TIC@(1M). If \%ncurses is built without tracing support, n is ignored.

-V reports the version of \%ncurses associated with this program and exits with a successful status.

FILES

\*d compiled terminal description database

PORTABILITY
\%@TOE@ is not provided by other implementations. There is no applicable X/Open or POSIX standard for it.
HISTORY
\%@TOE@ replaces a -T option that was briefly supported by the \%ncurses \%infocmp utility in 1995.

The -a and -s options were added in 2006 and 2011, respectively.

The program's name originates with a developer's pun: .bP tic, .bP tac (now tack), .bP toe.

EXAMPLES
When not sorting with the -s option, the -a option reports all of the names found in all of the terminal database directories named in the \%TERMINFO and \%TERMINFO_DIRS environment variables.

toe -a | grep -E '^(xterm|vt)'

xterm-color generic color xterm
xterm-xfree86 xterm terminal emulator (XFree86)
xterm-vt220 xterm emulating vt220
xterm-256color xterm with 256 colors
xterm-r6 xterm X11R6 version
xterm-r5 xterm R5 version
xterm-mono monochrome xterm
xterm
xterm terminal emulator (X Window System)
vt220 dec vt220
vt102 dec vt102
vt100 dec vt100 (w/advanced video)
vt52 dec vt52
.T&
L.
.\|.\|.

Use the -a and -s options together to show where each terminal description was found.

toe -as | grep -E '(^-+>|:.(xterm|vt))'

--> /etc/terminfo
----> /lib/terminfo
------> /usr/share/terminfo
--*---: vt100 dec vt100 (w/advanced video)
--*---: vt102 dec vt102
--*---: vt220 dec vt220
--*---: vt52 dec vt52
--*---: xterm
xterm terminal emulator (X Window System)
--*---: xterm-256color xterm with 256 colors
--*---: xterm-color generic color xterm
--*---: xterm-mono monochrome xterm
--*---: xterm-r5 xterm R5 version
--*---: xterm-r6 xterm X11R6 version
--*---: xterm-vt220 xterm emulating vt220
--*---: xterm-xfree86
xterm terminal emulator (XFree86)
.T&
L.
.\|.\|.
SEE ALSO
\%@CAPTOINFO@(1M), \%@INFOCMP@(1M), \%@INFOTOCAP@(1M), \%@TIC@(1M), \%curses(3X), \%terminfo(5)