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.40 2023/07/01 15:46:10 tom Exp $
  31 .TH @TOE@ 1M 2023-07-01 "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 .de NS
  41 .ie n  .sp
  42 .el    .sp .5
  43 .ie n  .in +4
  44 .el    .in +2
  45 .nf
  46 .ft CR                  \" Courier
  47 ..
  48 .de NE
  49 .fi
  50 .ft R
  51 .ie n  .in -4
  52 .el    .in -2
  53 ..
  54 .ds n 5
  55 .ds d @TERMINFO@
  56 .SH NAME
  57 \fB@TOE@\fP \- table of (terminfo) entries
  58 .SH SYNOPSIS
  59 \fB@TOE@\fP [\fB\-v\fP[\fIn\fP]] [\fB\-ahsuUV\fP] \fIfile...\fP
  60 .SH DESCRIPTION
  61 With no options,
  62 \fB@TOE@\fP lists all available terminal types by primary name
  63 with descriptions.
  64 File arguments specify the directories to be scanned; if no
  65 such arguments are given,
  66 your default terminfo directory is scanned.
  67 If you also specify the \fB\-h\fP option,
  68 a directory header will be issued as each
  69 directory is entered.
  70 .PP
  71 There are other options intended for use by terminfo file maintainers:
  72 .TP
  73 \fB\-a\fP
  74 report on all of the terminal databases which ncurses would search,
  75 rather than only the first one that it finds.
  76 .IP
  77 If the \fB\-s\fP is also given, \fB@TOE@\fP
  78 adds a column to the report,
  79 showing (like \fBconflict\fP(1)) which entries which
  80 belong to a given terminal database.
  81 An "*" marks entries which differ, and "+" marks equivalent entries.
  82 .IP
  83 Without the \fB\-s\fP option, \fB@TOE@\fP does not attempt to merge
  84 duplicates in its report
  85 .TP
  86 \fB\-s\fP
  87 sort the output by the entry names.
  88 .TP
  89 \fB\-u\fP \fIfile\fP
  90 says to write a report to the standard output,
  91 listing dependencies in the given terminfo/termcap source file.
  92 The report condenses the \*(``use\*('' relation:
  93 each line consists of the primary name of a terminal that
  94 has use capabilities,
  95 followed by a colon,
  96 followed by the
  97 whitespace-separated primary names of all terminals which occur in those use
  98 capabilities,
  99 followed by a newline
 100 .TP
 101 \fB\-U\fP \fIfile\fP
 102 says to write a report to the standard output,
 103 listing reverse dependencies in the given terminfo/termcap source file.
 104 The report reverses the \*(``use\*('' relation:
 105 each line consists of the primary name of a
 106 terminal that occurs in use capabilities,
 107 followed by a colon,
 108 followed by the
 109 whitespace-separated primary names of all terminals which depend on it,
 110 followed by a newline.
 111 .TP
 112 \fB\-v\fIn\fR
 113 specifies that (verbose) output be written to standard error,
 114 showing \fB@TOE@\fP's progress.
 115 .IP
 116 The optional parameter \fIn\fP is a number from 1 to 10,
 117 interpreted as for \fB@TIC@\fP(1M).
 118 If ncurses is built without tracing support, the optional parameter is ignored.
 119 .TP
 120 \fB\-V\fP
 121 reports the version of ncurses which was used in this program,
 122 and exits.
 123 .SH EXAMPLES
 124 Without sorting, the \fB\-a\fP option reports all of the names found
 125 in all of the terminal databases found by the \fBTERMINFO\fP and
 126 \fBTERMINFO_DIRS\fP environment variables:
 127 .NS
 128 MtxOrb162       16x2 Matrix Orbital LCD display
 129 MtxOrb204       20x4 Matrix Orbital LCD display
 130 MtxOrb          Generic Matrix Orbital LCD display
 131 qvt101+         qume qvt 101 PLUS product
 132 qvt119+-25      QVT 119 PLUS with 25 data lines
 133 qansi-g         QNX ANSI
 134 qvt103          qume qvt 103
 135 qnxw            QNX4 windows
 136 qansi-w         QNX ansi for windows
 137 qnxm            QNX4 with mouse events
 138 qvt203-25-w     QVT 203 PLUS with 25 by 132 columns
 139 qansi-t         QNX ansi without console writes
 140 \&.\ .\ .
 141 .NE
 142 .PP
 143 Use the \fB\-a\fP and \fB\-s\fP options together to show where each terminal
 144 description was found:
 145 .NS
 146 --> /usr/local/ncurses/share/terminfo
 147 ----> /usr/share/terminfo
 148 *-+-:   9term           Plan9 terminal emulator for X
 149 *---:   Eterm           Eterm with xterm-style color support (X Window System)
 150 *-*-:   Eterm-256color  Eterm with xterm 256-colors
 151 *-*-:   Eterm-88color   Eterm with 88 colors
 152 *-+-:   MtxOrb          Generic Matrix Orbital LCD display
 153 *-+-:   MtxOrb162       16x2 Matrix Orbital LCD display
 154 *-+-:   MtxOrb204       20x4 Matrix Orbital LCD display
 155 *-*-:   NCR260VT300WPP  NCR 2900_260 vt300 wide mode pc+  kybd
 156 *-+-:   aaa             ann arbor ambassador/30 lines
 157 *-+-:   aaa+dec         ann arbor ambassador in dec vt100 mode
 158 *-+-:   aaa+rv          ann arbor ambassador in reverse video
 159 \&.\ .\ .
 160 .NE
 161 .SH FILES
 162 .TP 5
 163 \fB\*d/?/*\fP
 164 Compiled terminal description database.
 165 .SH HISTORY
 166 This utility is not provided by other implementations.
 167 There is no relevant X/Open or POSIX standard for \fB@TOE@\fP.
 168 .PP
 169 The program name refers to a developer's pun:
 170 .bP
 171 \fBtic\fP,
 172 .bP
 173 \fBtac\fP (now \fBtack\fP),
 174 .bP
 175 \fBtoe\fP.
 176 .PP
 177 It replaced a \fB\-T\fP option which was briefly supported by
 178 the ncurses \fBinfocmp\fP utility in 1995.
 179 .PP
 180 The \fB\-a\fP and \fB\-s\fP options were added to
 181 \fB@TOE@\fP several years later (2006 and 2011, respectively).
 182 .SH SEE ALSO
 183 \fB@CAPTOINFO@\fP(1M),
 184 \fB@INFOCMP@\fP(1M),
 185 \fB@INFOTOCAP@\fP(1M),
 186 \fB@TIC@\fP(1M),
 187 \fBcurses\fP(3X),
 188 \fBterminfo\fP(\*n).
 189 .PP
 190 This describes \fBncurses\fP
 191 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).