X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Ftoe.1m.html;h=bb79ece55d6b204cda192b195f155c9773babbde;hp=30836a422f6f3d7eb628755bcf9e246bd70820bf;hb=HEAD;hpb=14d46fadc442db9df4567357cda396235418120e diff --git a/doc/html/man/toe.1m.html b/doc/html/man/toe.1m.html index 30836a42..c3aca2c5 100644 --- a/doc/html/man/toe.1m.html +++ b/doc/html/man/toe.1m.html @@ -1,6 +1,7 @@ - -toe 1m +toe 1m 2024-04-20 ncurses 6.5 User commands - + -

toe 1m

toe 1m 2024-04-20 ncurses 6.5 User commands

-toe(1m)                                                                toe(1m)
+toe(1m)                          User commands                         toe(1m)

NAME

-       toe - table of (terminfo) entries
+       toe - list table of entries of terminfo terminal types

SYNOPSIS

-       toe [-v[n]] [-ahsuUV] file...
+       toe [-ahs] [-v [n]] [directory ...]
+
+       toe [-u|-U] file
+
+       toe -V

DESCRIPTION

-       With no options, toe 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 -h option, a directory header
-       will be issued as each directory is entered.
+       toe  reports  to  the  standard  output  stream the (primary) names and
+       descriptions of the terminal types available to the  terminfo  library.
+       Each  directory  is  scanned;  if none are given, toe scans the default
+       terminfo directory.
 
-       There are other options intended for use by terminfo file maintainers:
 
-       -a     report  on  all  of  the  terminal databases which ncurses would
-              search, rather than only the first one that it finds.
+

OPTIONS

+       The -h option can be helpful  to  observe  where  toe  is  looking  for
+       terminal  descriptions.   Other options support maintainers of terminfo
+       terminal descriptions.
 
-              If the -s is also given, toe adds a column to the report,  show-
-              ing  (like  conflict(1))  which  entries which belong to a given
-              terminal database.  An "*" marks entries which differ,  and  "+"
-              marks equivalent entries.
+       -a       lists entries from  all  terminal  database  directories  that
+                terminfo  would  search,  instead  of  only  the first that it
+                finds.
 
-              Without  the -s option, toe does not attempt to merge duplicates
-              in its report
+                If  -s  is  also  given,  toe   additionally   reports,   like
+                conflict(1),  which  entries  correspond  to  a given terminal
+                database.  An "*" marks entries that  differ,  and  "+"  marks
+                equivalent entries.
 
-       -s     sort the output by the entry names.
+                Without   the  -s  option,  toe  does  not  attempt  to  merge
+                duplicates in its report.
 
-       -u file
-              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
+       -h       writes a heading naming each each directory as it is accessed.
 
-       -U file
-              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.
+       -s       sorts the output by the entry names.
 
-       -vn    specifies that (verbose) output be written  to  standard  error,
-              showing toe's progress.
+       -u file  lists terminal type dependencies in  file,  a  terminfo  entry
+                source  or  termcap  database file.  The report summarizes the
+                "use"  (terminfo)  and  tc  (termcap)  relations:  each   line
+                comprises the primary name of a terminal type employing use/tc
+                capabilities, a colon, a  space-  and  tab-separated  list  of
+                primary names of terminal types thus named, and a newline.
 
-              The  optional  parameter n is a number from 1 to 10, interpreted
-              as for tic(1m).  If ncurses is built  without  tracing  support,
-              the optional parameter is ignored.
+       -U file  lists  terminal  type reverse dependencies in file, a terminfo
+                entry source or termcap database file.  The report  summarizes
+                the  "use" (terminfo) and tc (termcap) reverse relations: each
+                line comprises the primary name of a terminal  type  occurring
+                in  use/tc  capabilities,  a colon, a space- and tab-separated
+                list of primary names of terminal types naming them thus,  and
+                a newline.
 
-       -V     reports  the  version of ncurses which was used in this program,
-              and exits.
+       -v [n]   reports  verbose  status  information  to  the  standard error
+                stream, showing toe's progress.
 
+                The optional parameter n  is  an  integer  between  1  and  10
+                inclusive,  interpreted  as  for tic(1m).  If ncurses is built
+                without tracing support, n is ignored.
 
-

EXAMPLES

-       Without sorting, the -a option reports all of the names found in all of
-       the terminal databases found by the TERMINFO and TERMINFO_DIRS 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 -a and -s options together to show where each terminal descrip-
-       tion was found:
-
-           --> /usr/local/ncurses/share/terminfo
-           ----> /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
-           . . .
+       -V       reports the version of ncurses associated  with  this  program
+                and exits with a successful status.

FILES

-       /usr/share/terminfo/?/*
-            Compiled terminal description database.
+       /usr/share/terminfo
+              compiled terminal description database
+
+
+

PORTABILITY

+       toe  is  not provided by other implementations.  There is no applicable
+       X/Open or POSIX standard for it.

HISTORY

-       This  utility  is  not  provided by other implementations.  There is no
-       relevant X/Open or POSIX standard for toe.
+       toe replaces a -T option that was  briefly  supported  by  the  ncurses
+       infocmp utility in 1995.
 
-       The program name refers to a developer's pun:
+       The -a and -s options were added in 2006 and 2011, respectively.
+
+       The program's name originates with a developer's pun:
 
        o   tic,
 
@@ -160,31 +137,66 @@
 
        o   toe.
 
-       It replaced a -T option which was  briefly  supported  by  the  ncurses
-       infocmp utility in 1995.
 
-       The  -a  and -s options were added to toe several years later (2006 and
-       2011, respectively).
+

EXAMPLES

+       When  not  sorting with the -s option, the -a option reports all of the
+       names found in all of the terminal database directories  named  in  the
+       TERMINFO and TERMINFO_DIRS 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  -a  and  -s  options  together  to  show  where each terminal
+       description was found.
+
+           --> /etc/terminfo
+           ----> /lib/terminfo
+           ------> /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)
+           ...