]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/toe.1m.html
ncurses 6.4 - patch 20240414
[ncurses.git] / doc / html / man / toe.1m.html
index d1336495865721d6ac818c0b3e618cf76b64131c..46578230e21e8d4a3b6afe6accedf1e3f5efc1d5 100644 (file)
@@ -1,6 +1,7 @@
-<!-- 
+<!--
+  * t
   ****************************************************************************
-  * Copyright 2019,2020 Thomas E. Dickey                                     *
+  * Copyright 2019-2023,2024 Thomas E. Dickey                                *
   * Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: toe.1m,v 1.32 2020/02/02 23:34:34 tom Exp @
+  * @Id: toe.1m,v 1.66 2024/03/16 15:35:01 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>toe 1m</TITLE>
+<TITLE>toe 1m 2024-03-16 ncurses 6.4 User commands</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
 </HEAD>
 <BODY>
-<H1 class="no-header">toe 1m</H1>
+<H1 class="no-header">toe 1m 2024-03-16 ncurses 6.4 User commands</H1>
 <PRE>
-<STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>                                                                <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
+<STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>                          User commands                         <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <STRONG>toe</STRONG> - table of (terminfo) entries
+       <STRONG>toe</STRONG> - list table of entries of <EM>terminfo</EM> terminal types
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <STRONG>toe</STRONG> [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-ahsuUV</STRONG>] <EM>file...</EM>
+       <STRONG>toe</STRONG> [<STRONG>-ahs</STRONG>] [<STRONG>-v</STRONG> [<EM>n</EM>]] [<EM>directory</EM> ...]
+
+       <STRONG>toe</STRONG> [<STRONG>-u</STRONG>|<STRONG>-U</STRONG>] <EM>file</EM>
+
+       <STRONG>toe</STRONG> <STRONG>-V</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       With no options, <STRONG>toe</STRONG> lists all available terminal types by primary name
-       with descriptions.   File  arguments  specify  the  directories  to  be
-       scanned;  if  no such arguments are given, your default terminfo direc-
-       tory is scanned.  If you also specify the <STRONG>-h</STRONG> option, a directory header
-       will be issued as each directory is entered.
+       <STRONG>toe</STRONG>  reports  to  the  standard  output  stream the (primary) names and
+       descriptions of the terminal types available to the  <EM>terminfo</EM>  library.
+       Each  <EM>directory</EM>  is  scanned;  if none are given, <STRONG>toe</STRONG> scans the default
+       <EM>terminfo</EM> directory.
 
-       There are other options intended for use by terminfo file maintainers:
 
-       <STRONG>-a</STRONG>     report  on  all  of  the  terminal databases which ncurses would
-              search, rather than only the first one that it finds.
+</PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
+       The <STRONG>-h</STRONG> option can be helpful  to  observe  where  <STRONG>toe</STRONG>  is  looking  for
+       terminal  descriptions.   Other options support maintainers of <EM>terminfo</EM>
+       terminal descriptions.
 
-              If the <STRONG>-s</STRONG> is also given, <STRONG>toe</STRONG> adds a column to the report,  show-
-              ing  (like  <STRONG>conflict(1)</STRONG>)  which  entries which belong to a given
-              terminal database.  An "*" marks entries which differ,  and  "+"
-              marks equivalent entries.
+       <STRONG>-a</STRONG>       lists entries from  all  terminal  database  directories  that
+                <EM>terminfo</EM>  would  search,  instead  of  only  the first that it
+                finds.
 
-              Without  the <STRONG>-s</STRONG> option, <STRONG>toe</STRONG> does not attempt to merge duplicates
-              in its report
+                If the <STRONG>-s</STRONG> option is also given,  <STRONG>toe</STRONG>  adds  a  column  to  the
+                report,  showing  (like <STRONG>conflict(1)</STRONG>) which entries belong to a
+                given terminal database.  An "*" marks  entries  that  differ,
+                and "+" marks equivalent entries.
 
-       <STRONG>-s</STRONG>     sort the output by the entry names.
+                Without   the  <STRONG>-s</STRONG>  option,  <STRONG>toe</STRONG>  does  not  attempt  to  merge
+                duplicates in its report.
 
-       <STRONG>-u</STRONG> <EM>file</EM>
-              says to write a report to the standard output, listing dependen-
-              cies in the given terminfo/termcap source file.  The report con-
-              denses the "use" relation: each line  consists  of  the  primary
-              name  of  a  terminal  that  has use capabilities, followed by a
-              colon, followed by the whitespace-separated primary names of all
-              terminals  which  occur in those use capabilities, followed by a
-              newline
+       <STRONG>-h</STRONG>       writes a heading naming each each directory as it is accessed.
 
-       <STRONG>-U</STRONG> <EM>file</EM>
-              says to write a report to the standard output,  listing  reverse
-              dependencies  in  the  given  terminfo/termcap source file.  The
-              report reverses the "use" relation: each line  consists  of  the
-              primary name of a terminal that occurs in use capabilities, fol-
-              lowed by a colon, followed by the  whitespace-separated  primary
-              names  of  all  terminals which depend on it, followed by a new-
-              line.
+       <STRONG>-s</STRONG>       sorts the output by the entry names.
 
-       <STRONG>-v</STRONG><EM>n</EM>    specifies that (verbose) output be written  to  standard  error,
-              showing <STRONG>toe</STRONG>'s progress.
+       <STRONG>-u</STRONG> <EM>file</EM>  lists terminal type dependencies in  <EM>file</EM>,  a  <EM>terminfo</EM>  entry
+                source  or  <EM>termcap</EM>  database file.  The report summarizes the
+                "<STRONG>use</STRONG>"  (<EM>terminfo</EM>)  and  <STRONG>tc</STRONG>  (<EM>termcap</EM>)  relations:  each   line
+                comprises the primary name of a terminal type employing <STRONG>use</STRONG>/<STRONG>tc</STRONG>
+                capabilities, a colon, a  space-  and  tab-separated  list  of
+                primary names of terminal types thus named, and a newline.
 
-              The  optional  parameter <EM>n</EM> is a number from 1 to 10, interpreted
-              as for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>.  If ncurses is built  without  tracing  support,
-              the optional parameter is ignored.
+       <STRONG>-U</STRONG> <EM>file</EM>  lists  terminal  type reverse dependencies in <EM>file</EM>, a <EM>terminfo</EM>
+                entry source or <EM>termcap</EM> database file.  The report  summarizes
+                the  "<STRONG>use</STRONG>" (<EM>terminfo</EM>) and <STRONG>tc</STRONG> (<EM>termcap</EM>) reverse relations: each
+                line comprises the primary name of a terminal  type  occurring
+                in  <STRONG>use</STRONG>/<STRONG>tc</STRONG>  capabilities,  a colon, a space- and tab-separated
+                list of primary names of terminal types naming them thus,  and
+                a newline.
 
-       <STRONG>-V</STRONG>     reports  the  version of ncurses which was used in this program,
-              and exits.
+       <STRONG>-v</STRONG> [<EM>n</EM>]   reports  verbose  status  information  to  the  standard error
+                stream, showing <STRONG>toe</STRONG>'s progress.
 
+                The optional parameter <EM>n</EM>  is  an  integer  between  1  and  10
+                inclusive,  interpreted  as  for <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>.  If <EM>ncurses</EM> is built
+                without tracing support, <EM>n</EM> is ignored.
 
-</PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
-       Without sorting, the <STRONG>-a</STRONG> option reports all of the names found in all of
-       the terminal databases found by the <STRONG>TERMINFO</STRONG> and <STRONG>TERMINFO_DIRS</STRONG> environ-
-       ment variables:
-
-           MtxOrb162      16x2 Matrix Orbital LCD display
-           MtxOrb204      20x4 Matrix Orbital LCD display
-           MtxOrb         Generic Matrix Orbital LCD display
-           qvt101+        qume qvt 101 PLUS product
-           qvt119+-25     QVT 119 PLUS with 25 data lines
-           qansi-g        QNX ANSI
-           qvt103         qume qvt 103
-           qnxw           QNX4 windows
-           qansi-w        QNX ansi for windows
-           qnxm           QNX4 with mouse events
-           qvt203-25-w    QVT 203 PLUS with 25 by 132 columns
-           qansi-t        QNX ansi without console writes
-           . . .
-
-       Use the <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options together to show where each terminal descrip-
-       tion was found:
-
-           --&gt; /usr/local/ncurses/share/terminfo
-           ----&gt; /usr/share/terminfo
-           *-+-:     9term          Plan9 terminal emulator for X
-           *---:     Eterm          Eterm with xterm-style color support (X Window System)
-           *-*-:     Eterm-256color Eterm with xterm 256-colors
-           *-*-:     Eterm-88color  Eterm with 88 colors
-           *-+-:     MtxOrb         Generic Matrix Orbital LCD display
-           *-+-:     MtxOrb162      16x2 Matrix Orbital LCD display
-           *-+-:     MtxOrb204      20x4 Matrix Orbital LCD display
-           *-*-:     NCR260VT300WPP NCR 2900_260 vt300 wide mode pc+  kybd
-           *-+-:     aaa            ann arbor ambassador/30 lines
-           *-+-:     aaa+dec        ann arbor ambassador in dec vt100 mode
-           *-+-:     aaa+rv         ann arbor ambassador in reverse video
-           . . .
+       <STRONG>-V</STRONG>       reports the version of <EM>ncurses</EM> associated  with  this  program
+                and exits with a successful status.
 
 
 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
