2 ****************************************************************************
3 * Copyright 2019-2022,2023 Thomas E. Dickey *
4 * Copyright 1998-2015,2017 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: toe.1m,v 1.51 2023/10/01 09:45:05 tom Exp @
31 * toe -a | grep -E '^(xterm|vt)'
32 * The next row overruns the line length on DWB nroff (65n).
33 * toe -as | grep -E '(^-+>|:.(xterm|vt))'
34 * The next row overruns the line length on DWB nroff (65n).
35 * The next row overruns the line length on DWB nroff (65n).
37 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
40 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
41 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
42 <TITLE>toe 1m 2023-10-01 ncurses 6.4 User commands</TITLE>
43 <link rel="author" href="mailto:bug-ncurses@gnu.org">
47 <H1 class="no-header">toe 1m 2023-10-01 ncurses 6.4 User commands</H1>
49 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> User commands <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
54 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
55 <STRONG>toe</STRONG> - list table of entries of <EM>terminfo</EM> terminal types
58 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
59 <STRONG>toe</STRONG> [<STRONG>-ahs</STRONG>] [<STRONG>-v</STRONG> [<EM>n</EM>]] [<EM>directory</EM> ...]
61 <STRONG>toe</STRONG> [<STRONG>-u</STRONG>|<STRONG>-U</STRONG>] <EM>file</EM>
63 <STRONG>toe</STRONG> <STRONG>-V</STRONG>
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67 <STRONG>toe</STRONG> reports to the standard output stream the (primary) names and
68 descriptions of the terminal types available to the <EM>terminfo</EM> library.
69 Each <EM>directory</EM> operand is scanned; if none are given, <STRONG>toe</STRONG> scans the the
70 default <EM>terminfo</EM> directory.
73 </PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
74 The <STRONG>-h</STRONG> option can be helpful to observe where <STRONG>toe</STRONG> is looking for
75 terminal descriptions. Other options support maintainers of <EM>terminfo</EM>
76 terminal descriptions.
78 <STRONG>-a</STRONG> lists entries from all terminal database directories that
79 <EM>terminfo</EM> would search, instead of only the first that it
82 If the <STRONG>-s</STRONG> option is also given, <STRONG>toe</STRONG> adds a column to the
83 report, showing (like <STRONG>conflict(1)</STRONG>) which entries belong to a
84 given terminal database. An "*" marks entries that differ,
85 and "+" marks equivalent entries.
87 Without the <STRONG>-s</STRONG> option, <STRONG>toe</STRONG> does not attempt to merge
88 duplicates in its report.
90 <STRONG>-h</STRONG> writes a heading naming each each directory as it is accessed.
92 <STRONG>-s</STRONG> sorts the output by the entry names.
94 <STRONG>-u</STRONG> <EM>file</EM> lists terminal type dependencies in <EM>file</EM>, a <EM>terminfo</EM> entry
95 source or <EM>termcap</EM> database file. The report summarizes the
96 "<STRONG>use</STRONG>" (<EM>terminfo</EM>) and "<STRONG>tc</STRONG>" (<EM>termcap</EM>) relations: each line
97 comprises the primary name of a terminal type employing <STRONG>use</STRONG>/<STRONG>tc</STRONG>
98 capabilities, a colon, a space- and tab-separated list of
99 primary names of terminal types thus named, and a newline.
101 <STRONG>-U</STRONG> <EM>file</EM> lists terminal type reverse dependencies in <EM>file</EM>, a <EM>terminfo</EM>
102 entry source or <EM>termcap</EM> database file. The report summarizes
103 the "<STRONG>use</STRONG>" (<EM>terminfo</EM>) and "<STRONG>tc</STRONG>" (<EM>termcap</EM>) reverse relations:
104 each line comprises the primary name of a terminal type
105 occurring in <STRONG>use</STRONG>/<STRONG>tc</STRONG> capabilities, a colon, a space- and tab-
106 separated list of primary names of terminal types naming them
109 <STRONG>-v</STRONG> [<EM>n</EM>] reports verbose status information to the standard error
110 stream, showing <STRONG>toe</STRONG>'s progress.
112 The optional parameter <EM>n</EM> is an integer between 1 and 10
113 inclusive, interpreted as for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>. If <EM>ncurses</EM> is built
114 without tracing support, <EM>n</EM> is ignored.
116 <STRONG>-V</STRONG> reports the version of <EM>ncurses</EM> associated with this program
117 and exits with a successful status.
120 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
121 When not sorting with the <STRONG>-s</STRONG> option, the <STRONG>-a</STRONG> option reports all of the
122 names found in all of the terminal database directories named in the
123 <STRONG>TERMINFO</STRONG> and <STRONG>TERMINFO_DIRS</STRONG> environment variables.
125 xterm-color generic color xterm
126 xterm-xfree86 xterm terminal emulator (XFree86)
127 xterm-vt220 xterm emulating vt220
128 xterm-256color xterm with 256 colors
129 xterm-r6 xterm X11R6 version
130 xterm-r5 xterm R5 version
131 xterm-mono monochrome xterm
132 xterm xterm terminal emulator (X Window System)
135 vt100 dec vt100 (w/advanced video)
139 Use the <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options together to show where each terminal
140 description was found.
143 ----> /lib/terminfo
144 ------> /usr/share/terminfo
146 --*---: vt100 dec vt100 (w/advanced video)
147 --*---: vt102 dec vt102
148 --*---: vt220 dec vt220
149 --*---: vt52 dec vt52
150 --*---: xterm xterm terminal emulator (X Window System)
151 --*---: xterm-256color xterm with 256 colors
152 --*---: xterm-color generic color xterm
153 --*---: xterm-mono monochrome xterm
154 --*---: xterm-r5 xterm R5 version
155 --*---: xterm-r6 xterm X11R6 version
156 --*---: xterm-vt220 xterm emulating vt220
157 --*---: xterm-xfree86 xterm terminal emulator (XFree86)
161 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
162 <EM>/usr/share/terminfo</EM>
163 compiled terminal description database
166 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
167 <STRONG>toe</STRONG> is not provided by other implementations. There is no applicable
168 X/Open or POSIX standard for it.
170 It replaces a <STRONG>-T</STRONG> option that was briefly supported by the <EM>ncurses</EM>
171 <STRONG>infocmp</STRONG> utility in 1995.
173 The <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options were added in 2006 and 2011, respectively.
175 The program's name originates with a developer's pun:
177 <STRONG>o</STRONG> <STRONG>tic</STRONG>,
179 <STRONG>o</STRONG> <STRONG>tac</STRONG> (now <STRONG>tack</STRONG>),
181 <STRONG>o</STRONG> <STRONG>toe</STRONG>.
184 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
185 <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>, <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
186 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
190 ncurses 6.4 2023-10-01 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
194 <li><a href="#h2-NAME">NAME</a></li>
195 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
196 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
197 <li><a href="#h2-OPTIONS">OPTIONS</a></li>
198 <li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
199 <li><a href="#h2-FILES">FILES</a></li>
200 <li><a href="#h2-HISTORY">HISTORY</a></li>
201 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>