blob: 15303541dddc86974bafa26b5c0c1a31a0c68dfa [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301.\"***************************************************************************
2.\" Copyright (c) 1998-2006,2008 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.21 2008/01/05 20:57:16 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
40With no options,
41\fBtoe\fR lists all available terminal types by primary name
42with descriptions.
43File arguments specify the directories to be scanned; if no
44such arguments are given,
45your default terminfo directory is scanned.
46If you also specify the \fB-h\fR option,
47a directory header will be issued as each
48directory is entered.
49.PP
50There are other options intended for use by terminfo file maintainers:
51.TP
52\fB-a\fR
53report on all of the terminal databases which ncurses would search,
54rather than only the first one that it finds.
55.TP
56\fB-u\fR \fIfile\fR
57says to write a report to the standard output,
58listing dependencies in the given terminfo/termcap source file.
59The report condenses the `use' relation:
60each line consists of the primary name of a terminal that
61has use capabilities,
62followed by a colon,
63followed by the
64whitespace-separated primary names of all terminals which occur in those use
65capabilities,
66followed by a newline
67.TP
68\fB-U\fR \fIfile\fR
69says to write a report to the standard output,
70listing reverse dependencies in the given terminfo/termcap source file.
71The report reverses the `use' relation:
72each line consists of the primary name of a
73terminal that occurs in use capabilities,
74followed by a colon,
75followed by the
76whitespace-separated primary names of all terminals which depend on it,
77followed by a newline.
78.TP
79\fB-v\fR\fIn\fR
80specifies that (verbose) output be written to standard error,
81showing \fBtoe\fR's progress.
82The optional parameter \fIn\fR is a number from 1 to 10,
83interpreted as for \fB@TIC@\fR(1M).
84.TP
85\fB-V\fR
86reports the version of ncurses which was used in this program,
87and exits.
88.SH FILES
89.TP 5
90\fB\*d/?/*\fR
91Compiled terminal description database.
92.SH SEE ALSO
93\fB@TIC@\fR(1M),
94\fB@INFOCMP@\fR(1M),
95\fB@CAPTOINFO@\fR(1M),
96\fB@INFOTOCAP@\fR(1M),
97\fBcurses\fR(3X),
98\fBterminfo\fR(\*n).
99.PP
100This describes \fBncurses\fR
101version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
102.\"#
103.\"# The following sets edit modes for GNU EMACS
104.\"# Local Variables:
105.\"# mode:nroff
106.\"# fill-column:79
107.\"# End: