infocmp - compare or print out terminfo descriptions
[-v n] [-s d| i| l| c] [-R subset]
[-w width] [-A directory] [-B directory]
infocmp can be used to compare a binary terminfo entry with other terminfo entries, rewrite a terminfo description to take advantage of the use= terminfo field, or print out a terminfo description from the binary file (term) in a variety of formats. In all cases, the boolean fields will be printed first, followed by the numeric fields, followed by the string fields.
If no options are specified and zero or one termnames are specified, the -I option will be assumed. If more than one termname is specified, the -d option will be assumed.
infocmp compares the terminfo description of the first terminal termname with each of the descriptions given by the entries for the other terminal's termnames. If a capability is defined for only one of the terminals, the value returned will depend on the type of the capability: F for boolean variables, -1 for integer variables, and NULL for string variables.
The -d option produces a list of each capability that is different between two entries. This option is useful to show the difference between two entries, created by different people, for the same or similar terminals.
The -c option produces a list of each capability that is common between two or more entries. Capabilities that are not set are ignored. This option can be used as a quick check to see if the -u option is worth using.
The -n option produces a list of each capability that is in none of the given entries. If no termnames are given, the environment variable TERM will be used for both of the termnames. This can be used as a quick check to see if anything was left out of a description.
The -I, -L, and -C options will produce a source listing for each terminal named.
|-I||use the terminfo names|
|-L||use the long C variable name listed in <term.h>|
|-C||use the termcap names|
|-r||when using -C, put out all capabilities in termcap form|
|-K||modifies the -C option, improving BSD-compatibility.|
If no termnames are given, the environment variable TERM will be used for the terminal name.
The source produced by the -C option may be used directly as a termcap entry, but not all parameterized strings can be changed to the termcap format. infocmp will attempt to convert most of the parameterized information, and anything not converted will be plainly marked in the output and commented out. These should be edited by hand.
For best results when converting to termcap format, you should use both -C and -r. Normally a termcap description is limited to 1023 bytes. infocmp trims away less essential parts to make it fit. If you are converting to one of the (rare) termcap implementations which accept an unlimited size of termcap, you may want to add the -T option. More often however, you must help the termcap implementation, and trim excess whitespace (use the -0 option for that).
All padding information for strings will be collected together and placed at the beginning of the string where termcap expects it. Mandatory padding (padding information with a trailing '/') will become optional.
All termcap variables no longer supported by terminfo, but which are derivable from other terminfo variables, will be output. Not all terminfo capabilities will be translated; only those variables which were part of termcap will normally be output. Specifying the -r option will take off this restriction, allowing all capabilities to be output in termcap form. Normally you would use both the -C and -r options. The actual format used incorporates some improvements for escaped characters from terminfo format. For a stricter BSD-compatible translation, use the -K option rather than -C.
Note that because padding is collected to the beginning of the capability, not all capabilities are output. Mandatory padding is not supported. Because termcap strings are not as flexible, it is not always possible to convert a terminfo string capability into an equivalent termcap format. A subsequent conversion of the termcap file back into terminfo format will not necessarily reproduce the original terminfo source.
Some common terminfo parameter sequences, their termcap equivalents, and some terminal types which commonly have such sequences, are:
|%p1%d||%d||hp, ANSI standard, vt100|
|%i||%iq||ANSI standard, vt100|
|%p2 is printed before %p1||%r||hp|
The -u option produces a terminfo source description of the first terminal termname which is relative to the sum of the descriptions given by the entries for the other terminals termnames. It does this by analyzing the differences between the first termname and the other termnames and producing a description with use= 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 were coded at different times or by different people so that each description is a full description, using infocmp will show what can be done to change one description to be relative to the other.
A capability will get printed with an at-sign (@) if it no longer exists in the first termname, but one of the other termname entries contains a value for it. A capability's value gets printed if the value in the first termname is not found in any of the other termname entries, or if the first of the other termname entries that has this capability gives a different value for the capability than that in the first termname.
The order of the other termname entries is significant. Since the terminfo compiler tic does a left-to-right scan of the capabilities, specifying two use= entries that contain differing entries for the same capabilities will produce different results depending on the order that the entries are given in. infocmp will flag any such inconsistencies between the other termname entries as they are found.
Alternatively, specifying a capability after a use= entry that contains that capability will cause the second specification to be ignored. Using infocmp to recreate a description can be a useful check to make sure that everything was specified correctly in the original source description.
Another error that does not cause incorrect compiled files, but will slow down the compilation time, is specifying extra use= fields that are superfluous. infocmp will flag any other termname use= fields that were not needed.
Like other ncurses utilities, infocmp looks for the terminal descriptions in several places. You can use the TERMINFO and TERMINFO_DIRS environment variables to override the compiled-in default list of places to search (see curses(3X) for details).
You can also use the options -A and -B to override the list of places to search when comparing terminal descriptions:
Using these options, it is possible to compare descriptions for a terminal with the same name located in two different databases. For instance, you can use this feature for comparing descriptions for the same terminal created by different people.
Before ncurses 5.0, the split between the -e and -E options was not needed; but support for extended names required making the arrays of terminal capabilities separate from the TERMTYPE structure.
|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|
|DEC[+-]CKM||application cursor keys|
|DEC[+-]ANM||set VT52 mode|
|DEC[+-]SCNM||reverse video mode|
It also recognizes a SGR action corresponding to ANSI/ISO 6429/ECMA Set Graphics Rendition, with the values NORMAL, BOLD, UNDERLINE, BLINK, and REVERSE. All but NORMAL may be prefixed with `+' (turn on) or `-' (turn off).
The -0, -1, -E, -F, -G, -R, -T, -V, -a, -e, -f, -g, -i, -l, -p, -q and -t options are not supported in SVr4 curses.
The -r option's notion of `termcap' capabilities is System V Release 4's. Actual BSD curses versions will have a more restricted set. To see only the 4.4BSD set, use -r -RBSD.
The -F option of infocmp(1M) should be a toe(1M) mode.
captoinfo(1M), infotocap(1M), tic(1M), toe(1M), curses(3X), terminfo(5).
This describes ncurses version 5.7 (patch 20081102).
Eric S. Raymond <email@example.com> and
Thomas E. Dickey <firstname.lastname@example.org>