ncurses 6.0 - patch 20170114
[ncurses.git] / man / toe.1m
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2015,2017 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.28 2017/01/14 19:55:36 tom Exp $
30 .TH @TOE@ 1M ""
31 .ds n 5
32 .ds d @TERMINFO@
33 .SH NAME
34 \fB@TOE@\fR \- table of (terminfo) entries
35 .SH SYNOPSIS
36 \fB@TOE@\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahsuUV\fR] \fIfile...\fR
37 .br
38 .SH DESCRIPTION
39 .PP
40 With no options,
41 \fB@TOE@\fR lists all available terminal types by primary name
42 with descriptions.
43 File arguments specify the directories to be scanned; if no
44 such arguments are given,
45 your default terminfo directory is scanned.
46 If you also specify the \fB\-h\fR option,
47 a directory header will be issued as each
48 directory is entered.
49 .PP
50 There are other options intended for use by terminfo file maintainers:
51 .TP
52 \fB\-a\fR
53 report on all of the terminal databases which ncurses would search,
54 rather than only the first one that it finds.
55 .IP
56 If the \fB\-s\fR is also given, \fB@TOE@\fR
57 adds a column to the report,
58 showing (like \fBconflict\fP(1)) which entries which 
59 belong to a given terminal database.
60 An "*" marks entries which differ, and "+" marks equivalent entries.
61 .IP
62 Without the \fB\-s\fP option, \fB@TOE@\fR does not attempt to merge
63 duplicates in its report
64 .TP
65 \fB\-s\fR
66 sort the output by the entry names.
67 .TP
68 \fB\-u\fR \fIfile\fR
69 says to write a report to the standard output,
70 listing dependencies in the given terminfo/termcap source file.
71 The report condenses the `use' relation:
72 each line consists of the primary name of a terminal that
73 has use capabilities,
74 followed by a colon,
75 followed by the
76 whitespace-separated primary names of all terminals which occur in those use
77 capabilities,
78 followed by a newline
79 .TP
80 \fB\-U\fR \fIfile\fR
81 says to write a report to the standard output,
82 listing reverse dependencies in the given terminfo/termcap source file.
83 The report reverses the `use' relation:
84 each line consists of the primary name of a
85 terminal that occurs in use capabilities,
86 followed by a colon,
87 followed by the
88 whitespace-separated primary names of all terminals which depend on it,
89 followed by a newline.
90 .TP
91 \fB\-v\fR\fIn\fR
92 specifies that (verbose) output be written to standard error,
93 showing \fB@TOE@\fR's progress.
94 .IP
95 The optional parameter \fIn\fR is a number from 1 to 10,
96 interpreted as for \fB@TIC@\fR(1M).
97 If ncurses is built without tracing support, the optional parameter is ignored.
98 .TP
99 \fB\-V\fR
100 reports the version of ncurses which was used in this program,
101 and exits.
102 .SH FILES
103 .TP 5
104 \fB\*d/?/*\fR
105 Compiled terminal description database.
106 .SH SEE ALSO
107 \fB@TIC@\fR(1M),
108 \fB@INFOCMP@\fR(1M),
109 \fB@CAPTOINFO@\fR(1M),
110 \fB@INFOTOCAP@\fR(1M),
111 \fBcurses\fR(3X),
112 \fBterminfo\fR(\*n).
113 .PP
114 This describes \fBncurses\fR
115 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).