X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Ftoe.1m;h=44d5cdda675e1f3f19a5e7b1d658186f4247bc7b;hp=3213d473a6a7fbbd4fb6b39e1737907768a63e59;hb=HEAD;hpb=74433bcf4f6fe40862a28f3c00edaedcd5054b01 diff --git a/man/toe.1m b/man/toe.1m index 3213d473..891570e4 100644 --- a/man/toe.1m +++ b/man/toe.1m @@ -1,5 +1,6 @@ +'\" t .\"*************************************************************************** -.\" Copyright 2019-2020,2021 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 * @@ -27,168 +28,214 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: toe.1m,v 1.35 2021/12/25 17:39:16 tom Exp $ -.TH @TOE@ 1M "" +.\" $Id: toe.1m,v 1.69 2024/05/11 20:39:53 tom Exp $ +.TH @TOE@ 1M 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +.ie n .ds CW R +.el \{ +.ie \n(.g .ds CW CR +.el .ds CW CW +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 .. -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' -.de NS -.ie n .sp -.el .sp .5 -.ie n .in +4 -.el .in +2 -.nf -.ft C \" Courier -.. -.de NE -.fi -.ft R -.ie n .in -4 -.el .in -2 -.. -.ds n 5 -.ds d @TERMINFO@ .SH NAME -\fB@TOE@\fP \- table of (terminfo) entries +\fB\%@TOE@\fP \- +list table of entries of \fIterminfo\fR terminal types .SH SYNOPSIS -\fB@TOE@\fP [\fB\-v\fP[\fIn\fP]] [\fB\-ahsuUV\fP] \fIfile...\fP -.br -.SH DESCRIPTION +.B @TOE@ +.RB [ \-ahs ] +.RB [ \-v\ \c +.RI [ n ]] +.RI [ directory +\&.\|.\|.] .PP -With no options, -\fB@TOE@\fP 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 directory is scanned. -If you also specify the \fB\-h\fP option, -a directory header will be issued as each -directory is entered. +.B @TOE@ +.RB [ \-u | \-U ] +.I file .PP -There are other options intended for use by terminfo file maintainers: -.TP -\fB\-a\fP -report on all of the terminal databases which ncurses would search, -rather than only the first one that it finds. +.B "@TOE@ \-V" +.SH DESCRIPTION +\fB\%@TOE@\fP reports to the standard output stream the (primary) names +and descriptions of the terminal types available to the \fIterminfo\fP +library. +Each \fIdirectory\fP is scanned; +if none are given, +\fB\%@TOE@\fP scans the default \fIterminfo\fP directory. +.SH OPTIONS +The \fB\-h\fP option can be helpful to observe where \fB\%@TOE@\fP is +looking for terminal descriptions. +Other options support maintainers of \fIterminfo\fP terminal +descriptions. +.TP 9 \" "-u file" + 2n +.B \-a +lists entries from all terminal database directories that \fIterminfo\fP +would search, +instead of only the first that it finds. .IP -If the \fB\-s\fP is also given, \fB@TOE@\fP -adds a column to the report, -showing (like \fBconflict\fP(1)) which entries which -belong to a given terminal database. -An "*" marks entries which differ, and "+" marks equivalent entries. +If +.B \-s +is also given, +\fB\%@TOE@\fP +additionally reports, +like \fI\%conflict\fP(1), +which entries correspond to a given terminal database. +An \*(``*\*('' marks entries that differ, +and \*(``+\*('' marks equivalent entries. .IP -Without the \fB\-s\fP option, \fB@TOE@\fP does not attempt to merge -duplicates in its report +Without the \fB\-s\fP option, +\fB\%@TOE@\fP does not attempt to merge duplicates in its report. +.TP +.B \-h +writes a heading naming each each directory as it is accessed. .TP -\fB\-s\fP -sort the output by the entry names. +.B \-s +sorts the output by the entry names. .TP -\fB\-u\fP \fIfile\fP -says to write a report to the standard output, -listing dependencies in the given terminfo/termcap source file. -The report condenses 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 +.BI \-u\ file +lists terminal type dependencies in \fIfile\fP, +a \fIterminfo\fP entry source or \fItermcap\fP database file. +The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and +\fBtc\fP (\fItermcap\fP) relations: +each line comprises the primary name of a terminal type employing +\fBuse\fP/\fBtc\fP capabilities, +a colon, +a space- and tab-separated list of primary names of terminal types thus +named, +and a newline. .TP -\fB\-U\fP \fIfile\fP -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, -followed by a colon, -followed by the -whitespace-separated primary names of all terminals which depend on it, -followed by a newline. +.BI \-U\ file +lists terminal type reverse dependencies in \fIfile\fP, +a \fIterminfo\fP entry source or \fItermcap\fP database file. +The report summarizes the \*(``\fBuse\fP\*('' (\fIterminfo\fP) and +\fBtc\fP (\fItermcap\fP) reverse relations: +each line comprises the primary name of a terminal type occurring in +\fBuse\fP/\fBtc\fP capabilities, +a colon, +a space- and tab-separated list of primary names of terminal types +naming them thus, +and a newline. .TP -\fB\-v\fP\fIn\fP -specifies that (verbose) output be written to standard error, -showing \fB@TOE@\fP's progress. +.BR \-v\ [\c +.IR n ] +reports verbose status information to the standard error stream, +showing \fB\%@TOE@\fP's progress. .IP -The optional parameter \fIn\fP is a number from 1 to 10, -interpreted as for \fB@TIC@\fP(1M). -If ncurses is built without tracing support, the optional parameter is ignored. +The optional parameter \fIn\fP is an integer between 1 and 10 inclusive, +interpreted as for \fB\%@TIC@\fP(1M). +If \fI\%ncurses\fP is built without tracing support, +\fIn\fP is ignored. .TP \fB\-V\fP -reports the version of ncurses which was used in this program, -and exits. -.SH EXAMPLES -.PP -Without sorting, the \fB\-a\fP option reports all of the names found -in all of the terminal databases found by the \fBTERMINFO\fP and -\fBTERMINFO_DIRS\fP environment variables: -.NS -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 -\&.\ .\ . -.NE -.PP -Use the \fB\-a\fP and \fB\-s\fP options together to show where each terminal -description was found: -.NS ---> /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 -\&.\ .\ . -.NE +reports the version of \fI\%ncurses\fP associated +with this program and exits with a successful status. .SH FILES -.TP 5 -\fB\*d/?/*\fP -Compiled terminal description database. +.TP +.I @TERMINFO@ +compiled terminal description database +.SH PORTABILITY +\fB\%@TOE@\fP is not provided by other implementations. +There is no applicable X/Open or POSIX standard for it. .SH HISTORY -This utility is not provided by other implementations. -There is no relevant X/Open or POSIX standard for \fB@TOE@\fP. +\fB\%@TOE@\fP replaces a \fB\-T\fP option that was briefly supported by +the \fI\%ncurses\fP \fB\%infocmp\fP utility in 1995. +.PP +The \fB\-a\fP and \fB\-s\fP options were added in 2006 and 2011, +respectively. .PP -The program name refers to a developer's pun: +The program's name originates with a developer's pun: .bP \fBtic\fP, .bP \fBtac\fP (now \fBtack\fP), .bP \fBtoe\fP. +.SH EXAMPLES +When not sorting with the \fB\-s\fP option, +the \fB\-a\fP option reports all of the names found in all of the +terminal database directories named in the \fI\%TERMINFO\fP and +\fI\%TERMINFO_DIRS\fP environment variables. +.RS 4 .PP -It replaced a \fB\-T\fP option which was briefly supported by -the ncurses \fBinfocmp\fP utility in 1995. +.\" toe -a | grep -E '^(xterm|vt)' +.ft \*(CW +.TS +L2 Lx. +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 T{ +.ad l +xterm terminal emulator (X Window System) +T} +vt220 dec vt220 +vt102 dec vt102 +vt100 dec vt100 (w/advanced video) +vt52 dec vt52 +.T& +L. +\&.\|.\|. +.TE +.ft +.RE .PP -The \fB\-a\fP and \fB\-s\fP options were added to -\fB@TOE@\fP several years later (2006 and 2011, respectively). -.SH SEE ALSO -\fB@CAPTOINFO@\fP(1M), -\fB@INFOCMP@\fP(1M), -\fB@INFOTOCAP@\fP(1M), -\fB@TIC@\fP(1M), -\fBcurses\fP(3X), -\fBterminfo\fP(\*n). +Use the \fB\-a\fP and \fB\-s\fP options together to show where each +terminal description was found. +.RS 4 .PP -This describes \fBncurses\fP -version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). +.\" toe -as | grep -E '(^-+>|:.(xterm|vt))' +.ft \*(CW +.TS +Lx. +\-\-> /etc/terminfo +\-\-\-\-> /lib/terminfo +\-\-\-\-\-\-> /usr/share/terminfo +.TE +.TS +L1 L2 Lx. +\-\-*\-\-\-: vt100 dec vt100 (w/advanced video) +\-\-*\-\-\-: vt102 dec vt102 +\-\-*\-\-\-: vt220 dec vt220 +\-\-*\-\-\-: vt52 dec vt52 +\-\-*\-\-\-: xterm T{ +.ad l +xterm terminal emulator (X Window System) +T} +\-\-*\-\-\-: 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 T{ +.ad l +xterm terminal emulator (XFree86) +T} +.T& +L. +\&.\|.\|. +.TE +.ft +.RE +.SH SEE ALSO +\fB\%@CAPTOINFO@\fP(1M), +\fB\%@INFOCMP@\fP(1M), +\fB\%@INFOTOCAP@\fP(1M), +\fB\%@TIC@\fP(1M), +\fB\%curses\fP(3X), +\fB\%terminfo\fP(5)