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

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