ncurses 5.6 - patch 20070128
[ncurses.git] / man / toe.1m
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2004,2006 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.20 2006/12/24 17:20:37 tom Exp $
30 .TH @TOE@ 1M ""
31 .ds n 5
32 .ds d @TERMINFO@
33 .SH NAME
34 \fBtoe\fR - table of (terminfo) entries
35 .SH SYNOPSIS
36 \fBtoe\fR [\fB-v\fR[\fIn\fR]] [\fB-ahuUV\fR] \fIfile...\fR
37 .br
38 .SH DESCRIPTION
39 .PP
40 With no options, \fBtoe\fR lists all available terminal types by primary name
41 with descriptions.  File arguments specify the directories to be scanned; if no
42 such arguments are given, your default terminfo directory is scanned.  If you
43 also specify the \fB-h\fR option, a directory header will be issued as each
44 directory is entered.
45 .PP
46 There are other options intended for use by terminfo file maintainers:
47 .TP
48 \fB-a\fR
49 report on all of the terminal databases which ncurses would search,
50 rather than only the first one that it finds.
51 .TP
52 \fB-u\fR \fIfile\fR
53 says to issue a report on dependencies in the given file. This report condenses
54 the `use' relation: each line consists of the primary name of a terminal that
55 has use capabilities, followed by a colon, followed by the
56 whitespace-separated primary names of all terminals which occur in those use
57 capabilities, followed by a newline
58 .TP
59 \fB-U\fR \fIfile\fR
60 says to issue a report on reverse dependencies in the given file. This report
61 reverses the `use' relation: each line consists of the primary name of a
62 terminal that occurs in use capabilities, followed by a colon, followed by the
63 whitespace-separated primary names of all terminals which depend on it,
64 followed by a newline.
65 .TP
66 \fB-v\fR\fIn\fR
67 specifies that (verbose) output be written to standard error,
68 showing \fBtoe\fR's progress.
69 The optional parameter \fIn\fR is a number from 1 to 10,
70 interpreted as for \fB@TIC@\fR(1M).
71 .TP
72 \fB-V\fR
73 reports the version of ncurses which was used in this program, and exits.
74 .SH FILES
75 .TP 5
76 \fB\*d/?/*\fR
77 Compiled terminal description database.
78 .SH SEE ALSO
79 \fB@TIC@\fR(1M),
80 \fB@INFOCMP@\fR(1M),
81 \fB@CAPTOINFO@\fR(1M),
82 \fB@INFOTOCAP@\fR(1M),
83 \fBcurses\fR(3X),
84 \fBterminfo\fR(\*n).
85 .PP
86 This describes \fBncurses\fR
87 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
88 .\"#
89 .\"# The following sets edit modes for GNU EMACS
90 .\"# Local Variables:
91 .\"# mode:nroff
92 .\"# fill-column:79
93 .\"# End: