ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / toe.1m.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2019,2020 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   * @Id: toe.1m,v 1.32 2020/02/02 23:34:34 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>toe 1m</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">toe 1m</H1>
43 <PRE>
44 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>                                                                <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>toe</STRONG> - table of (terminfo) entries
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>toe</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahsuUV</STRONG>] <EM>file...</EM>
55
56
57 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
58        With no options, <STRONG>toe</STRONG> lists all available terminal types by primary name
59        with descriptions.   File  arguments  specify  the  directories  to  be
60        scanned;  if  no such arguments are given, your default terminfo direc-
61        tory is scanned.  If you also specify the <STRONG>-h</STRONG> option, a directory header
62        will be issued as each directory is entered.
63
64        There are other options intended for use by terminfo file maintainers:
65
66        <STRONG>-a</STRONG>     report  on  all  of  the  terminal databases which ncurses would
67               search, rather than only the first one that it finds.
68
69               If the <STRONG>-s</STRONG> is also given, <STRONG>toe</STRONG> adds a column to the report,  show-
70               ing  (like  <STRONG>conflict(1)</STRONG>)  which  entries which belong to a given
71               terminal database.  An "*" marks entries which differ,  and  "+"
72               marks equivalent entries.
73
74               Without  the <STRONG>-s</STRONG> option, <STRONG>toe</STRONG> does not attempt to merge duplicates
75               in its report
76
77        <STRONG>-s</STRONG>     sort the output by the entry names.
78
79        <STRONG>-u</STRONG> <EM>file</EM>
80               says to write a report to the standard output, listing dependen-
81               cies in the given terminfo/termcap source file.  The report con-
82               denses the "use" relation: each line  consists  of  the  primary
83               name  of  a  terminal  that  has use capabilities, followed by a
84               colon, followed by the whitespace-separated primary names of all
85               terminals  which  occur in those use capabilities, followed by a
86               newline
87
88        <STRONG>-U</STRONG> <EM>file</EM>
89               says to write a report to the standard output,  listing  reverse
90               dependencies  in  the  given  terminfo/termcap source file.  The
91               report reverses the "use" relation: each line  consists  of  the
92               primary name of a terminal that occurs in use capabilities, fol-
93               lowed by a colon, followed by the  whitespace-separated  primary
94               names  of  all  terminals which depend on it, followed by a new-
95               line.
96
97        <STRONG>-v</STRONG><EM>n</EM>    specifies that (verbose) output be written  to  standard  error,
98               showing <STRONG>toe</STRONG>'s progress.
99
100               The  optional  parameter <EM>n</EM> is a number from 1 to 10, interpreted
101               as for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>.  If ncurses is built  without  tracing  support,
102               the optional parameter is ignored.
103
104        <STRONG>-V</STRONG>     reports  the  version of ncurses which was used in this program,
105               and exits.
106
107
108 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
109        Without sorting, the <STRONG>-a</STRONG> option reports all of the names found in all of
110        the terminal databases found by the <STRONG>TERMINFO</STRONG> and <STRONG>TERMINFO_DIRS</STRONG> environ-
111        ment variables:
112
113            MtxOrb162      16x2 Matrix Orbital LCD display
114            MtxOrb204      20x4 Matrix Orbital LCD display
115            MtxOrb         Generic Matrix Orbital LCD display
116            qvt101+        qume qvt 101 PLUS product
117            qvt119+-25     QVT 119 PLUS with 25 data lines
118            qansi-g        QNX ANSI
119            qvt103         qume qvt 103
120            qnxw           QNX4 windows
121            qansi-w        QNX ansi for windows
122            qnxm           QNX4 with mouse events
123            qvt203-25-w    QVT 203 PLUS with 25 by 132 columns
124            qansi-t        QNX ansi without console writes
125            . . .
126
127        Use the <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options together to show where each terminal descrip-
128        tion was found:
129
130            --&gt; /usr/local/ncurses/share/terminfo
131            ----&gt; /usr/share/terminfo
132            *-+-:     9term          Plan9 terminal emulator for X
133            *---:     Eterm          Eterm with xterm-style color support (X Window System)
134            *-*-:     Eterm-256color Eterm with xterm 256-colors
135            *-*-:     Eterm-88color  Eterm with 88 colors
136            *-+-:     MtxOrb         Generic Matrix Orbital LCD display
137            *-+-:     MtxOrb162      16x2 Matrix Orbital LCD display
138            *-+-:     MtxOrb204      20x4 Matrix Orbital LCD display
139            *-*-:     NCR260VT300WPP NCR 2900_260 vt300 wide mode pc+  kybd
140            *-+-:     aaa            ann arbor ambassador/30 lines
141            *-+-:     aaa+dec        ann arbor ambassador in dec vt100 mode
142            *-+-:     aaa+rv         ann arbor ambassador in reverse video
143            . . .
144
145
146 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
147        <STRONG>/usr/share/terminfo/?/*</STRONG>
148             Compiled terminal description database.
149
150
151 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
152        This  utility  is  not  provided by other implementations.  There is no
153        relevant X/Open or POSIX standard for <STRONG>toe</STRONG>.
154
155        The program name refers to a developer's pun:
156
157        <STRONG>o</STRONG>   <STRONG>tic</STRONG>,
158
159        <STRONG>o</STRONG>   <STRONG>tac</STRONG> (now <STRONG>tack</STRONG>),
160
161        <STRONG>o</STRONG>   <STRONG>toe</STRONG>.
162
163        It replaced a <STRONG>-T</STRONG> option which was  briefly  supported  by  the  ncurses
164        <STRONG>infocmp</STRONG> utility in 1995.
165
166        The  <STRONG>-a</STRONG>  and <STRONG>-s</STRONG> options were added to <STRONG>toe</STRONG> several years later (2006 and
167        2011, respectively).
168
169
170 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
171        <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>,  <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>,  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  <STRONG>ter-</STRONG>
172        <STRONG><A HREF="terminfo.5.html">minfo(5)</A></STRONG>.
173
174        This describes <STRONG>ncurses</STRONG> version 6.2 (patch 20200425).
175
176
177
178                                                                        <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
179 </PRE>
180 <div class="nav">
181 <ul>
182 <li><a href="#h2-NAME">NAME</a></li>
183 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
184 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
185 <li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
186 <li><a href="#h2-FILES">FILES</a></li>
187 <li><a href="#h2-HISTORY">HISTORY</a></li>
188 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
189 </ul>
190 </div>
191 </BODY>
192 </HTML>