blob: 26af319b66a5ef36c365326bdb470222743206c2 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301.\"***************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +01002.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05303.\" *
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.\"
Steve Kondikae271bc2015-11-15 02:50:53 +010029.\" $Id: toe.1m,v 1.26 2012/01/01 00:40:51 tom Exp $
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053030.TH @TOE@ 1M ""
31.ds n 5
32.ds d @TERMINFO@
33.SH NAME
Steve Kondikae271bc2015-11-15 02:50:53 +010034\fB@TOE@\fR \- table of (terminfo) entries
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053035.SH SYNOPSIS
Steve Kondikae271bc2015-11-15 02:50:53 +010036\fB@TOE@\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahsuUV\fR] \fIfile...\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053037.br
38.SH DESCRIPTION
39.PP
40With no options,
Steve Kondikae271bc2015-11-15 02:50:53 +010041\fB@TOE@\fR lists all available terminal types by primary name
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053042with descriptions.
43File arguments specify the directories to be scanned; if no
44such arguments are given,
45your default terminfo directory is scanned.
Steve Kondikae271bc2015-11-15 02:50:53 +010046If you also specify the \fB\-h\fR option,
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053047a 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
Steve Kondikae271bc2015-11-15 02:50:53 +010052\fB\-a\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053053report on all of the terminal databases which ncurses would search,
54rather than only the first one that it finds.
Steve Kondikae271bc2015-11-15 02:50:53 +010055.IP
56If the \fB\-s\fR is also given, \fB@TOE@\fR
57adds a column to the report,
58showing (like \fBconflict\fP(1)) which entries which
59belong to a given terminal database.
60An "*" marks entries which differ, and "+" marks equivalent entries.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053061.TP
Steve Kondikae271bc2015-11-15 02:50:53 +010062\fB\-s\fR
63sort the output by the entry names.
64.TP
65\fB\-u\fR \fIfile\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053066says to write a report to the standard output,
67listing dependencies in the given terminfo/termcap source file.
68The report condenses the `use' relation:
69each line consists of the primary name of a terminal that
70has use capabilities,
71followed by a colon,
72followed by the
73whitespace-separated primary names of all terminals which occur in those use
74capabilities,
75followed by a newline
76.TP
Steve Kondikae271bc2015-11-15 02:50:53 +010077\fB\-U\fR \fIfile\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053078says to write a report to the standard output,
79listing reverse dependencies in the given terminfo/termcap source file.
80The report reverses the `use' relation:
81each line consists of the primary name of a
82terminal that occurs in use capabilities,
83followed by a colon,
84followed by the
85whitespace-separated primary names of all terminals which depend on it,
86followed by a newline.
87.TP
Steve Kondikae271bc2015-11-15 02:50:53 +010088\fB\-v\fR\fIn\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053089specifies that (verbose) output be written to standard error,
Steve Kondikae271bc2015-11-15 02:50:53 +010090showing \fB@TOE@\fR's progress.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053091The optional parameter \fIn\fR is a number from 1 to 10,
92interpreted as for \fB@TIC@\fR(1M).
93.TP
Steve Kondikae271bc2015-11-15 02:50:53 +010094\fB\-V\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053095reports the version of ncurses which was used in this program,
96and exits.
97.SH FILES
98.TP 5
99\fB\*d/?/*\fR
100Compiled terminal description database.
101.SH SEE ALSO
102\fB@TIC@\fR(1M),
103\fB@INFOCMP@\fR(1M),
104\fB@CAPTOINFO@\fR(1M),
105\fB@INFOTOCAP@\fR(1M),
106\fBcurses\fR(3X),
107\fBterminfo\fR(\*n).
108.PP
109This describes \fBncurses\fR
110version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).