ncurses 5.4
[ncurses.git] / man / toe.1m
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2000,2003 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.12 2003/05/11 00:32:53 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\-huUV\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\-u\fR \fIfile\fR
49 says to issue a report on dependencies in the given file. This report condenses
50 the `use' relation: each line consists of the primary name of a terminal that
51 has use capabilities, followed by a colon, followed by the
52 whitespace-separated primary names of all terminals which occur in those use
53 capabilities, followed by a newline
54 .TP
55 \fB\-U\fR \fIfile\fR
56 says to issue a report on reverse dependencies in the given file. This report
57 reverses the `use' relation: each line consists of the primary name of a
58 terminal that occurs in use capabilities, followed by a colon, followed by the
59 whitespace-separated primary names of all terminals which depend on it,
60 followed by a newline.
61 .TP
62 \fB\-v\fR\fIn\fR
63 specifies that (verbose) output be written to standard error trace
64 information showing \fBtoe\fR's progress.  The optional integer
65 \fIn\fR is a number from 1 to 10, interpreted as for \fBtic\fR(1).
66 .TP 5
67 \fB\-V\fR
68 reports the version of ncurses which was used in this program, and exits.
69 .SH FILES
70 .TP 5
71 \fB\*d/?/*\fR
72 Compiled terminal description database.
73 .SH SEE ALSO
74 \fB@TIC@\fR(1M), \fB@INFOCMP@\fR(1M), \fB@CAPTOINFO@\fR(1M),
75 \fB@INFOTOCAP@\fR(1M), \fBcurses\fR(3X), \fBterminfo\fR(\*n).
76 .\"#
77 .\"# The following sets edit modes for GNU EMACS
78 .\"# Local Variables:
79 .\"# mode:nroff
80 .\"# fill-column:79
81 .\"# End: