ncurses 6.2 - patch 20201003
[ncurses.git] / man / toe.1m
1 .\"***************************************************************************
2 .\" Copyright 2019,2020 Thomas E. Dickey                                     *
3 .\" Copyright 1998-2015,2017 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 .\"
30 .\" $Id: toe.1m,v 1.32 2020/02/02 23:34:34 tom Exp $
31 .TH @TOE@ 1M ""
32 .de bP
33 .ie n  .IP \(bu 4
34 .el    .IP \(bu 2
35 ..
36 .ie \n(.g .ds `` \(lq
37 .el       .ds `` ``
38 .ie \n(.g .ds '' \(rq
39 .el       .ds '' ''
40 .de NS
41 .ie n  .sp
42 .el    .sp .5
43 .ie n  .in +4
44 .el    .in +2
45 .nf
46 .ft C                   \" Courier
47 ..
48 .de NE
49 .fi
50 .ft R
51 .ie n  .in -4
52 .el    .in -2
53 ..
54 .ds n 5
55 .ds d @TERMINFO@
56 .SH NAME
57 \fB@TOE@\fR \- table of (terminfo) entries
58 .SH SYNOPSIS
59 \fB@TOE@\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahsuUV\fR] \fIfile...\fR
60 .br
61 .SH DESCRIPTION
62 .PP
63 With no options,
64 \fB@TOE@\fR lists all available terminal types by primary name
65 with descriptions.
66 File arguments specify the directories to be scanned; if no
67 such arguments are given,
68 your default terminfo directory is scanned.
69 If you also specify the \fB\-h\fR option,
70 a directory header will be issued as each
71 directory is entered.
72 .PP
73 There are other options intended for use by terminfo file maintainers:
74 .TP
75 \fB\-a\fR
76 report on all of the terminal databases which ncurses would search,
77 rather than only the first one that it finds.
78 .IP
79 If the \fB\-s\fR is also given, \fB@TOE@\fR
80 adds a column to the report,
81 showing (like \fBconflict\fP(1)) which entries which 
82 belong to a given terminal database.
83 An "*" marks entries which differ, and "+" marks equivalent entries.
84 .IP
85 Without the \fB\-s\fP option, \fB@TOE@\fR does not attempt to merge
86 duplicates in its report
87 .TP
88 \fB\-s\fR
89 sort the output by the entry names.
90 .TP
91 \fB\-u\fR \fIfile\fR
92 says to write a report to the standard output,
93 listing dependencies in the given terminfo/termcap source file.
94 The report condenses the \*(``use\*('' relation:
95 each line consists of the primary name of a terminal that
96 has use capabilities,
97 followed by a colon,
98 followed by the
99 whitespace-separated primary names of all terminals which occur in those use
100 capabilities,
101 followed by a newline
102 .TP
103 \fB\-U\fR \fIfile\fR
104 says to write a report to the standard output,
105 listing reverse dependencies in the given terminfo/termcap source file.
106 The report reverses the \*(``use\*('' relation:
107 each line consists of the primary name of a
108 terminal that occurs in use capabilities,
109 followed by a colon,
110 followed by the
111 whitespace-separated primary names of all terminals which depend on it,
112 followed by a newline.
113 .TP
114 \fB\-v\fR\fIn\fR
115 specifies that (verbose) output be written to standard error,
116 showing \fB@TOE@\fR's progress.
117 .IP
118 The optional parameter \fIn\fR is a number from 1 to 10,
119 interpreted as for \fB@TIC@\fR(1M).
120 If ncurses is built without tracing support, the optional parameter is ignored.
121 .TP
122 \fB\-V\fR
123 reports the version of ncurses which was used in this program,
124 and exits.
125 .SH EXAMPLES
126 .PP
127 Without sorting, the \fB\-a\fP option reports all of the names found
128 in all of the terminal databases found by the \fBTERMINFO\fP and
129 \fBTERMINFO_DIRS\fP environment variables:
130 .NS
131 MtxOrb162       16x2 Matrix Orbital LCD display
132 MtxOrb204       20x4 Matrix Orbital LCD display
133 MtxOrb          Generic Matrix Orbital LCD display
134 qvt101+         qume qvt 101 PLUS product
135 qvt119+-25      QVT 119 PLUS with 25 data lines
136 qansi-g         QNX ANSI
137 qvt103          qume qvt 103
138 qnxw            QNX4 windows
139 qansi-w         QNX ansi for windows
140 qnxm            QNX4 with mouse events
141 qvt203-25-w     QVT 203 PLUS with 25 by 132 columns
142 qansi-t         QNX ansi without console writes
143 \&.\ .\ .
144 .NE
145 .PP
146 Use the \fB\-a\fP and \fB\-s\fP options together to show where each terminal
147 description was found:
148 .NS
149 --> /usr/local/ncurses/share/terminfo
150 ----> /usr/share/terminfo
151 *-+-:   9term           Plan9 terminal emulator for X
152 *---:   Eterm           Eterm with xterm-style color support (X Window System)
153 *-*-:   Eterm-256color  Eterm with xterm 256-colors
154 *-*-:   Eterm-88color   Eterm with 88 colors
155 *-+-:   MtxOrb          Generic Matrix Orbital LCD display
156 *-+-:   MtxOrb162       16x2 Matrix Orbital LCD display
157 *-+-:   MtxOrb204       20x4 Matrix Orbital LCD display
158 *-*-:   NCR260VT300WPP  NCR 2900_260 vt300 wide mode pc+  kybd
159 *-+-:   aaa             ann arbor ambassador/30 lines
160 *-+-:   aaa+dec         ann arbor ambassador in dec vt100 mode
161 *-+-:   aaa+rv          ann arbor ambassador in reverse video
162 \&.\ .\ .
163 .NE
164 .SH FILES
165 .TP 5
166 \fB\*d/?/*\fR
167 Compiled terminal description database.
168 .SH HISTORY
169 This utility is not provided by other implementations.
170 There is no relevant X/Open or POSIX standard for \fB@TOE@\fP.
171 .PP 
172 The program name refers to a developer's pun:
173 .bP
174 \fBtic\fP,
175 .bP
176 \fBtac\fP (now \fBtack\fP),
177 .bP
178 \fBtoe\fP.
179 .PP
180 It replaced a \fB\-T\fP option which was briefly supported by
181 the ncurses \fBinfocmp\fP utility in 1995.
182 .PP
183 The \fB\-a\fP and \fB\-s\fP options were added to 
184 \fB@TOE@\fR several years later (2006 and 2011, respectively).
185 .SH SEE ALSO
186 \fB@TIC@\fR(1M),
187 \fB@INFOCMP@\fR(1M),
188 \fB@CAPTOINFO@\fR(1M),
189 \fB@INFOTOCAP@\fR(1M),
190 \fBcurses\fR(3X),
191 \fBterminfo\fR(\*n).
192 .PP
193 This describes \fBncurses\fR
194 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).