man/toe.1m

   1 .\"***************************************************************************
   2 .\" Copyright 2019-2022,2023 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: toe.1m,v 1.42 2023/09/09 21:15:25 tom Exp $
  31 .TH @TOE@ 1M 2023-09-09 "ncurses 6.4" "User commands"
  32 .de bP
  33 .ie n  .IP \(bu 4
  34 .el    .IP \(bu 2
  35 ..
  36 .ie \n(.g .ds `` \(lq
  37 .el       .ds `` ``
  38 .ie \n(.g .ds '' \(rq
  39 .el       .ds '' ''
  40 .ie n .ds CW R
  41 .el   \{
  42 .ie \n(.g .ds CW CR
  43 .el       .ds CW CW
  44 .\}
  45 .de NS
  46 .ie n  .sp
  47 .el    .sp .5
  48 .ie n  .in +4
  49 .el    .in +2
  50 .nf
  51 .ft \*(CW
  52 ..
  53 .de NE
  54 .fi
  55 .ft R
  56 .ie n  .in -4
  57 .el    .in -2
  58 ..
  59 .ds n 5
  60 .ds d @TERMINFO@
  61 .SH NAME
  62 \fB@TOE@\fP \- table of (terminfo) entries
  63 .SH SYNOPSIS
  64 \fB@TOE@\fP [\fB\-v\fP[\fIn\fP]] [\fB\-ahsuUV\fP] \fIfile...\fP
  65 .SH DESCRIPTION
  66 With no options,
  67 \fB@TOE@\fP lists all available terminal types by primary name
  68 with descriptions.
  69 File arguments specify the directories to be scanned; if no
  70 such arguments are given,
  71 your default terminfo directory is scanned.
  72 If you also specify the \fB\-h\fP option,
  73 a directory header will be issued as each
  74 directory is entered.
  75 .PP
  76 There are other options intended for use by terminfo file maintainers:
  77 .TP
  78 \fB\-a\fP
  79 report on all of the terminal databases which ncurses would search,
  80 rather than only the first one that it finds.
  81 .IP
  82 If the \fB\-s\fP is also given, \fB@TOE@\fP
  83 adds a column to the report,
  84 showing (like \fBconflict\fP(1)) which entries which
  85 belong to a given terminal database.
  86 An "*" marks entries which differ, and "+" marks equivalent entries.
  87 .IP
  88 Without the \fB\-s\fP option, \fB@TOE@\fP does not attempt to merge
  89 duplicates in its report
  90 .TP
  91 \fB\-s\fP
  92 sort the output by the entry names.
  93 .TP
  94 \fB\-u\fP \fIfile\fP
  95 says to write a report to the standard output,
  96 listing dependencies in the given terminfo/termcap source file.
  97 The report condenses the \*(``use\*('' relation:
  98 each line consists of the primary name of a terminal that
  99 has use capabilities,
 100 followed by a colon,
 101 followed by the
 102 whitespace-separated primary names of all terminals which occur in those use
 103 capabilities,
 104 followed by a newline
 105 .TP
 106 \fB\-U\fP \fIfile\fP
 107 says to write a report to the standard output,
 108 listing reverse dependencies in the given terminfo/termcap source file.
 109 The report reverses the \*(``use\*('' relation:
 110 each line consists of the primary name of a
 111 terminal that occurs in use capabilities,
 112 followed by a colon,
 113 followed by the
 114 whitespace-separated primary names of all terminals which depend on it,
 115 followed by a newline.
 116 .TP
 117 \fB\-v\fIn\fR
 118 specifies that (verbose) output be written to standard error,
 119 showing \fB@TOE@\fP's progress.
 120 .IP
 121 The optional parameter \fIn\fP is a number from 1 to 10,
 122 interpreted as for \fB@TIC@\fP(1M).
 123 If ncurses is built without tracing support, the optional parameter is ignored.
 124 .TP
 125 \fB\-V\fP
 126 reports the version of ncurses which was used in this program,
 127 and exits.
 128 .SH EXAMPLES
 129 Without sorting, the \fB\-a\fP option reports all of the names found
 130 in all of the terminal databases found by the \fBTERMINFO\fP and
 131 \fBTERMINFO_DIRS\fP environment variables:
 132 .NS
 133 MtxOrb162       16x2 Matrix Orbital LCD display
 134 MtxOrb204       20x4 Matrix Orbital LCD display
 135 MtxOrb          Generic Matrix Orbital LCD display
 136 qvt101+         qume qvt 101 PLUS product
 137 qvt119+-25      QVT 119 PLUS with 25 data lines
 138 qansi-g         QNX ANSI
 139 qvt103          qume qvt 103
 140 qnxw            QNX4 windows
 141 qansi-w         QNX ansi for windows
 142 qnxm            QNX4 with mouse events
 143 qvt203-25-w     QVT 203 PLUS with 25 by 132 columns
 144 qansi-t         QNX ansi without console writes
 145 \&.\ .\ .
 146 .NE
 147 .PP
 148 Use the \fB\-a\fP and \fB\-s\fP options together to show where each terminal
 149 description was found:
 150 .NS
 151 --> /usr/local/ncurses/share/terminfo
 152 ----> /usr/share/terminfo
 153 *-+-:   9term           Plan9 terminal emulator for X
 154 *---:   Eterm           Eterm with xterm-style color support (X Window System)
 155 *-*-:   Eterm-256color  Eterm with xterm 256-colors
 156 *-*-:   Eterm-88color   Eterm with 88 colors
 157 *-+-:   MtxOrb          Generic Matrix Orbital LCD display
 158 *-+-:   MtxOrb162       16x2 Matrix Orbital LCD display
 159 *-+-:   MtxOrb204       20x4 Matrix Orbital LCD display
 160 *-*-:   NCR260VT300WPP  NCR 2900_260 vt300 wide mode pc+  kybd
 161 *-+-:   aaa             ann arbor ambassador/30 lines
 162 *-+-:   aaa+dec         ann arbor ambassador in dec vt100 mode
 163 *-+-:   aaa+rv          ann arbor ambassador in reverse video
 164 \&.\ .\ .
 165 .NE
 166 .SH FILES
 167 .TP 5
 168 \fB\*d/?/*\fP
 169 Compiled terminal description database.
 170 .SH HISTORY
 171 This utility is not provided by other implementations.
 172 There is no relevant X/Open or POSIX standard for \fB@TOE@\fP.
 173 .PP
 174 The program name refers to a developer's pun:
 175 .bP
 176 \fBtic\fP,
 177 .bP
 178 \fBtac\fP (now \fBtack\fP),
 179 .bP
 180 \fBtoe\fP.
 181 .PP
 182 It replaced a \fB\-T\fP option which was briefly supported by
 183 the ncurses \fBinfocmp\fP utility in 1995.
 184 .PP
 185 The \fB\-a\fP and \fB\-s\fP options were added to
 186 \fB@TOE@\fP several years later (2006 and 2011, respectively).
 187 .SH SEE ALSO
 188 \fB@CAPTOINFO@\fP(1M),
 189 \fB@INFOCMP@\fP(1M),
 190 \fB@INFOTOCAP@\fP(1M),
 191 \fB@TIC@\fP(1M),
 192 \fBcurses\fP(3X),
 193 \fBterminfo\fP(\*n).
 194 .PP
 195 This describes \fBncurses\fP
 196 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).