| 1 |
'\" t |
| 2 |
.\"*************************************************************************** |
| 3 |
.\" Copyright 2018-2024,2025 Thomas E. Dickey * |
| 4 |
.\" Copyright 1998-2017,2018 Free Software Foundation, Inc. * |
| 5 |
.\" * |
| 6 |
.\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 7 |
.\" copy of this software and associated documentation files (the * |
| 8 |
.\" "Software"), to deal in the Software without restriction, including * |
| 9 |
.\" without limitation the rights to use, copy, modify, merge, publish, * |
| 10 |
.\" distribute, distribute with modifications, sublicense, and/or sell * |
| 11 |
.\" copies of the Software, and to permit persons to whom the Software is * |
| 12 |
.\" furnished to do so, subject to the following conditions: * |
| 13 |
.\" * |
| 14 |
.\" The above copyright notice and this permission notice shall be included * |
| 15 |
.\" in all copies or substantial portions of the Software. * |
| 16 |
.\" * |
| 17 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 18 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 19 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 20 |
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 21 |
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 22 |
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 23 |
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 24 |
.\" * |
| 25 |
.\" Except as contained in this notice, the name(s) of the above copyright * |
| 26 |
.\" holders shall not be used in advertising or otherwise to promote the * |
| 27 |
.\" sale, use or other dealings in this Software without prior written * |
| 28 |
.\" authorization. * |
| 29 |
.\"*************************************************************************** |
| 30 |
.\" |
| 31 |
.\" $Id: infocmp.1m,v 1.128 2025/11/12 00:52:57 tom Exp $ |
| 32 |
.TH infocmp 1 2025-11-11 "ncurses 6.6" "User commands" |
| 33 |
.ie \n(.g \{\ |
| 34 |
.ds `` \(lq |
| 35 |
.ds '' \(rq |
| 36 |
.ds ' \(aq |
| 37 |
.\} |
| 38 |
.el \{\ |
| 39 |
.ie t .ds `` `` |
| 40 |
.el .ds `` "" |
| 41 |
.ie t .ds '' '' |
| 42 |
.el .ds '' "" |
| 43 |
.ie t .ds ' \(aq |
| 44 |
.el .ds ' ' |
| 45 |
.\} |
| 46 |
. |
| 47 |
.de bP |
| 48 |
.ie n .IP \(bu 4 |
| 49 |
.el .IP \(bu 2 |
| 50 |
.. |
| 51 |
. |
| 52 |
.SH NAME |
| 53 |
\fBinfocmp\fP \- |
| 54 |
compare or print out \fIterminfo\fP descriptions |
| 55 |
.SH SYNOPSIS |
| 56 |
.HP |
| 57 |
.B infocmp |
| 58 |
.RB [ \-\ |
| 59 |
1\ |
| 60 |
c\ |
| 61 |
C\ |
| 62 |
d\ |
| 63 |
D\ |
| 64 |
e\ |
| 65 |
E\ |
| 66 |
F\ |
| 67 |
g\ |
| 68 |
G\ |
| 69 |
i\ |
| 70 |
I\ |
| 71 |
K\ |
| 72 |
l\ |
| 73 |
L\ |
| 74 |
n\ |
| 75 |
p\ |
| 76 |
q\ |
| 77 |
r\ |
| 78 |
t\ |
| 79 |
T\ |
| 80 |
u\ |
| 81 |
U\ |
| 82 |
V\ |
| 83 |
W\ |
| 84 |
x\ |
| 85 |
] |
| 86 |
.RB [ \-A\ \c |
| 87 |
.IR directory ] |
| 88 |
.RB [ \-B\ \c |
| 89 |
.IR directory ] |
| 90 |
.RB [ \-Q\ \c |
| 91 |
.IR encoding ] |
| 92 |
.RB [ \-R\ \c |
| 93 |
.IR subset ] |
| 94 |
.RB [ \-s\ \c |
| 95 |
.IR key ] |
| 96 |
.RB [ \-v\ \c |
| 97 |
.IR level ] |
| 98 |
.RB [ \-w\ \c |
| 99 |
.IR width ] |
| 100 |
.RI [ \%terminal\%-type |
| 101 |
\&.\|.\|.\& ] |
| 102 |
.SH DESCRIPTION |
| 103 |
.B infocmp |
| 104 |
reports a human-readable terminal type description |
| 105 |
from a compiled entry in the |
| 106 |
.I \%term\%info |
| 107 |
database in a variety of selectable formats, |
| 108 |
compares such entries to each other, |
| 109 |
and rewrites an entry to replace |
| 110 |
.RB \*(`` use \*('' |
| 111 |
expressions with the content of other entries by reference. |
| 112 |
A |
| 113 |
.I "\%term\%info entry" |
| 114 |
comprises |
| 115 |
a list of one or more terminal type identifiers, |
| 116 |
a human-readable description of the terminal type, |
| 117 |
and a list of terminal |
| 118 |
.I capabilities |
| 119 |
that characterize its programming interface. |
| 120 |
In all cases, |
| 121 |
the program reports |
| 122 |
Boolean-valued capabilities first, |
| 123 |
followed by numeric ones, |
| 124 |
and then string-valued capabilities. |
| 125 |
.SS "Default Options" |
| 126 |
If no options are specified and zero or one |
| 127 |
.I terminal-types |
| 128 |
is specified, |
| 129 |
.B infocmp |
| 130 |
assumes the |
| 131 |
.B \-I |
| 132 |
option. |
| 133 |
If more than one is specified, |
| 134 |
the program |
| 135 |
assumes the |
| 136 |
.B \-d |
| 137 |
option. |
| 138 |
.SS "Source Listing Options [\-I] [\-L] [\-C] [\-r]" |
| 139 |
The \fB\-I\fP, \fB\-L\fP, and \fB\-C\fP options will produce |
| 140 |
a source listing for each terminal named. |
| 141 |
.PP |
| 142 |
.TS |
| 143 |
center; |
| 144 |
Lb L. |
| 145 |
\-I use \fIterminfo\fP capability codes |
| 146 |
\-L use \*(``long\*('' capability names |
| 147 |
\-C use \fItermcap\fP capability codes |
| 148 |
\-r with \fB\-C\fP, include nonstandard capabilities |
| 149 |
\-K with \fB\-C\fP, improve BSD compatibility |
| 150 |
.TE |
| 151 |
.PP |
| 152 |
If no \fIterminal-types\fP are given, |
| 153 |
the environment variable \fITERM\fP will be used for the terminal name. |
| 154 |
.PP |
| 155 |
The source produced by the \fB\-C\fP option may be used directly as a |
| 156 |
\fBtermcap\fP entry, but not all parameterized strings can be changed to |
| 157 |
the \fBtermcap\fP format. |
| 158 |
\fBinfocmp\fP will attempt to convert most of the |
| 159 |
parameterized information, and anything not converted will be plainly marked in |
| 160 |
the output and commented out. |
| 161 |
These should be edited by hand. |
| 162 |
.PP |
| 163 |
For best results when converting to \fBtermcap\fP format, |
| 164 |
you should use both \fB\-C\fP and \fB\-r\fP. |
| 165 |
Normally a termcap description is limited to 1023 bytes. |
| 166 |
\fBinfocmp\fP trims away less essential parts to make it fit. |
| 167 |
If you are converting to one of the (rare) termcap implementations |
| 168 |
which accept an unlimited size of termcap, |
| 169 |
you may want to add the \fB\-T\fP option. |
| 170 |
More often however, you must help the termcap implementation, |
| 171 |
and trim excess whitespace (use the \fB\-0\fP option for that). |
| 172 |
.PP |
| 173 |
All padding information for strings will be collected together and placed |
| 174 |
at the beginning of the string where \fBtermcap\fP expects it. |
| 175 |
Mandatory |
| 176 |
padding (padding information with a trailing \*(``/\*('') will become optional. |
| 177 |
.PP |
| 178 |
All \fBtermcap\fP variables no longer supported by \fBterminfo\fP, but which |
| 179 |
are derivable from other \fBterminfo\fP variables, will be output. |
| 180 |
Not all |
| 181 |
\fBterminfo\fP capabilities will be translated; only those variables which were |
| 182 |
part of \fBtermcap\fP will normally be output. |
| 183 |
Specifying the \fB\-r\fP option |
| 184 |
will take off this restriction, allowing all capabilities to be output in |
| 185 |
\fItermcap\fP form. |
| 186 |
Normally you would use both the \fB\-C\fP and \fB\-r\fP options. |
| 187 |
The actual format used incorporates some improvements for escaped characters |
| 188 |
from terminfo format. |
| 189 |
For a stricter BSD-compatible translation, use the \fB\-K\fP option |
| 190 |
rather than \fB\-C\fP. |
| 191 |
.PP |
| 192 |
Note that because padding is collected to the beginning of the capability, not |
| 193 |
all capabilities are output. |
| 194 |
Mandatory padding is not supported. |
| 195 |
Because |
| 196 |
\fBtermcap\fP strings are not as flexible, it is not always possible to convert |
| 197 |
a \fBterminfo\fP string capability into an equivalent \fBtermcap\fP format. |
| 198 |
A subsequent conversion of the \fBtermcap\fP file |
| 199 |
back into \fBterminfo\fP format |
| 200 |
will not necessarily reproduce the original \fBterminfo\fP source. |
| 201 |
.PP |
| 202 |
Some common \fBterminfo\fP parameter sequences, their \fBtermcap\fP |
| 203 |
equivalents, and some terminal types which commonly have such sequences, are: |
| 204 |
.PP |
| 205 |
.TS |
| 206 |
center; |
| 207 |
Lf(BI) Lf(BI) L |
| 208 |
Lb Lb L. |
| 209 |
terminfo termcap Terminal Types |
| 210 |
_ |
| 211 |
.\" ansi-m cup (adm3a has other stuff in between, more like concept) |
| 212 |
%p1%c %. ansi\-m |
| 213 |
.\" ansi cub, vt100 cub |
| 214 |
%p1%d %d ansi, vt100 |
| 215 |
.\" vt52 cup (via vt52-basic) |
| 216 |
%p1%\*' \*'%+%c %+x vt52 |
| 217 |
.\" ansi cup, vt100 cup |
| 218 |
%i %iq ansi, vt100 |
| 219 |
.\" annarbor4080 cup |
| 220 |
%p1%?%\*'x\*'%>%t%p1%\*'y\*'%+%; %>xy annarbor4080 |
| 221 |
.\" hpgeneric cup |
| 222 |
%p2\fR\|.\|.\|.\|\fP%p1 %r hpgeneric |
| 223 |
.TE |
| 224 |
.SS "Entry Comparison Options [-d] [-c] [-n]" |
| 225 |
Given |
| 226 |
.BR \-c , |
| 227 |
.BR \-d , |
| 228 |
or |
| 229 |
.BR \-n , |
| 230 |
.B infocmp |
| 231 |
compares the |
| 232 |
.I \%term\%info |
| 233 |
description of the first specified |
| 234 |
.I terminal-type |
| 235 |
with those of each of the subsequent operands. |
| 236 |
If fewer |
| 237 |
.I terminal-types |
| 238 |
than required are specified, |
| 239 |
.B infocmp |
| 240 |
uses the environment variable |
| 241 |
.I TERM |
| 242 |
in their place. |
| 243 |
.PP |
| 244 |
If a capability is defined for only one terminal type, |
| 245 |
the value reported depends on the capability's type: |
| 246 |
.bP |
| 247 |
.B F |
| 248 |
for missing Boolean variables |
| 249 |
.bP |
| 250 |
.B NULL |
| 251 |
for missing integer or string variables |
| 252 |
.PP |
| 253 |
The |
| 254 |
.B \-c |
| 255 |
and |
| 256 |
.B \-d |
| 257 |
options report string capability values |
| 258 |
between \*(``\*'\*('' characters. |
| 259 |
Use the |
| 260 |
.B \-q |
| 261 |
option to distinguish |
| 262 |
.I absent |
| 263 |
and |
| 264 |
.I canceled |
| 265 |
capabilities; |
| 266 |
see \fB\%terminfo\fP(5). |
| 267 |
.PP |
| 268 |
The comparison option selects the form of report. |
| 269 |
.TP 5 |
| 270 |
.B \-d |
| 271 |
lists each capability that |
| 272 |
.I differs |
| 273 |
between two entries. |
| 274 |
Each capability name is followed by \*(``:\*('' |
| 275 |
and comma-separated capability values, |
| 276 |
then a period. |
| 277 |
.TP |
| 278 |
.B \-c |
| 279 |
lists each capability that two entries have in |
| 280 |
.IR common "." |
| 281 |
.B infocmp |
| 282 |
ignores capabilities missing from either entry. |
| 283 |
Each capability name is followed by \*(``=\*('', |
| 284 |
a space, |
| 285 |
and the capability value, |
| 286 |
then a period. |
| 287 |
.IP |
| 288 |
If the |
| 289 |
.B \-u |
| 290 |
option is further specified, |
| 291 |
.B infocmp |
| 292 |
rewrites the description of the first type |
| 293 |
employing \*(``use=\*('' syntax |
| 294 |
to use the second as a building block. |
| 295 |
.TP |
| 296 |
.B \-n |
| 297 |
lists capabilities that are in |
| 298 |
.I none |
| 299 |
of the given entries. |
| 300 |
Each capability name is preceded by \*(``!\*('' |
| 301 |
and followed by a period. |
| 302 |
.IP |
| 303 |
Normally only conventional capabilities are shown. |
| 304 |
Use the |
| 305 |
.B \-x |
| 306 |
option to add BSD-compatibility capabilities |
| 307 |
(names prefixed with \*(``OT\*(''). |
| 308 |
.SS "Use= Option [\-u]" |
| 309 |
The \fB\-u\fP option produces a \fBterminfo\fP source description of the first |
| 310 |
terminal \fIterminal-type\fP which is relative to the sum of the |
| 311 |
descriptions given by the entries for the other \fIterminal-types\fP. |
| 312 |
It does this by |
| 313 |
analyzing the differences between the first \fIterminal-types\fP and the |
| 314 |
other \fIterminal-types\fP and producing a description with \fBuse=\fP |
| 315 |
fields for the other terminals. |
| 316 |
In this manner, it is possible to retrofit generic terminfo |
| 317 |
entries into a terminal's description. |
| 318 |
Or, if two similar terminals exist, but |
| 319 |
were coded at different times or by different people so that each description |
| 320 |
is a full description, using \fBinfocmp\fP |
| 321 |
will show what can be done to change |
| 322 |
one description to be relative to the other. |
| 323 |
.PP |
| 324 |
A capability will be printed with an at-sign (@) if it no longer exists in the |
| 325 |
first \fIterminal-type\fP, |
| 326 |
but one of the other \fIterminal-type\fP entries contains a value for |
| 327 |
it. |
| 328 |
A capability's value will be printed if the value in the first |
| 329 |
\fIterminal-type\fP is not found in any of the other \fIterminal-type\fP |
| 330 |
entries, |
| 331 |
or if the first of the other \fIterminal-type\fP entries that has this |
| 332 |
capability gives a different value for the capability than that in the |
| 333 |
first \fIterminal-type\fP. |
| 334 |
.PP |
| 335 |
The order of the other \fIterminal-type\fP entries is significant. |
| 336 |
Since the |
| 337 |
terminfo compiler \fBtic\fP does a left-to-right scan of the capabilities, |
| 338 |
specifying two \fBuse=\fP entries that contain differing entries for the same |
| 339 |
capabilities will produce different results depending on the order that the |
| 340 |
entries are given in. |
| 341 |
\fBinfocmp\fP will flag any such inconsistencies between |
| 342 |
the other \fIterminal-type\fP entries as they are found. |
| 343 |
.PP |
| 344 |
Alternatively, specifying a capability \fIafter\fP a \fBuse=\fP entry that |
| 345 |
contains that capability will cause the second specification to be ignored. |
| 346 |
Using \fBinfocmp\fP to recreate a description can be a useful check to make |
| 347 |
sure that everything was specified correctly in the original source |
| 348 |
description. |
| 349 |
.PP |
| 350 |
Another error that does not cause incorrect compiled files, but will slow down |
| 351 |
the compilation time, is specifying extra \fBuse=\fP fields that are |
| 352 |
superfluous. |
| 353 |
\fBinfocmp\fP will flag any other \fIterminal-type use=\fP fields that |
| 354 |
were not needed. |
| 355 |
.SS "Changing Databases [\-A \fIdirectory\fP] [\-B \fIdirectory\fP]" |
| 356 |
Like other \fI\%ncurses\fP utilities, |
| 357 |
\fBinfocmp\fP looks for the terminal descriptions in several places. |
| 358 |
You can use the \fI\%TERMINFO\fP and \fI\%TERMINFO_DIRS\fP environment |
| 359 |
variables to override the compiled-in default list of places to search. |
| 360 |
See \fBncurses\fP(3NCURSES), as well as |
| 361 |
the \fIFetching Compiled Descriptions\fP section in \fBterminfo\fR(5). |
| 362 |
.PP |
| 363 |
You can also use the options \fB\-A\fP |
| 364 |
and \fB\-B\fP to override the list of places to search |
| 365 |
when comparing terminal descriptions: |
| 366 |
.bP |
| 367 |
The \fB\-A\fP option sets the location for the first \fIterminal-type\fP |
| 368 |
.bP |
| 369 |
The \fB\-B\fP option sets the location for the other |
| 370 |
\fIterminal-types\fP. |
| 371 |
.PP |
| 372 |
Using these options, it is possible to |
| 373 |
compare descriptions for a terminal with the same name located in two different |
| 374 |
databases. |
| 375 |
For instance, |
| 376 |
you can use this feature for comparing descriptions for the same terminal |
| 377 |
created by different people. |
| 378 |
.SS "Other Options" |
| 379 |
.TP 5 |
| 380 |
\fB\-0\fP |
| 381 |
causes the fields to be printed on one line, without wrapping. |
| 382 |
.TP 5 |
| 383 |
\fB\-1\fP |
| 384 |
causes the fields to be printed out one to a line. |
| 385 |
Otherwise, |
| 386 |
the fields will be printed several to a line to a maximum width |
| 387 |
of 60 characters. |
| 388 |
.TP |
| 389 |
\fB\-a\fP |
| 390 |
tells \fBinfocmp\fP to retain commented-out capabilities |
| 391 |
rather than discarding them. |
| 392 |
Capabilities are commented by prefixing them with a period. |
| 393 |
.TP |
| 394 |
\fB\-D\fP |
| 395 |
tells \fBinfocmp\fP to print the database locations that it knows about, |
| 396 |
and exit. |
| 397 |
.TP 5 |
| 398 |
\fB\-E\fP |
| 399 |
Dump the capabilities of the given terminal as tables, needed in |
| 400 |
the C initializer for a |
| 401 |
TERMTYPE structure (the terminal capability structure in the \fB<term.h>\fP). |
| 402 |
This option is useful for preparing versions of the curses library hardwired |
| 403 |
for a given terminal type. |
| 404 |
The tables are all declared static, and are named according to the type |
| 405 |
and the name of the corresponding terminal entry. |
| 406 |
.sp |
| 407 |
Before \fI\%ncurses\fP 5.0, |
| 408 |
the split between the \fB\-e\fP and \fB\-E\fP options was not needed; |
| 409 |
but support for extended names required making the arrays of terminal |
| 410 |
capabilities separate from the TERMTYPE structure. |
| 411 |
.TP 5 |
| 412 |
\fB\-e\fP |
| 413 |
Dump the capabilities of the given terminal as a C initializer for a |
| 414 |
TERMTYPE structure (the terminal capability structure in the \fB<term.h>\fP). |
| 415 |
This option is useful for preparing versions of the curses library hardwired |
| 416 |
for a given terminal type. |
| 417 |
.TP 5 |
| 418 |
\fB\-F\fP |
| 419 |
compare terminfo files. |
| 420 |
This assumes that two following arguments are filenames. |
| 421 |
The files are searched for pairwise matches between |
| 422 |
entries, with two entries considered to match if any of their names do. |
| 423 |
The report printed to standard output lists entries with no matches in |
| 424 |
the other file, and entries with more than one match. |
| 425 |
For entries |
| 426 |
with exactly one match it includes a difference report. |
| 427 |
Normally, |
| 428 |
to reduce the volume of the report, use references are |
| 429 |
not resolved before looking for differences, but resolution can be forced |
| 430 |
by also specifying \fB\-r\fP. |
| 431 |
.TP 5 |
| 432 |
\fB\-f\fP |
| 433 |
Display complex terminfo strings which contain if/then/else/endif expressions |
| 434 |
indented for readability. |
| 435 |
.TP 5 |
| 436 |
\fB\-G\fP |
| 437 |
Display constant literals in decimal form |
| 438 |
rather than their character equivalents. |
| 439 |
.TP 5 |
| 440 |
\fB\-g\fP |
| 441 |
Display constant character literals in quoted form |
| 442 |
rather than their decimal equivalents. |
| 443 |
.TP 5 |
| 444 |
\fB\-i\fP |
| 445 |
Analyze the initialization (\fBis1\fP, \fBis2\fP, \fBis3\fP), and reset |
| 446 |
(\fBrs1\fP, \fBrs2\fP, \fBrs3\fP), strings in the entry, |
| 447 |
as well as those used for starting/stopping cursor-positioning mode |
| 448 |
(\fBsmcup\fP, \fBrmcup\fP) as well as starting/stopping keymap mode |
| 449 |
(\fBsmkx\fP, \fBrmkx\fP). |
| 450 |
.IP |
| 451 |
For each string, the |
| 452 |
code tries to analyze it into actions in terms of the other capabilities in the |
| 453 |
entry, certain X3.64/ISO 6429/ECMA\-48 capabilities, and certain DEC VT-series |
| 454 |
private modes (the set of recognized special sequences has been selected for |
| 455 |
completeness over the existing terminfo database). |
| 456 |
Each report line consists |
| 457 |
of the capability name, followed by a colon and space, followed by a printable |
| 458 |
expansion of the capability string with sections matching recognized actions |
| 459 |
translated into {}-bracketed descriptions. |
| 460 |
.IP |
| 461 |
Here is a list of the DEC/ANSI |
| 462 |
special sequences recognized: |
| 463 |
.PP |
| 464 |
.TS |
| 465 |
center; |
| 466 |
L L. |
| 467 |
Action Meaning |
| 468 |
_ |
| 469 |
RIS full reset |
| 470 |
SC save cursor |
| 471 |
RC restore cursor |
| 472 |
LL home-down |
| 473 |
RSR reset scroll region |
| 474 |
_ |
| 475 |
DECSTR soft reset (VT320) |
| 476 |
S7C1T 7-bit controls (VT220) |
| 477 |
_ |
| 478 |
ISO DEC G0 enable DEC graphics for G0 |
| 479 |
ISO UK G0 enable UK chars for G0 |
| 480 |
ISO US G0 enable US chars for G0 |
| 481 |
ISO DEC G1 enable DEC graphics for G1 |
| 482 |
ISO UK G1 enable UK chars for G1 |
| 483 |
ISO US G1 enable US chars for G1 |
| 484 |
_ |
| 485 |
DECPAM application keypad mode |
| 486 |
DECPNM normal keypad mode |
| 487 |
DECANSI enter ANSI mode |
| 488 |
_ |
| 489 |
ECMA[+\-]AM keyboard action mode |
| 490 |
ECMA[+\-]IRM insert replace mode |
| 491 |
ECMA[+\-]SRM send receive mode |
| 492 |
ECMA[+\-]LNM linefeed mode |
| 493 |
_ |
| 494 |
DEC[+\-]CKM application cursor keys |
| 495 |
DEC[+\-]ANM set VT52 mode |
| 496 |
DEC[+\-]COLM 132-column mode |
| 497 |
DEC[+\-]SCLM smooth scroll |
| 498 |
DEC[+\-]SCNM reverse video mode |
| 499 |
DEC[+\-]OM origin mode |
| 500 |
DEC[+\-]AWM wraparound mode |
| 501 |
DEC[+\-]ARM auto-repeat mode |
| 502 |
.TE |
| 503 |
.sp |
| 504 |
It also recognizes a SGR action corresponding to ANSI/ISO 6429/ECMA Set |
| 505 |
Graphics Rendition, with the values NORMAL, BOLD, UNDERLINE, BLINK, and |
| 506 |
REVERSE. |
| 507 |
All but NORMAL may be prefixed with |
| 508 |
.RS |
| 509 |
.bP |
| 510 |
\*(``+\*('' (turn on) or |
| 511 |
.bP |
| 512 |
\*(``\-\*('' (turn off). |
| 513 |
.RE |
| 514 |
.IP |
| 515 |
An SGR0 designates an empty highlight sequence (equivalent to {SGR:NORMAL}). |
| 516 |
.TP 5 |
| 517 |
\fB\-l\fP |
| 518 |
Set output format to terminfo. |
| 519 |
.TP 5 |
| 520 |
\fB\-p\fP |
| 521 |
Ignore padding specifications when comparing strings. |
| 522 |
.TP 5 |
| 523 |
\fB\-Q\fP \fIn\fP |
| 524 |
Rather than show source in terminfo (text) format, |
| 525 |
print the compiled (binary) format in hexadecimal or base64 form, |
| 526 |
depending on the option's value: |
| 527 |
.RS 8 |
| 528 |
.TP 3 |
| 529 |
1 |
| 530 |
hexadecimal |
| 531 |
.TP 3 |
| 532 |
2 |
| 533 |
base64 |
| 534 |
.TP 3 |
| 535 |
3 |
| 536 |
hexadecimal and base64 |
| 537 |
.RE |
| 538 |
.IP |
| 539 |
For example, this prints the compiled terminfo value as a string |
| 540 |
which could be assigned to the \fI\%TERMINFO\fP environment variable: |
| 541 |
.PP |
| 542 |
.RS 9 |
| 543 |
.EX |
| 544 |
infocmp \-0 \-q \-Q2 |
| 545 |
.EE |
| 546 |
.RE |
| 547 |
.TP 5 |
| 548 |
\fB\-q\fP |
| 549 |
This makes the output a little shorter: |
| 550 |
.RS |
| 551 |
.bP |
| 552 |
Make the comparison listing shorter by omitting subheadings, and using |
| 553 |
\*(``\-\*('' for absent capabilities, \*(``@\*('' |
| 554 |
for canceled rather than \*(``NULL\*(''. |
| 555 |
.bP |
| 556 |
However, |
| 557 |
show differences between absent and canceled capabilities. |
| 558 |
.bP |
| 559 |
Omit the \*(``Reconstructed from\*('' comment for source listings. |
| 560 |
.RE |
| 561 |
.TP 5 |
| 562 |
\fB\-R\fIsubset\fR |
| 563 |
Restrict output to a given subset. |
| 564 |
This option is for use with archaic |
| 565 |
versions of terminfo like those on SVr1, Ultrix, or HP-UX that do not support |
| 566 |
the full set of SVR4/XSI Curses terminfo; and variants such as AIX |
| 567 |
that have their own extensions incompatible with SVr4/XSI. |
| 568 |
.RS |
| 569 |
.bP |
| 570 |
Available terminfo |
| 571 |
subsets are \*(``SVr1\*('', \*(``Ultrix\*('', \*(``HP\*('', and \*(``AIX\*(''; |
| 572 |
see \fBterminfo\fP(5) for details. |
| 573 |
.bP |
| 574 |
You can also choose the subset \*(``BSD\*('' which selects only capabilities |
| 575 |
with termcap equivalents recognized by 4.4BSD. |
| 576 |
.bP |
| 577 |
If you select any other value for \fB\-R\fP, |
| 578 |
it is the same as no subset, i.e., all capabilities are used. |
| 579 |
.RE |
| 580 |
.IP |
| 581 |
A few options override the subset selected with \fB\-R\fP, |
| 582 |
if they are processed later in the command parameters: |
| 583 |
.RS |
| 584 |
.TP 5 |
| 585 |
\fB\-C\fP |
| 586 |
sets the \*(``BSD\*('' subset as a side effect. |
| 587 |
.TP 5 |
| 588 |
\fB\-I\fP |
| 589 |
sets the subset to all capabilities. |
| 590 |
.TP 5 |
| 591 |
\fB\-r\fP |
| 592 |
sets the subset to all capabilities. |
| 593 |
.RE |
| 594 |
.TP |
| 595 |
\fB\-s \fI[d|i|l|c]\fR |
| 596 |
The \fB\-s\fP option sorts the fields within each type according to the argument |
| 597 |
below: |
| 598 |
.br |
| 599 |
.RS 5 |
| 600 |
.TP 5 |
| 601 |
\fBd\fP |
| 602 |
leave fields in the order that they are stored in the \fIterminfo\fP database. |
| 603 |
.TP 5 |
| 604 |
\fBi\fP |
| 605 |
sort by \fIterminfo\fP name. |
| 606 |
.TP 5 |
| 607 |
\fBl\fP |
| 608 |
sort by the long C variable name. |
| 609 |
.TP 5 |
| 610 |
\fBc\fP |
| 611 |
sort by the \fItermcap\fP name. |
| 612 |
.RE |
| 613 |
.IP |
| 614 |
If the \fB\-s\fP option is not given, the fields printed out will be |
| 615 |
sorted alphabetically by the \fBterminfo\fP name within each type, |
| 616 |
except in the case of the \fB\-C\fP or the \fB\-L\fP options, which cause the |
| 617 |
sorting to be done by the \fBtermcap\fP name or the long C variable |
| 618 |
name, respectively. |
| 619 |
.TP 5 |
| 620 |
\fB\-T\fP |
| 621 |
eliminates size-restrictions on the generated text. |
| 622 |
This is mainly useful for testing and analysis, since the compiled |
| 623 |
descriptions are limited (e.g., 1023 for termcap, 4096 for terminfo). |
| 624 |
.TP |
| 625 |
\fB\-t\fP |
| 626 |
tells \fBtic\fP to discard commented-out capabilities. |
| 627 |
Normally when translating from terminfo to termcap, |
| 628 |
untranslatable capabilities are commented-out. |
| 629 |
.TP 5 |
| 630 |
\fB\-U\fP |
| 631 |
tells \fBinfocmp\fP to not post-process the data |
| 632 |
after parsing the source file. |
| 633 |
This feature helps when comparing the actual contents of two source files, |
| 634 |
since it excludes the inferences that \fBinfocmp\fP makes to fill in missing |
| 635 |
data. |
| 636 |
.TP 5 |
| 637 |
\fB\-V\fP |
| 638 |
reports the version of \fI\%ncurses\fP which was used in this program, |
| 639 |
and exits. |
| 640 |
.TP 5 |
| 641 |
\fB\-v\fP \fIn\fP |
| 642 |
prints out tracing information on standard error as the program runs. |
| 643 |
.IP |
| 644 |
The optional parameter \fIn\fP is a number from 1 to 10, inclusive, |
| 645 |
indicating the desired level of detail of information. |
| 646 |
If \fI\%ncurses\fP is built without tracing support, |
| 647 |
the optional parameter is ignored. |
| 648 |
.TP |
| 649 |
\fB\-W\fP |
| 650 |
By itself, the \fB\-w\fP option will not force long strings to be wrapped. |
| 651 |
Use the \fB\-W\fP option to do this. |
| 652 |
.TP 5 |
| 653 |
\fB\-w\fP \fIwidth\fP |
| 654 |
changes the output to \fIwidth\fP characters. |
| 655 |
.TP |
| 656 |
\fB\-x\fP |
| 657 |
print information for user-defined capabilities (see \fBuser_caps\fP(5). |
| 658 |
These are extensions to the terminfo repertoire which can be loaded |
| 659 |
using the \fB\-x\fP option of \fBtic\fP. |
| 660 |
.SH FILES |
| 661 |
.TP |
| 662 |
.I /etc/terminfo |
| 663 |
compiled terminal description database |
| 664 |
.SH EXTENSIONS |
| 665 |
The |
| 666 |
.BR \-0 "," |
| 667 |
.BR \-1 "," |
| 668 |
.BR \-a "," |
| 669 |
.BR \-e "," |
| 670 |
.BR \-E "," |
| 671 |
.BR \-f "," |
| 672 |
.BR \-F "," |
| 673 |
.BR \-g "," |
| 674 |
.BR \-G "," |
| 675 |
.BR \-i "," |
| 676 |
.BR \-l "," |
| 677 |
.BR \-p "," |
| 678 |
.BR \-q "," |
| 679 |
.BR \-Q "," |
| 680 |
.BR \-R "," |
| 681 |
.BR \-t "," |
| 682 |
.BR \-T "," |
| 683 |
and |
| 684 |
.B \-V |
| 685 |
options are |
| 686 |
.I \%ncurses |
| 687 |
extensions. |
| 688 |
.SH PORTABILITY |
| 689 |
X/Open Curses Issue\ 7 (2009) specifies |
| 690 |
.IR \%infocmp "." |
| 691 |
It does not mention options for producing descriptions in |
| 692 |
.I \%term\%cap |
| 693 |
format. |
| 694 |
.PP |
| 695 |
SVr4 |
| 696 |
.I \%infocmp |
| 697 |
does not distinguish between absent and canceled capabilities. |
| 698 |
It furthermore reports missing integer capabilities as |
| 699 |
.B \-1 |
| 700 |
(its internal representation). |
| 701 |
.I \%ncurses |
| 702 |
shows these as \*(``NULL\*('' |
| 703 |
for consistency with missing string capabilities. |
| 704 |
.PP |
| 705 |
The |
| 706 |
.B \-r |
| 707 |
option |
| 708 |
of |
| 709 |
.I \%ncurses |
| 710 |
.I \%infocmp |
| 711 |
uses SVr4's notion of \*(``termcap\*('' capabilities. |
| 712 |
BSD |
| 713 |
.I curses |
| 714 |
had a more restricted set. |
| 715 |
To see only those present in 4.4BSD, |
| 716 |
use |
| 717 |
.RB \*(`` "\-r \-RBSD" \*(''. |
| 718 |
.SH HISTORY |
| 719 |
Although System V Release 2 provided a terminfo library, |
| 720 |
it had no documented tool for decompiling the terminal descriptions. |
| 721 |
Tony Hansen (AT&T) wrote the first \fBinfocmp\fP in early 1984, |
| 722 |
for System V Release 3. |
| 723 |
.PP |
| 724 |
Eric Raymond used the AT&T documentation in 1995 to provide an equivalent |
| 725 |
\fBinfocmp\fP for \fI\%ncurses\fP. |
| 726 |
In addition, he added a few new features such as: |
| 727 |
.bP |
| 728 |
the \fB\-e\fP option, to support \fIfallback\fP |
| 729 |
(compiled-in) terminal descriptions |
| 730 |
.bP |
| 731 |
the \fB\-i\fP option, to help with analysis |
| 732 |
.PP |
| 733 |
Later, Thomas Dickey added the \fB\-x\fP (user-defined capabilities) |
| 734 |
option, and the \fB\-E\fP option to support fallback entries with |
| 735 |
user-defined capabilities. |
| 736 |
.PP |
| 737 |
For a complete list, see the \fIEXTENSIONS\fP section. |
| 738 |
.PP |
| 739 |
In 2010, Roy Marples provided an \fBinfocmp\fP program for NetBSD. |
| 740 |
It is less capable than the SVr4 or \fI\%ncurses\fP versions |
| 741 |
(e.g., it lacks the sorting options documented in X/Open), |
| 742 |
but does include the \fB\-x\fP option adapted from \fI\%ncurses\fP. |
| 743 |
.SH BUGS |
| 744 |
The \fB\-F\fP option of \fB\%infocmp\fP(1) should be a |
| 745 |
\fB\%toe\fP(1) mode. |
| 746 |
.SH AUTHORS |
| 747 |
Eric S. Raymond <[email protected]> |
| 748 |
and |
| 749 |
.br |
| 750 |
Thomas E. Dickey <dickey@invisible\-island.net> |
| 751 |
.SH SEE ALSO |
| 752 |
\fB\%captoinfo\fP(1), |
| 753 |
\fB\%infotocap\fP(1), |
| 754 |
\fB\%tic\fP(1), |
| 755 |
\fB\%toe\fP(1), |
| 756 |
\fB\%ncurses\fP(3NCURSES), |
| 757 |
\fB\%terminfo\fP(5), |
| 758 |
\fB\%user_caps\fP(5) |
| 759 |
.PP |
| 760 |
https://invisible\-island.net/ncurses/tctest.html |