ncurses 6.4 - patch 20240323

[ncurses.git] / man / infocmp.1m

diff --git a/man/infocmp.1m b/man/infocmp.1m
index 8b6f8c1531afa2f7a2ab18982761e2209d5e6b11..5f92c96dd63b8663c588fd9ff49d0f33443709ae 100644 (file)
--- a/man/infocmp.1m
+++ b/man/infocmp.1m
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 1998-2017,2018 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2017,2018 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -28,17 +28,20 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: infocmp.1m,v 1.99 2023/11/25 17:10:25 tom Exp $
-.TH @INFOCMP@ 1M 2023-11-25 "ncurses 6.4" "User commands"
+.\" $Id: infocmp.1m,v 1.109 2024/03/16 15:35:01 tom Exp $
+.TH @INFOCMP@ 1M 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"

 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq

+.ds '  \(aq

 .\}
 .el \{\
 .ie t .ds `` ``
 .el   .ds `` ""
 .ie t .ds '' ''
 .el   .ds '' ""
 .\}
 .el \{\
 .ie t .ds `` ``
 .el   .ds `` ""
 .ie t .ds '' ''
 .el   .ds '' ""

+.ie t .ds '  \(aq
+.el   .ds '  '

 .\}
 .
 .de bP
 .\}
 .
 .de bP


@@ -87,24 +90,24 @@ x\
 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.
 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.
 fields will be printed first, followed by the numeric fields, followed by the
 string fields.

-.SS Default Options
+.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 \fIterminal-type\fP is specified,
 the \fB\-d\fP option will be assumed.
 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 \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
 \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
 \fB@INFOCMP@\fP compares the \fBterminfo\fP description of the first terminal
 \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
 .bP
 \fBNULL\fP for missing integer or string variables
 .PP


