ncurses 6.1 - patch 20200118
[ncurses.git] / doc / html / man / toe.1m.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2017,2019 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: toe.1m,v 1.31 2019/07/20 19:06:44 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>toe 1m</TITLE>
37 <link rel="author" href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">toe 1m</H1>
42 <PRE>
43 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>                                                                <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>toe</STRONG> - table of (terminfo) entries
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>toe</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahsuUV</STRONG>] <EM>file...</EM>
54
55
56 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
57        With no options, <STRONG>toe</STRONG> lists all available terminal types by primary name
58        with descriptions.   File  arguments  specify  the  directories  to  be
59        scanned;  if  no such arguments are given, your default terminfo direc-
60        tory is scanned.  If you also specify the <STRONG>-h</STRONG> option, a directory header
61        will be issued as each directory is entered.
62
63        There are other options intended for use by terminfo file maintainers:
64
65        <STRONG>-a</STRONG>     report  on  all  of  the  terminal databases which ncurses would
66               search, rather than only the first one that it finds.
67
68               If the <STRONG>-s</STRONG> is also given, <STRONG>toe</STRONG> adds a column to the report,  show-
69               ing  (like  <STRONG>conflict(1)</STRONG>)  which  entries which belong to a given
70               terminal database.  An "*" marks entries which differ,  and  "+"
71               marks equivalent entries.
72
73               Without  the <STRONG>-s</STRONG> option, <STRONG>toe</STRONG> does not attempt to merge duplicates
74               in its report
75
76        <STRONG>-s</STRONG>     sort the output by the entry names.
77
78        <STRONG>-u</STRONG> <EM>file</EM>
79               says to write a report to the standard output, listing dependen-
80               cies in the given terminfo/termcap source file.  The report con-
81               denses the "use" relation: each line  consists  of  the  primary
82               name  of  a  terminal  that  has use capabilities, followed by a
83               colon, followed by the whitespace-separated primary names of all
84               terminals  which  occur in those use capabilities, followed by a
85               newline
86
87        <STRONG>-U</STRONG> <EM>file</EM>
88               says to write a report to the standard output,  listing  reverse
89               dependencies  in  the  given  terminfo/termcap source file.  The
90               report reverses the "use" relation: each line  consists  of  the
91               primary name of a terminal that occurs in use capabilities, fol-
92               lowed by a colon, followed by the  whitespace-separated  primary
93               names  of  all  terminals which depend on it, followed by a new-
94               line.
95
96        <STRONG>-v</STRONG><EM>n</EM>    specifies that (verbose) output be written  to  standard  error,
97               showing <STRONG>toe</STRONG>'s progress.
98
99               The  optional  parameter <EM>n</EM> is a number from 1 to 10, interpreted
100               as for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>.  If ncurses is built  without  tracing  support,
101               the optional parameter is ignored.
102
103        <STRONG>-V</STRONG>     reports  the  version of ncurses which was used in this program,
104               and exits.
105
106
107 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
108        Without sorting, the <STRONG>-a</STRONG> option reports all of the names found in all of
109        the terminal databases found by the <STRONG>TERMINFO</STRONG> and <STRONG>TERMINFO_DIRS</STRONG> environ-
110        ment variables:
111
112            MtxOrb162      16x2 Matrix Orbital LCD display
113            MtxOrb204      20x4 Matrix Orbital LCD display
114            MtxOrb         Generic Matrix Orbital LCD display
115            qvt101+        qume qvt 101 PLUS product
116            qvt119+-25     QVT 119 PLUS with 25 data lines
117            qansi-g        QNX ANSI
118            qvt103         qume qvt 103
119            qnxw           QNX4 windows
120            qansi-w        QNX ansi for windows
121            qnxm           QNX4 with mouse events
122            qvt203-25-w    QVT 203 PLUS with 25 by 132 columns
123            qansi-t        QNX ansi without console writes
124            . . .
125
126        Use the <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options together to show where each terminal descrip-
127        tion was found:
128
129            --&gt; /usr/local/ncurses/share/terminfo
130            ----&gt; /usr/share/terminfo
131            *-+-:     9term          Plan9 terminal emulator for X
132            *---:     Eterm          Eterm with xterm-style color support (X Window System)
133            *-*-:     Eterm-256color Eterm with xterm 256-colors
134            *-*-:     Eterm-88color  Eterm with 88 colors
135            *-+-:     MtxOrb         Generic Matrix Orbital LCD display
136            *-+-:     MtxOrb162      16x2 Matrix Orbital LCD display
137            *-+-:     MtxOrb204      20x4 Matrix Orbital LCD display
138            *-*-:     NCR260VT300WPP NCR 2900_260 vt300 wide mode pc+  kybd
139            *-+-:     aaa            ann arbor ambassador/30 lines
140            *-+-:     aaa+dec        ann arbor ambassador in dec vt100 mode
141            *-+-:     aaa+rv         ann arbor ambassador in reverse video
142            . . .
143
144
145 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
146        <STRONG>/usr/share/terminfo/?/*</STRONG>
147             Compiled terminal description database.
148
149
150 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
151        This  utility  is  not  provided by other implementations.  There is no
152        relevant X/Open or POSIX standard for <STRONG>toe</STRONG>.
153
154        The program name refers to a developer's pun:
155
156        <STRONG>o</STRONG>   <STRONG>tic</STRONG>,
157
158        <STRONG>o</STRONG>   <STRONG>tac</STRONG> (now <STRONG>tack</STRONG>),
159
160        <STRONG>o</STRONG>   <STRONG>toe</STRONG>.
161
162        It replaced a <STRONG>-T</STRONG> option which was  briefly  supported  by  the  ncurses
163        <STRONG>infocmp</STRONG> utility in 1995.
164
165        The  <STRONG>-a</STRONG>  and <STRONG>-s</STRONG> options were added to <STRONG>toe</STRONG> several years later (2006 and
166        2011, respectively).
167
168
169 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
170        <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>
171        <STRONG><A HREF="terminfo.5.html">minfo(5)</A></STRONG>.
172
173        This describes <STRONG>ncurses</STRONG> version 6.1 (patch 20200118).
174
175
176
177                                                                        <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
178 </PRE>
179 <div class="nav">
180 <ul>
181 <li><a href="#h2-NAME">NAME</a></li>
182 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
183 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
184 <li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
185 <li><a href="#h2-FILES">FILES</a></li>
186 <li><a href="#h2-HISTORY">HISTORY</a></li>
187 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
188 </ul>
189 </div>
190 </BODY>
191 </HTML>