-       <STRONG>/usr/share/terminfo/?/*</STRONG>
-            Compiled terminal description database.
+       <EM>/usr/share/terminfo</EM>
+              compiled terminal description database
+
+
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       <STRONG>toe</STRONG>  is  not provided by other implementations.  There is no applicable
+       X/Open or POSIX standard for it.
 
 
 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
-       This  utility  is  not  provided by other implementations.  There is no
-       relevant X/Open or POSIX standard for <STRONG>toe</STRONG>.
+       <STRONG>toe</STRONG> replaces a <STRONG>-T</STRONG> option that was  briefly  supported  by  the  <EM>ncurses</EM>
+       <STRONG>infocmp</STRONG> utility in 1995.
 
-       The program name refers to a developer's pun:
+       The <STRONG>-a</STRONG> and <STRONG>-s</STRONG> options were added in 2006 and 2011, respectively.
+
+       The program's name originates with a developer's pun:
 
        <STRONG>o</STRONG>   <STRONG>tic</STRONG>,
 
 
        <STRONG>o</STRONG>   <STRONG>toe</STRONG>.
 
-       It replaced a <STRONG>-T</STRONG> option which was  briefly  supported  by  the  ncurses
-       <STRONG>infocmp</STRONG> utility in 1995.
 
-       The  <STRONG>-a</STRONG>  and <STRONG>-s</STRONG> options were added to <STRONG>toe</STRONG> several years later (2006 and
-       2011, respectively).
+</PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
+       When  not  sorting with the <STRONG>-s</STRONG> option, the <STRONG>-a</STRONG> option reports all of the
+       names found in all of the terminal database directories  named  in  the
+       <EM>TERMINFO</EM> and <EM>TERMINFO</EM><STRONG>_</STRONG><EM>DIRS</EM> environment variables.
+
+           xterm-color     generic color xterm
+           xterm-xfree86   xterm terminal emulator (XFree86)
+           xterm-vt220     xterm emulating vt220
+           xterm-256color  xterm with 256 colors
+           xterm-r6        xterm X11R6 version
+           xterm-r5        xterm R5 version
+           xterm-mono      monochrome xterm
+           xterm           xterm terminal emulator (X Window System)
+           vt220           dec vt220
+           vt102           dec vt102
+           vt100           dec vt100 (w/advanced video)
+           vt52            dec vt52
+           ...
+
+       Use  the  <STRONG>-a</STRONG>  and  <STRONG>-s</STRONG>  options  together  to  show  where each terminal
+       description was found.
+
+           --&gt; /etc/terminfo
+           ----&gt; /lib/terminfo
+           ------&gt; /usr/share/terminfo
+
+           --*---: vt100           dec vt100 (w/advanced video)
+           --*---: vt102           dec vt102
+           --*---: vt220           dec vt220
+           --*---: vt52            dec vt52
+           --*---: xterm           xterm terminal emulator (X Window System)
+           --*---: xterm-256color  xterm with 256 colors
+           --*---: xterm-color     generic color xterm
+           --*---: xterm-mono      monochrome xterm
+           --*---: xterm-r5        xterm R5 version
+           --*---: xterm-r6        xterm X11R6 version
+           --*---: xterm-vt220     xterm emulating vt220
+           --*---: xterm-xfree86   xterm terminal emulator (XFree86)
+           ...
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="captoinfo.1m.html">captoinfo(1m)</A></STRONG>,  <STRONG><A HREF="infotocap.1m.html">infotocap(1m)</A></STRONG>,  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  <STRONG>ter-</STRONG>
-       <STRONG><A HREF="terminfo.5.html">minfo(5)</A></STRONG>.
+       <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>,
+       <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 
-       This describes <STRONG>ncurses</STRONG> version 6.2 (patch 20200613).
 
 
-
-                                                                       <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
+ncurses 6.4                       2024-03-16                           <STRONG><A HREF="toe.1m.html">toe(1m)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 <li><a href="#h2-NAME">NAME</a></li>
 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
+<li><a href="#h2-OPTIONS">OPTIONS</a></li>
 <li><a href="#h2-FILES">FILES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 <li><a href="#h2-HISTORY">HISTORY</a></li>
+<li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 </ul>
 </div>