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