3 ****************************************************************************
4 * Copyright 2019-2022,2023 Thomas E. Dickey *
5 * Copyright 1998-2015,2017 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: toe.1m,v 1.58 2023/12/02 20:49:04 tom Exp @
32 * toe -a | grep -E '^(xterm|vt)'
33 * The next row overruns the line length on DWB nroff (65n).
34 * toe -as | grep -E '(^-+>|:.(xterm|vt))'
35 * The next row overruns the line length on DWB nroff (65n).
36 * The next row overruns the line length on DWB nroff (65n).
38 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
41 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
42 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
43 <TITLE>toe 1m 2023-12-02 ncurses 6.4 User commands</TITLE>
44 <link rel="author" href="mailto:bug-ncurses@gnu.org">
48 <H1 class="no-header">toe 1m 2023-12-02 ncurses 6.4 User commands</H1>
50 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG> User commands <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
55 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
56 <STRONG>toe</STRONG> - list table of entries of <EM>terminfo</EM> terminal types
59 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
60 <STRONG>toe</STRONG> [<STRONG>-ahs</STRONG>] [<STRONG>-v</STRONG> [<EM>n</EM>]] [<EM>directory</EM> ...]
62 <STRONG>toe</STRONG> [<STRONG>-u</STRONG>|<STRONG>-U</STRONG>] <EM>file</EM>
64 <STRONG>toe</STRONG> <STRONG>-V</STRONG>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 <STRONG>toe</STRONG> reports to the standard output stream the (primary) names and
69 descriptions of the terminal types available to the <EM>terminfo</EM> library.
70 Each <EM>directory</EM> operand is scanned; if none are given, <STRONG>toe</STRONG> scans the the
71 default <EM>terminfo</EM> directory.
74 </PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
75 The <STRONG>-h</STRONG> option can be helpful to observe where <STRONG>toe</STRONG> is looking for
76 terminal descriptions. Other options support maintainers of <EM>terminfo</EM>
77 terminal descriptions.
79 <STRONG>-a</STRONG> lists entries from all terminal database directories that
80 <EM>terminfo</EM> would search, instead of only the first that it
83 If the <STRONG>-s</STRONG> option is also given, <STRONG>toe</STRONG> adds a column to the
84 report, showing (like <STRONG>conflict(1)</STRONG>) which entries belong to a
85 given terminal database. An "*" marks entries that differ,
86 and "+" marks equivalent entries.
88 Without the <STRONG>-s</STRONG> option, <STRONG>toe</STRONG> does not attempt to merge
89 duplicates in its report.
91 <STRONG>-h</STRONG> writes a heading naming each each directory as it is accessed.
93 <STRONG>-s</STRONG> sorts the output by the entry names.
95 <STRONG>-u</STRONG> <EM>file</EM> lists terminal type dependencies in <EM>file</EM>, a <EM>terminfo</EM> entry
96 source or <EM>termcap</EM> database file. The report summarizes the
97 "<STRONG>use</STRONG>" (<EM>terminfo</EM>) and <STRONG>tc</STRONG> (<EM>termcap</EM>) relations: each line
98 comprises the primary name of a terminal type employing <STRONG>use</STRONG>/<STRONG>tc</STRONG>
99 capabilities, a colon, a space- and tab-separated list of
100 primary names of terminal types thus named, and a newline.
102 <STRONG>-U</STRONG> <EM>file</EM> lists terminal type reverse dependencies in <EM>file</EM>, a <EM>terminfo</EM>
103 entry source or <EM>termcap</EM> database file. The report summarizes
104 the "<STRONG>use</STRONG>" (<EM>terminfo</EM>) and <STRONG>tc</STRONG> (<EM>termcap</EM>) reverse relations: each
105 line comprises the primary name of a terminal type occurring
106 in <STRONG>use</STRONG>/<STRONG>tc</STRONG> capabilities, a colon, a space- and tab-separated
107 list of primary names of terminal types naming them thus, and
110 <STRONG>-v</STRONG> [<EM>n</EM>] reports verbose status information to the standard error
111 stream, showing <STRONG>toe</STRONG>'s progress.
113 The optional parameter <EM>n</EM> is an integer between 1 and 10
114 inclusive, interpreted as for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>. If <EM>ncurses</EM> is built
115 without tracing support, <EM>n</EM> is ignored.
117 <STRONG>-V</STRONG> reports the version of <EM>ncurses</EM> associated with this program
118 and exits with a successful status.
121 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
122 <EM>/usr/share/terminfo</EM>
123 compiled terminal description database
126 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
127 <STRONG>toe</STRONG> is not provided by other implementations. There is no applicable
128 X/Open or POSIX standard for it.
130 It replaces a <STRONG>-T</STRONG> option that was briefly supported by the <EM>ncurses</EM>
131 <STRONG>infocmp</STRONG> utility in 1995.
133 The <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options were added in 2006 and 2011, respectively.
135 The program's name originates with a developer's pun:
137 <STRONG>o</STRONG> <STRONG>tic</STRONG>,
139 <STRONG>o</STRONG> <STRONG>tac</STRONG> (now <STRONG>tack</STRONG>),
141 <STRONG>o</STRONG> <STRONG>toe</STRONG>.
144 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
145 When not sorting with the <STRONG>-s</STRONG> option, the <STRONG>-a</STRONG> option reports all of the
146 names found in all of the terminal database directories named in the
147 <EM>TERMINFO</EM> and <EM>TERMINFO</EM><STRONG>_</STRONG><EM>DIRS</EM> environment variables.
149 xterm-color generic color xterm
150 xterm-xfree86 xterm terminal emulator (XFree86)
151 xterm-vt220 xterm emulating vt220
152 xterm-256color xterm with 256 colors
153 xterm-r6 xterm X11R6 version
154 xterm-r5 xterm R5 version
155 xterm-mono monochrome xterm
156 xterm xterm terminal emulator (X Window System)
159 vt100 dec vt100 (w/advanced video)
163 Use the <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options together to show where each terminal
164 description was found.
167 ----> /lib/terminfo
168 ------> /usr/share/terminfo
170 --*---: vt100 dec vt100 (w/advanced video)
171 --*---: vt102 dec vt102
172 --*---: vt220 dec vt220
173 --*---: vt52 dec vt52
174 --*---: xterm xterm terminal emulator (X Window System)
175 --*---: xterm-256color xterm with 256 colors
176 --*---: xterm-color generic color xterm
177 --*---: xterm-mono monochrome xterm
178 --*---: xterm-r5 xterm R5 version
179 --*---: xterm-r6 xterm X11R6 version
180 --*---: xterm-vt220 xterm emulating vt220
181 --*---: xterm-xfree86 xterm terminal emulator (XFree86)
185 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
186 <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>,
187 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
191 ncurses 6.4 2023-12-02 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
195 <li><a href="#h2-NAME">NAME</a></li>
196 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
197 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
198 <li><a href="#h2-OPTIONS">OPTIONS</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-EXAMPLES">EXAMPLES</a></li>
202 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>