X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Finfocmp.1m;h=a6818944ca1422ac09c9ae9f907be4cede9f242f;hb=67327e4e3b2121f8273fb73ec14ef234ed01231e;hp=5aeab4093c53138287b3c69c6e62ed1142a19c2a;hpb=894a177fd5228cdbe790bd1dc9435bd435c29681;p=ncurses.git diff --git a/man/infocmp.1m b/man/infocmp.1m index 5aeab409..a6818944 100644 --- a/man/infocmp.1m +++ b/man/infocmp.1m @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: infocmp.1m,v 1.96 2023/10/07 21:19:07 tom Exp $ -.TH @INFOCMP@ 1M 2023-10-07 "ncurses 6.4" "User commands" +.\" $Id: infocmp.1m,v 1.104 2023/12/30 21:36:32 tom Exp $ +.TH @INFOCMP@ 1M 2023-12-30 "ncurses 6.4" "User commands" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -46,7 +46,6 @@ .el .IP \(bu 2 .. . -.ds n 5 .ds d @TERMINFO@ .SH NAME \fB@INFOCMP@\fP \- @@ -54,56 +53,58 @@ compare or print out \fIterminfo\fP descriptions .SH SYNOPSIS \fB@INFOCMP@\fP [\fB\-\ 1\ +c\ C\ +d\ D\ +e\ E\ F\ +g\ G\ +i\ I\ K\ -L\ -T\ -U\ -V\ -W\ -c\ -d\ -e\ -g\ -i\ l\ +L\ n\ p\ q\ r\ t\ +T\ u\ +U\ +V\ +W\ x\ \fP] [\fB\-v\fR \fIn\fR] [\fB\-s d\fR| \fBi\fR| \fBl\fR| \fBc\fR] [\fB\-Q\fR \fIn\fR] [\fB\-R \fBsubset\fR] [\fB\-w\fP\ \fIwidth\fP] [\fB\-A\fP\ \fIdirectory\fP] [\fB\-B\fP\ \fIdirectory\fP] - [\fItermname\fP...] + [\fIterminal-type\fP ...] .SH DESCRIPTION \fB@INFOCMP@\fP can be used to compare a binary \fBterminfo\fP entry with other terminfo entries, rewrite a \fBterminfo\fP description to take advantage of the \fBuse=\fP terminfo field, or print out a \fBterminfo\fP description from the binary file (\fBterm\fP) in a variety of formats. -In all cases, the boolean +In all cases, the Boolean fields will be printed first, followed by the numeric fields, followed by the string fields. -.SS Default Options -If no options are specified and zero or one \fItermnames\fP are specified, the +.SS "Default Options" +If no options are specified and zero or one \fIterminal-types\fP are +specified, +the \fB\-I\fP option will be assumed. -If more than one \fItermname\fP is specified, +If more than one \fIterminal-type\fP is specified, the \fB\-d\fP option will be assumed. -.SS Comparison Options [\-d] [\-c] [\-n] +.SS "Comparison Options [\-d] [\-c] [\-n]" \fB@INFOCMP@\fP compares the \fBterminfo\fP description of the first terminal -\fItermname\fP with each of the descriptions given by the entries for the other -terminal's \fItermnames\fP. +\fIterminal-type\fP with each of the descriptions given by the entries +for the other terminal's \fIterminal-types\fP. If a capability is defined for only one of the terminals, the value returned depends on the type of the capability: .bP -\fBF\fP for missing boolean variables +\fBF\fP for missing Boolean variables .bP \fBNULL\fP for missing integer or string variables .PP @@ -138,10 +139,10 @@ Normally only the conventional capabilities are shown. Use the \fB\-x\fP option to add the BSD-compatibility capabilities (names prefixed with \*(``OT\*(''). .IP -If no \fItermnames\fP are given, -\fB@INFOCMP@\fP uses the environment variable \fBTERM\fP -for each of the \fItermnames\fP. -.SS Source Listing Options [\-I] [\-L] [\-C] [\-r] +If no \fIterminal-types\fP are given, +\fB@INFOCMP@\fP uses the environment variable \fITERM\fP +for each of the \fIterminal-types\fP. +.SS "Source Listing Options [\-I] [\-L] [\-C] [\-r]" The \fB\-I\fP, \fB\-L\fP, and \fB\-C\fP options will produce a source listing for each terminal named. .PP @@ -155,8 +156,8 @@ l l . \fB\-K\fP/modifies the \fB\-C\fP option, improving BSD-compatibility. .TE .PP -If no \fItermnames\fP are given, the environment variable \fBTERM\fP will be -used for the terminal name. +If no \fIterminal-types\fP are given, +the environment variable \fITERM\fP will be used for the terminal name. .PP The source produced by the \fB\-C\fP option may be used directly as a \fBtermcap\fP entry, but not all parameterized strings can be changed to @@ -221,14 +222,14 @@ l l l. \fB%p1%?%'x'%>%t%p1%'y'%+%;/%>xy\fP/concept \fB%p2\fP is printed before \fB%p1/%r\fP/hp .TE -.SS Use= Option [\-u] +.SS "Use= Option [\-u]" The \fB\-u\fP option produces a \fBterminfo\fP source description of the first -terminal \fItermname\fP which is relative to the sum of the descriptions given -by the entries for the other terminals \fItermnames\fP. +terminal \fIterminal-type\fP which is relative to the sum of the +descriptions given by the entries for the other \fIterminal-types\fP. It does this by -analyzing the differences between the first \fItermname\fP and the other -\fItermnames\fP and producing a description with \fBuse=\fP fields for the -other terminals. +analyzing the differences between the first \fIterminal-types\fP and the +other \fIterminal-types\fP and producing a description with \fBuse=\fP +fields for the other terminals. In this manner, it is possible to retrofit generic terminfo entries into a terminal's description. Or, if two similar terminals exist, but @@ -238,21 +239,24 @@ will show what can be done to change one description to be relative to the other. .PP A capability will be printed with an at-sign (@) if it no longer exists in the -first \fItermname\fP, but one of the other \fItermname\fP entries contains a -value for it. +first \fIterminal-type\fP, +but one of the other \fIterminal-type\fP entries contains a value for +it. A capability's value will be printed if the value in the first -\fItermname\fP is not found in any of the other \fItermname\fP entries, or if -the first of the other \fItermname\fP entries that has this capability gives a -different value for the capability than that in the first \fItermname\fP. +\fIterminal-type\fP is not found in any of the other \fIterminal-type\fP +entries, +or if the first of the other \fIterminal-type\fP entries that has this +capability gives a different value for the capability than that in the +first \fIterminal-type\fP. .PP -The order of the other \fItermname\fP entries is significant. +The order of the other \fIterminal-type\fP entries is significant. Since the terminfo compiler \fB@TIC@\fP does a left-to-right scan of the capabilities, specifying two \fBuse=\fP entries that contain differing entries for the same capabilities will produce different results depending on the order that the entries are given in. \fB@INFOCMP@\fP will flag any such inconsistencies between -the other \fItermname\fP entries as they are found. +the other \fIterminal-type\fP entries as they are found. .PP Alternatively, specifying a capability \fIafter\fP a \fBuse=\fP entry that contains that capability will cause the second specification to be ignored. @@ -263,23 +267,24 @@ description. Another error that does not cause incorrect compiled files, but will slow down the compilation time, is specifying extra \fBuse=\fP fields that are superfluous. -\fB@INFOCMP@\fP will flag any other \fItermname use=\fP fields that +\fB@INFOCMP@\fP will flag any other \fIterminal-type use=\fP fields that were not needed. -.SS Changing Databases [\-A \fIdirectory\fR] [\-B \fIdirectory\fR] -Like other \fBncurses\fP utilities, +.SS "Changing Databases [\-A \fIdirectory\fR] [\-B \fIdirectory\fR]" +Like other \fI\%ncurses\fP utilities, \fB@INFOCMP@\fP looks for the terminal descriptions in several places. -You can use the \fBTERMINFO\fP and \fBTERMINFO_DIRS\fP environment variables -to override the compiled-in default list of places to search. +You can use the \fI\%TERMINFO\fP and \fI\%TERMINFO_DIRS\fP environment +variables to override the compiled-in default list of places to search. See \fBcurses\fP(3X), as well as -the \fIFetching Compiled Descriptions\fP section in \fBterminfo\fR(\*n). +the \fIFetching Compiled Descriptions\fP section in \fBterminfo\fR(5). .PP You can also use the options \fB\-A\fP and \fB\-B\fP to override the list of places to search when comparing terminal descriptions: .bP -The \fB\-A\fP option sets the location for the first \fItermname\fP +The \fB\-A\fP option sets the location for the first \fIterminal-type\fP .bP -The \fB\-B\fP option sets the location for the other \fItermnames\fP. +The \fB\-B\fP option sets the location for the other +\fIterminal-types\fP. .PP Using these options, it is possible to compare descriptions for a terminal with the same name located in two different @@ -287,7 +292,7 @@ databases. For instance, you can use this feature for comparing descriptions for the same terminal created by different people. -.SS Other Options +.SS "Other Options" .TP 5 \fB\-0\fP causes the fields to be printed on one line, without wrapping. @@ -316,9 +321,10 @@ for a given terminal type. The tables are all declared static, and are named according to the type and the name of the corresponding terminal entry. .sp -Before ncurses 5.0, the split between the \fB\-e\fP and \fB\-E\fP -options was not needed; but support for extended names required making -the arrays of terminal capabilities separate from the TERMTYPE structure. +Before \fI\%ncurses\fP 5.0, +the split between the \fB\-e\fP and \fB\-E\fP options was not needed; +but support for extended names required making the arrays of terminal +capabilities separate from the TERMTYPE structure. .TP 5 \fB\-e\fP Dump the capabilities of the given terminal as a C initializer for a @@ -449,7 +455,7 @@ hexadecimal and base64 .RE .IP For example, this prints the compiled terminfo value as a string -which could be assigned to the \fBTERMINFO\fP environment variable: +which could be assigned to the \fI\%TERMINFO\fP environment variable: .PP .RS 9 .EX @@ -480,7 +486,7 @@ that have their own extensions incompatible with SVr4/XSI. .bP Available terminfo subsets are \*(``SVr1\*('', \*(``Ultrix\*('', \*(``HP\*('', and \*(``AIX\*(''; -see \fBterminfo\fP(\*n) for details. +see \fBterminfo\fP(5) for details. .bP You can also choose the subset \*(``BSD\*('' which selects only capabilities with termcap equivalents recognized by 4.4BSD. @@ -546,14 +552,16 @@ since it excludes the inferences that \fB@INFOCMP@\fP makes to fill in missing data. .TP 5 \fB\-V\fP -reports the version of ncurses which was used in this program, and exits. +reports the version of \fI\%ncurses\fP which was used in this program, +and exits. .TP 5 \fB\-v\fP \fIn\fP prints out tracing information on standard error as the program runs. .IP The optional parameter \fIn\fP is a number from 1 to 10, inclusive, indicating the desired level of detail of information. -If ncurses is built without tracing support, the optional parameter is ignored. +If \fI\%ncurses\fP is built without tracing support, +the optional parameter is ignored. .TP \fB\-W\fP By itself, the \fB\-w\fP option will not force long strings to be wrapped. @@ -563,41 +571,13 @@ Use the \fB\-W\fP option to do this. changes the output to \fIwidth\fP characters. .TP \fB\-x\fP -print information for user-defined capabilities (see \fBuser_caps(\*n)\fP. +print information for user-defined capabilities (see \fBuser_caps\fP(5). These are extensions to the terminfo repertoire which can be loaded using the \fB\-x\fP option of \fB@TIC@\fP. .SH FILES -.TP 20 -\*d -Compiled terminal description database. -.SH HISTORY -Although System V Release 2 provided a terminfo library, -it had no documented tool for decompiling the terminal descriptions. -Tony Hansen (AT&T) wrote the first \fBinfocmp\fP in early 1984, -for System V Release 3. -.PP -Eric Raymond used the AT&T documentation in 1995 to provide an equivalent -\fB@INFOCMP@\fP for ncurses. -In addition, he added a few new features such as: -.bP -the \fB\-e\fP option, to support \fIfallback\fP -(compiled-in) terminal descriptions -.bP -the \fB\-i\fP option, to help with analysis -.PP -Later, Thomas Dickey added the \fB\-x\fP (user-defined capabilities) -option, and the \fB\-E\fP option to support fallback entries with -user-defined capabilities. -.PP -For a complete list, see the \fIEXTENSIONS\fP section. -.PP -In 2010, Roy Marples provided an \fBinfocmp\fP program for NetBSD. -It is less capable than the SVr4 or ncurses versions -(e.g., it lacks the sorting options documented in X/Open), -but does include the \fB\-x\fP option adapted from ncurses. -.SH PORTABILITY -X/Open Curses, Issue 7 (2009) provides a description of \fBinfocmp\fP. -It does not mention the options used for converting to termcap format. +.TP +.I \*d +compiled terminal description database .SH EXTENSIONS The \fB\-0\fP, @@ -631,20 +611,49 @@ is System V Release 4's. Actual BSD curses versions will have a more restricted set. To see only the 4.4BSD set, use \fB\-r\fP \fB\-RBSD\fP. +.SH PORTABILITY +X/Open Curses, Issue 7 (2009) provides a description of \fBinfocmp\fP. +It does not mention the options used for converting to termcap format. +.SH HISTORY +Although System V Release 2 provided a terminfo library, +it had no documented tool for decompiling the terminal descriptions. +Tony Hansen (AT&T) wrote the first \fBinfocmp\fP in early 1984, +for System V Release 3. +.PP +Eric Raymond used the AT&T documentation in 1995 to provide an equivalent +\fB@INFOCMP@\fP for \fI\%ncurses\fP. +In addition, he added a few new features such as: +.bP +the \fB\-e\fP option, to support \fIfallback\fP +(compiled-in) terminal descriptions +.bP +the \fB\-i\fP option, to help with analysis +.PP +Later, Thomas Dickey added the \fB\-x\fP (user-defined capabilities) +option, and the \fB\-E\fP option to support fallback entries with +user-defined capabilities. +.PP +For a complete list, see the \fIEXTENSIONS\fP section. +.PP +In 2010, Roy Marples provided an \fBinfocmp\fP program for NetBSD. +It is less capable than the SVr4 or \fI\%ncurses\fP versions +(e.g., it lacks the sorting options documented in X/Open), +but does include the \fB\-x\fP option adapted from \fI\%ncurses\fP. .SH BUGS -The \fB\-F\fP option of \fB@INFOCMP@\fP(1M) should be a \fB@TOE@\fP(1M) mode. -.SH AUTHOR +The \fB\-F\fP option of \fB\%@INFOCMP@\fP(1M) should be a +\fB\%@TOE@\fP(1M) mode. +.SH AUTHORS Eric S. Raymond and .br -Thomas E. Dickey +Thomas E. Dickey .SH SEE ALSO \fB\%@CAPTOINFO@\fP(1M), \fB\%@INFOTOCAP@\fP(1M), \fB\%@TIC@\fP(1M), \fB\%@TOE@\fP(1M), \fB\%curses\fP(3X), -\fB\%terminfo\fP(\*n), -\fB\%user_caps\fP(\*n) +\fB\%terminfo\fP(5), +\fB\%user_caps\fP(5) .PP -https://invisible-island.net/ncurses/tctest.html +https://invisible\-island.net/ncurses/tctest.html