doc/html/man/toe.1m.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2019-2022,2023 Thomas E. Dickey                                *
   4   * Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: toe.1m,v 1.53 2023/10/14 19:18:14 tom Exp @
  31   * toe -a | grep -E '^(xterm|vt)'
  32   * The next row overruns the line length on DWB nroff (65n).
  33   * toe -as | grep -E '(^-+&gt;|:.(xterm|vt))'
  34   * The next row overruns the line length on DWB nroff (65n).
  35   * The next row overruns the line length on DWB nroff (65n).
  36 -->
  37 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  38 <HTML>
  39 <HEAD>
  40 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  41 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  42 <TITLE>toe 1m 2023-10-14 ncurses 6.4 User commands</TITLE>
  43 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  44
  45 </HEAD>
  46 <BODY>
  47 <H1 class="no-header">toe 1m 2023-10-14 ncurses 6.4 User commands</H1>
  48 <PRE>
  49 <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>                          User commands                         <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
  50
  51
  52
  53
  54 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  55        <STRONG>toe</STRONG> - list table of entries of <EM>terminfo</EM> terminal types
  56
  57
  58 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  59        <STRONG>toe</STRONG> [<STRONG>-ahs</STRONG>] [<STRONG>-v</STRONG> [<EM>n</EM>]] [<EM>directory</EM> ...]
  60
  61        <STRONG>toe</STRONG> [<STRONG>-u</STRONG>|<STRONG>-U</STRONG>] <EM>file</EM>
  62
  63        <STRONG>toe</STRONG> <STRONG>-V</STRONG>
  64
  65
  66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  67        <STRONG>toe</STRONG>  reports  to  the  standard  output  stream the (primary) names and
  68        descriptions of the terminal types available to the  <EM>terminfo</EM>  library.
  69        Each <EM>directory</EM> operand is scanned; if none are given, <STRONG>toe</STRONG> scans the the
  70        default <EM>terminfo</EM> directory.
  71
  72
  73 </PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
  74        The <STRONG>-h</STRONG> option can be helpful  to  observe  where  <STRONG>toe</STRONG>  is  looking  for
  75        terminal  descriptions.   Other options support maintainers of <EM>terminfo</EM>
  76        terminal descriptions.
  77
  78        <STRONG>-a</STRONG>       lists entries from  all  terminal  database  directories  that
  79                 <EM>terminfo</EM>  would  search,  instead  of  only  the first that it
  80                 finds.
  81
  82                 If the <STRONG>-s</STRONG> option is also given,  <STRONG>toe</STRONG>  adds  a  column  to  the
  83                 report,  showing  (like <STRONG>conflict(1)</STRONG>) which entries belong to a
  84                 given terminal database.  An "*" marks  entries  that  differ,
  85                 and "+" marks equivalent entries.
  86
  87                 Without   the  <STRONG>-s</STRONG>  option,  <STRONG>toe</STRONG>  does  not  attempt  to  merge
  88                 duplicates in its report.
  89
  90        <STRONG>-h</STRONG>       writes a heading naming each each directory as it is accessed.
  91
  92        <STRONG>-s</STRONG>       sorts the output by the entry names.
  93
  94        <STRONG>-u</STRONG> <EM>file</EM>  lists terminal type dependencies in  <EM>file</EM>,  a  <EM>terminfo</EM>  entry
  95                 source  or  <EM>termcap</EM>  database file.  The report summarizes the
  96                 "<STRONG>use</STRONG>"  (<EM>terminfo</EM>)  and  <STRONG>tc</STRONG>  (<EM>termcap</EM>)  relations:  each   line
  97                 comprises the primary name of a terminal type employing <STRONG>use</STRONG>/<STRONG>tc</STRONG>
  98                 capabilities, a colon, a  space-  and  tab-separated  list  of
  99                 primary names of terminal types thus named, and a newline.
 100
 101        <STRONG>-U</STRONG> <EM>file</EM>  lists  terminal  type reverse dependencies in <EM>file</EM>, a <EM>terminfo</EM>
 102                 entry source or <EM>termcap</EM> database file.  The report  summarizes
 103                 the  "<STRONG>use</STRONG>" (<EM>terminfo</EM>) and <STRONG>tc</STRONG> (<EM>termcap</EM>) reverse relations: each
 104                 line comprises the primary name of a terminal  type  occurring
 105                 in  <STRONG>use</STRONG>/<STRONG>tc</STRONG>  capabilities,  a colon, a space- and tab-separated
 106                 list of primary names of terminal types naming them thus,  and
 107                 a newline.
 108
 109        <STRONG>-v</STRONG> [<EM>n</EM>]   reports  verbose  status  information  to  the  standard error
 110                 stream, showing <STRONG>toe</STRONG>'s progress.
 111
 112                 The optional parameter <EM>n</EM>  is  an  integer  between  1  and  10
 113                 inclusive,  interpreted  as  for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>.  If <EM>ncurses</EM> is built
 114                 without tracing support, <EM>n</EM> is ignored.
 115
 116        <STRONG>-V</STRONG>       reports the version of <EM>ncurses</EM> associated  with  this  program
 117                 and exits with a successful status.
 118
 119
 120 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
 121        When  not  sorting with the <STRONG>-s</STRONG> option, the <STRONG>-a</STRONG> option reports all of the
 122        names found in all of the terminal database directories  named  in  the
 123        <STRONG>TERMINFO</STRONG> and <STRONG>TERMINFO_DIRS</STRONG> environment variables.
 124
 125            xterm-color     generic color xterm
 126            xterm-xfree86   xterm terminal emulator (XFree86)
 127            xterm-vt220     xterm emulating vt220
 128            xterm-256color  xterm with 256 colors
 129            xterm-r6        xterm X11R6 version
 130            xterm-r5        xterm R5 version
 131            xterm-mono      monochrome xterm
 132            xterm           xterm terminal emulator (X Window System)
 133            vt220           dec vt220
 134            vt102           dec vt102
 135            vt100           dec vt100 (w/advanced video)
 136            vt52            dec vt52
 137            ...
 138
 139        Use  the  <STRONG>-a</STRONG>  and  <STRONG>-s</STRONG>  options  together  to  show  where each terminal
 140        description was found.
 141
 142            --&gt; /etc/terminfo
 143            ----&gt; /lib/terminfo
 144            ------&gt; /usr/share/terminfo
 145
 146            --*---: vt100           dec vt100 (w/advanced video)
 147            --*---: vt102           dec vt102
 148            --*---: vt220           dec vt220
 149            --*---: vt52            dec vt52
 150            --*---: xterm           xterm terminal emulator (X Window System)
 151            --*---: xterm-256color  xterm with 256 colors
 152            --*---: xterm-color     generic color xterm
 153            --*---: xterm-mono      monochrome xterm
 154            --*---: xterm-r5        xterm R5 version
 155            --*---: xterm-r6        xterm X11R6 version
 156            --*---: xterm-vt220     xterm emulating vt220
 157            --*---: xterm-xfree86   xterm terminal emulator (XFree86)
 158            ...
 159
 160
 161 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
 162        <EM>/usr/share/terminfo</EM>
 163               compiled terminal description database
 164
 165
 166 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
 167        <STRONG>toe</STRONG> is not provided by other implementations.  There is  no  applicable
 168        X/Open or POSIX standard for it.
 169
 170        It  replaces  a  <STRONG>-T</STRONG>  option  that  was briefly supported by the <EM>ncurses</EM>
 171        <STRONG>infocmp</STRONG> utility in 1995.
 172
 173        The <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options were added in 2006 and 2011, respectively.
 174
 175        The program's name originates with a developer's pun:
 176
 177        <STRONG>o</STRONG>   <STRONG>tic</STRONG>,
 178
 179        <STRONG>o</STRONG>   <STRONG>tac</STRONG> (now <STRONG>tack</STRONG>),
 180
 181        <STRONG>o</STRONG>   <STRONG>toe</STRONG>.
 182
 183
 184 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 185        <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>,   <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>,   <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>,   <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>,   <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,
 186        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 187
 188
 189
 190 ncurses 6.4                       2023-10-14                           <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
 191 </PRE>
 192 <div class="nav">
 193 <ul>
 194 <li><a href="#h2-NAME">NAME</a></li>
 195 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 196 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 197 <li><a href="#h2-OPTIONS">OPTIONS</a></li>
 198 <li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
 199 <li><a href="#h2-FILES">FILES</a></li>
 200 <li><a href="#h2-HISTORY">HISTORY</a></li>
 201 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 202 </ul>
 203 </div>
 204 </BODY>
 205 </HTML>