@@ -140,24 +143,24 @@ Use the \fB\-x\fP option to add the BSD-compatibility
 capabilities (names prefixed with \*(``OT\*('').
 .IP
 If no \fIterminal-types\fP are given,
 capabilities (names prefixed with \*(``OT\*('').
 .IP
 If no \fIterminal-types\fP are given,

-\fB@INFOCMP@\fP uses the environment variable \fBTERM\fP
+\fB@INFOCMP@\fP uses the environment variable \fITERM\fP

 for each of the \fIterminal-types\fP.
 for each of the \fIterminal-types\fP.

-.SS Source Listing Options [\-I] [\-L] [\-C] [\-r]
+.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
 .TS
 The \fB\-I\fP, \fB\-L\fP, and \fB\-C\fP options will produce
 a source listing for each terminal named.
 .PP
 .TS

-center tab(/) ;
-l l .
-\fB\-I\fP/use the \fBterminfo\fP names
-\fB\-L\fP/use the long C variable name listed in <\fBterm.h\fP>
-\fB\-C\fP/use the \fBtermcap\fP names
-\fB\-r\fP/when using \fB\-C\fP, put out all capabilities in \fBtermcap\fP form
-\fB\-K\fP/modifies the \fB\-C\fP option, improving BSD-compatibility.
+center;
+Lb L.
+\-I    use \fIterminfo\fP capability codes
+\-L    use \*(``long\*('' capability names
+\-C    use \fItermcap\fP capability codes
+\-r    with \fB\-C\fP, include nonstandard capabilities
+\-K    with \fB\-C\fP, improve BSD compatibility

 .TE
 .PP
 If no \fIterminal-types\fP are given,
 .TE
 .PP
 If no \fIterminal-types\fP are given,

-the environment variable \fBTERM\fP will be used for the terminal name.
+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
 .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


@@ -210,19 +213,25 @@ Some common \fBterminfo\fP parameter sequences, their \fBtermcap\fP
 equivalents, and some terminal types which commonly have such sequences, are:
 .PP
 .TS
 equivalents, and some terminal types which commonly have such sequences, are:
 .PP
 .TS

-center tab(/) ;
-l c l
-l l l.
-\fBterminfo/termcap\fP/Representative Terminals
-=
-\fB%p1%c/%.\fP/adm
-\fB%p1%d/%d\fP/hp, ANSI standard, vt100
-\fB%p1%'x'%+%c/%+x\fP/concept
-\fB%i/%i\fPq/ANSI standard, vt100
-\fB%p1%?%'x'%>%t%p1%'y'%+%;/%>xy\fP/concept
-\fB%p2\fP is printed before \fB%p1/%r\fP/hp
+center;
+Lf(BI) Lf(BI) L
+Lb     Lb     L.
+terminfo       termcap Terminal Types
+_
+.\" ansi-m cup (adm3a has other stuff in between, more like concept)
+%p1%c  %.      ansi\-m
+.\" ansi cub, vt100 cub
+%p1%d  %d      ansi, vt100
+.\" vt52 cup (via vt52-basic)
+%p1%\*' \*'%+%c        %+x     vt52
+.\" ansi cup, vt100 cup
+%i     %iq     ansi, vt100
+.\" annarbor4080 cup
+%p1%?%\*'x\*'%>%t%p1%\*'y\*'%+%;       %>xy    annarbor4080
+.\" hpgeneric cup
+%p2\fR\|.\|.\|.\|\fP%p1        %r      hpgeneric

 .TE
 .TE

-.SS Use= Option [\-u]
+.SS "Use= Option [\-u]"

 The \fB\-u\fP option produces a \fBterminfo\fP source description of the first
 terminal \fIterminal-type\fP which is relative to the sum of the
 descriptions given by the entries for the other \fIterminal-types\fP.
 The \fB\-u\fP option produces a \fBterminfo\fP source description of the first
 terminal \fIterminal-type\fP which is relative to the sum of the
 descriptions given by the entries for the other \fIterminal-types\fP.


@@ -269,11 +278,11 @@ the compilation time, is specifying extra \fBuse=\fP fields that are
 superfluous.
 \fB@INFOCMP@\fP will flag any other \fIterminal-type use=\fP fields that
 were not needed.
 superfluous.
 \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.
 \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(5).
 .PP
 See \fBcurses\fP(3X), as well as
 the \fIFetching Compiled Descriptions\fP section in \fBterminfo\fR(5).
 .PP


@@ -292,7 +301,7 @@ databases.
 For instance,
 you can use this feature for comparing descriptions for the same terminal
 created by different people.
 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.
 .TP 5
 \fB\-0\fP
 causes the fields to be printed on one line, without wrapping.


@@ -321,9 +330,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
 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
 .TP 5
 \fB\-e\fP
 Dump the capabilities of the given terminal as a C initializer for a


@@ -378,44 +388,43 @@ Here is a list of the DEC/ANSI
 special sequences recognized:
 .PP
 .TS
 special sequences recognized:
 .PP
 .TS

-center tab(/) ;
-l l
-l l.
-Action/Meaning
-=
-RIS/full reset
-SC/save cursor
-RC/restore cursor
-LL/home-down
-RSR/reset scroll region
-=
-DECSTR/soft reset (VT320)
-S7C1T/7-bit controls (VT220)
-=
-ISO DEC G0/enable DEC graphics for G0
-ISO UK G0/enable UK chars for G0
-ISO US G0/enable US chars for G0
-ISO DEC G1/enable DEC graphics for G1
-ISO UK G1/enable UK chars for G1
-ISO US G1/enable US chars for G1
-=
-DECPAM/application keypad mode
-DECPNM/normal keypad mode
-DECANSI/enter ANSI mode
-=
-ECMA[+\-]AM/keyboard action mode
-ECMA[+\-]IRM/insert replace mode
-ECMA[+\-]SRM/send receive mode
-ECMA[+\-]LNM/linefeed mode
-=
-DEC[+\-]CKM/application cursor keys
-DEC[+\-]ANM/set VT52 mode
-DEC[+\-]COLM/132-column mode
-DEC[+\-]SCLM/smooth scroll
-DEC[+\-]SCNM/reverse video mode
-DEC[+\-]OM/origin mode
-DEC[+\-]AWM/wraparound mode
-DEC[+\-]ARM/auto-repeat mode
+center;
+L L.
+Action Meaning
+_
+RIS    full reset
+SC     save cursor
+RC     restore cursor
+LL     home-down
+RSR    reset scroll region
+_
+DECSTR soft reset (VT320)
+S7C1T  7-bit controls (VT220)
+_
+ISO DEC G0     enable DEC graphics for G0
+ISO UK G0      enable UK chars for G0
+ISO US G0      enable US chars for G0
+ISO DEC G1     enable DEC graphics for G1
+ISO UK G1      enable UK chars for G1
+ISO US G1      enable US chars for G1
+_
+DECPAM application keypad mode
+DECPNM normal keypad mode
+DECANSI        enter ANSI mode
+_
+ECMA[+\-]AM    keyboard action mode
+ECMA[+\-]IRM   insert replace mode
+ECMA[+\-]SRM   send receive mode
+ECMA[+\-]LNM   linefeed mode
+_
+DEC[+\-]CKM    application cursor keys
+DEC[+\-]ANM    set VT52 mode
+DEC[+\-]COLM   132-column mode
+DEC[+\-]SCLM   smooth scroll
+DEC[+\-]SCNM   reverse video mode
+DEC[+\-]OM     origin mode
+DEC[+\-]AWM    wraparound mode
+DEC[+\-]ARM    auto-repeat mode

 .TE
 .sp
 It also recognizes a SGR action corresponding to ANSI/ISO 6429/ECMA Set
 .TE
 .sp
 It also recognizes a SGR action corresponding to ANSI/ISO 6429/ECMA Set


@@ -454,7 +463,7 @@ hexadecimal and base64
 .RE
 .IP
 For example, this prints the compiled terminfo value as a string
 .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
 .PP
 .RS 9
 .EX


@@ -551,14 +560,16 @@ since it excludes the inferences that \fB@INFOCMP@\fP makes to fill in missing
 data.
 .TP 5
 \fB\-V\fP
 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.
 .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.
 .TP
 \fB\-W\fP
 By itself, the \fB\-w\fP option will not force long strings to be wrapped.


@@ -618,7 +629,7 @@ 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
 for System V Release 3.
 .PP
 Eric Raymond used the AT&T documentation in 1995 to provide an equivalent

-\fB@INFOCMP@\fP for ncurses.
+\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
 In addition, he added a few new features such as:
 .bP
 the \fB\-e\fP option, to support \fIfallback\fP


@@ -633,9 +644,9 @@ user-defined capabilities.
 For a complete list, see the \fIEXTENSIONS\fP section.
 .PP
 In 2010, Roy Marples provided an \fBinfocmp\fP program for NetBSD.
 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
+It is less capable than the SVr4 or \fI\%ncurses\fP versions

 (e.g., it lacks the sorting options documented in X/Open),
 (e.g., it lacks the sorting options documented in X/Open),

-but does include the \fB\-x\fP option adapted from ncurses.
+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 BUGS
 The \fB\-F\fP option of \fB\%@INFOCMP@\fP(1M) should be a
 \fB\%@TOE@\fP(1M) mode.