| 1 |
.\"*************************************************************************** |
| 2 |
.\" Copyright 2018-2024,2025 Thomas E. Dickey * |
| 3 |
.\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * |
| 4 |
.\" * |
| 5 |
.\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 6 |
.\" copy of this software and associated documentation files (the * |
| 7 |
.\" "Software"), to deal in the Software without restriction, including * |
| 8 |
.\" without limitation the rights to use, copy, modify, merge, publish, * |
| 9 |
.\" distribute, distribute with modifications, sublicense, and/or sell * |
| 10 |
.\" copies of the Software, and to permit persons to whom the Software is * |
| 11 |
.\" furnished to do so, subject to the following conditions: * |
| 12 |
.\" * |
| 13 |
.\" The above copyright notice and this permission notice shall be included * |
| 14 |
.\" in all copies or substantial portions of the Software. * |
| 15 |
.\" * |
| 16 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 17 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 18 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 19 |
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 20 |
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 21 |
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 22 |
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 23 |
.\" * |
| 24 |
.\" Except as contained in this notice, the name(s) of the above copyright * |
| 25 |
.\" holders shall not be used in advertising or otherwise to promote the * |
| 26 |
.\" sale, use or other dealings in this Software without prior written * |
| 27 |
.\" authorization. * |
| 28 |
.\"*************************************************************************** |
| 29 |
.\" |
| 30 |
.\" $Id: tic.1m,v 1.128 2025/11/12 00:49:19 tom Exp $ |
| 31 |
.TH tic 1 2025-11-11 "ncurses 6.6" "User commands" |
| 32 |
.ie \n(.g \{\ |
| 33 |
.ds `` \(lq |
| 34 |
.ds '' \(rq |
| 35 |
.\} |
| 36 |
.el \{\ |
| 37 |
.ie t .ds `` `` |
| 38 |
.el .ds `` "" |
| 39 |
.ie t .ds '' '' |
| 40 |
.el .ds '' "" |
| 41 |
.\} |
| 42 |
. |
| 43 |
.de bP |
| 44 |
.ie n .IP \(bu 4 |
| 45 |
.el .IP \(bu 2 |
| 46 |
.. |
| 47 |
. |
| 48 |
.SH NAME |
| 49 |
\fB\%tic\fP \- |
| 50 |
compile terminal descriptions for \%\fIterm\%info\fR or \fItermcap\fR |
| 51 |
.SH SYNOPSIS |
| 52 |
\fBtic\fP |
| 53 |
[\fB\-\ |
| 54 |
0\ |
| 55 |
1\ |
| 56 |
a\ |
| 57 |
c\ |
| 58 |
C\ |
| 59 |
D\ |
| 60 |
f\ |
| 61 |
g\ |
| 62 |
G\ |
| 63 |
I\ |
| 64 |
K\ |
| 65 |
L\ |
| 66 |
N\ |
| 67 |
q\ |
| 68 |
r\ |
| 69 |
s\ |
| 70 |
t\ |
| 71 |
T\ |
| 72 |
U\ |
| 73 |
V\ |
| 74 |
W\ |
| 75 |
x\ |
| 76 |
\fP] |
| 77 |
[\fB\-e\fP \fIterminal-type-list\fP] |
| 78 |
[\fB\-o\fP \fIdir\fP] |
| 79 |
[\fB\-Q\fP[\fIn\fP]] |
| 80 |
[\fB\-R\fP \fIsubset\fP] |
| 81 |
[\fB\-v\fP[\fIn\fP]] |
| 82 |
[\fB\-w\fP[\fIn\fP]] |
| 83 |
\fIfile\fP |
| 84 |
.SH DESCRIPTION |
| 85 |
.B \%tic |
| 86 |
translates a |
| 87 |
.I \%term\%info |
| 88 |
file from source format |
| 89 |
into the compiled format |
| 90 |
used by the |
| 91 |
\fB\%ncurses\fP(3NCURSES) |
| 92 |
library. |
| 93 |
.PP |
| 94 |
As described in \fBterm\fP(5), |
| 95 |
the database may be either a directory tree |
| 96 |
(one file per terminal entry) |
| 97 |
or a hashed database |
| 98 |
(one record per entry). |
| 99 |
The |
| 100 |
.B \%tic |
| 101 |
command writes only one type of entry, |
| 102 |
depending on how it was built. |
| 103 |
.bP |
| 104 |
For directory trees, |
| 105 |
the top-level directory, |
| 106 |
such as |
| 107 |
.IR \%/usr/share/terminfo "," |
| 108 |
specifies the location of the database. |
| 109 |
.bP |
| 110 |
For hashed databases, a filename is needed. |
| 111 |
If the given file is not found by that name, |
| 112 |
but can be found by adding the suffix \*(``.db\*('', |
| 113 |
then that is used. |
| 114 |
.IP |
| 115 |
The default name for the hashed database is the same as the |
| 116 |
default directory name (only adding a \*(``.db\*('' suffix). |
| 117 |
.PP |
| 118 |
In either case (directory or hashed database), |
| 119 |
.B \%tic |
| 120 |
will create the container if it does not exist. |
| 121 |
For a directory, this would be the \*(``terminfo\*('' leaf, |
| 122 |
versus a |
| 123 |
.I terminfo.db |
| 124 |
file. |
| 125 |
.PP |
| 126 |
The results are normally placed |
| 127 |
in the system |
| 128 |
.I \%term\%info |
| 129 |
database |
| 130 |
.IR \%/etc/terminfo "." |
| 131 |
The compiled terminal description can be placed |
| 132 |
in a different |
| 133 |
.I \%term\%info |
| 134 |
database. |
| 135 |
There are two ways to achieve this: |
| 136 |
.bP |
| 137 |
First, you may override the system default either by |
| 138 |
using the \fB\-o\fP option, |
| 139 |
or by setting the variable \fI\%TERMINFO\fP |
| 140 |
in the process environment to a valid database location. |
| 141 |
.bP |
| 142 |
Secondly, if |
| 143 |
.B \%tic |
| 144 |
cannot write in |
| 145 |
.I \%/etc/terminfo |
| 146 |
or the location specified using your |
| 147 |
.I \%TERMINFO |
| 148 |
variable, |
| 149 |
it looks for the directory |
| 150 |
.I \%$HOME/.terminfo |
| 151 |
(or hashed database |
| 152 |
.IR $HOME/.terminfo.db ); |
| 153 |
if that location exists, the entry is placed there. |
| 154 |
.PP |
| 155 |
Libraries that read |
| 156 |
.I \%term\%info |
| 157 |
entries are expected to check in succession |
| 158 |
.bP |
| 159 |
a location specified by the |
| 160 |
.I \%TERMINFO |
| 161 |
environment variable, |
| 162 |
.bP |
| 163 |
.IR \%$HOME/.terminfo "," |
| 164 |
.bP |
| 165 |
directories listed in the |
| 166 |
.I \%TERMINFO_DIRS |
| 167 |
environment variable, |
| 168 |
.bP |
| 169 |
a compiled-in list of directories |
| 170 |
.RI \%( /etc/terminfo:/lib/terminfo:/usr/share/terminfo ), |
| 171 |
and |
| 172 |
.bP |
| 173 |
the system |
| 174 |
.I \%term\%info |
| 175 |
database |
| 176 |
.RI \%( /etc/terminfo ). |
| 177 |
.PP |
| 178 |
Section \*(``Fetching Compiled Descriptions\*('' in \fBterminfo\fP(5) |
| 179 |
goes into further detail. |
| 180 |
.SS Aliases |
| 181 |
.B \%tic |
| 182 |
is the same program as |
| 183 |
.B \%infotocap |
| 184 |
and |
| 185 |
.BR \%captoinfo ";" |
| 186 |
usually those are linked to, |
| 187 |
or copied from, this program. |
| 188 |
.bP |
| 189 |
When invoked as |
| 190 |
.BR \%infotocap "," |
| 191 |
.B \%tic |
| 192 |
sets the |
| 193 |
.B \-I |
| 194 |
option. |
| 195 |
.bP |
| 196 |
When invoked as |
| 197 |
.BR \%captoinfo "," |
| 198 |
.B \%tic |
| 199 |
sets the |
| 200 |
.B \-C |
| 201 |
option. |
| 202 |
.SH OPTIONS |
| 203 |
.TP |
| 204 |
.B \-0 |
| 205 |
restricts the output to a single line. |
| 206 |
.TP |
| 207 |
.B \-1 |
| 208 |
restricts the output to a single column. |
| 209 |
.TP |
| 210 |
.B \-a |
| 211 |
tells |
| 212 |
.B \%tic |
| 213 |
to retain commented-out capabilities rather than discarding them. |
| 214 |
Capabilities are commented by prefixing them with a period. |
| 215 |
.B \-a |
| 216 |
implies |
| 217 |
.BR \-x "," |
| 218 |
because |
| 219 |
.B \%tic |
| 220 |
treats the commented-out entries as user-defined names. |
| 221 |
If the source is in |
| 222 |
.I termcap |
| 223 |
format, |
| 224 |
.B \%tic |
| 225 |
accepts the 2-character names required by version 6. |
| 226 |
.\" TD added this comment in 2003, prompted by discussion with Don Libes. |
| 227 |
.\" Quoting from SunOS 4.1.3 termcap(5): |
| 228 |
.\" Each termcap entry consist of a number of colon-separated (:) fields. |
| 229 |
.\" The first field for each terminal lists the various names by which it |
| 230 |
.\" is known, separated by bar ( | ) characters. The first name is always |
| 231 |
.\" two characters long, and is used by older (version 6) systems (which |
| 232 |
.\" store the terminal type in a 16-bit word in a system-wide database). |
| 233 |
.\" Version 6 sounds like Unix version 6, but termcap was introduced a few |
| 234 |
.\" years later. The SunOS man page was based on material in 4.2BSD. |
| 235 |
Otherwise these are ignored. |
| 236 |
.TP |
| 237 |
\fB\-C\fP |
| 238 |
Force source translation to |
| 239 |
.I termcap |
| 240 |
format. |
| 241 |
Note: this option differs from the |
| 242 |
.B \-C |
| 243 |
option of \fB\%infocmp\fP(1) |
| 244 |
in that it does not merely translate capability names, |
| 245 |
but also translates |
| 246 |
.I \%term\%info |
| 247 |
string capability values to |
| 248 |
.I termcap |
| 249 |
format. |
| 250 |
.B \%tic |
| 251 |
leaves capabilities that are not translatable |
| 252 |
in the entry under their |
| 253 |
.I \%term\%info |
| 254 |
names, |
| 255 |
but commented out with two preceding dots. |
| 256 |
The actual format used |
| 257 |
incorporates some improvements for escaped characters |
| 258 |
from |
| 259 |
.I \%term\%info |
| 260 |
format. |
| 261 |
For a stricter BSD-compatible translation, |
| 262 |
specify |
| 263 |
.B \-K |
| 264 |
as well. |
| 265 |
.IP |
| 266 |
If |
| 267 |
.B \-C |
| 268 |
is combined with |
| 269 |
.BR \-c "," |
| 270 |
.B \%tic |
| 271 |
makes additional checks, |
| 272 |
reporting cases where |
| 273 |
.I \%term\%info |
| 274 |
capability values do not have an exact equivalent |
| 275 |
in |
| 276 |
.I termcap |
| 277 |
syntax. |
| 278 |
For example: |
| 279 |
.RS |
| 280 |
.bP |
| 281 |
.B sgr |
| 282 |
usually does not convert, |
| 283 |
because |
| 284 |
.I termcap |
| 285 |
is unable to work with more than two parameters, |
| 286 |
and because |
| 287 |
.I termcap 's |
| 288 |
language for encoding parameterized capabilities |
| 289 |
lacks many of |
| 290 |
.IR \%term\%info 's |
| 291 |
arithmetic and logical operators. |
| 292 |
.RE |
| 293 |
.TP |
| 294 |
.B \-c |
| 295 |
tells |
| 296 |
.B \%tic |
| 297 |
to perform only validation of |
| 298 |
.I file "," |
| 299 |
including syntax problems and invalid |
| 300 |
.RB \*(`` use \*('' |
| 301 |
references; |
| 302 |
no output is produced. |
| 303 |
If you specify |
| 304 |
.B \-C |
| 305 |
.RB ( \-I ) |
| 306 |
with this option, |
| 307 |
.B \%tic |
| 308 |
warns about entries that, |
| 309 |
after |
| 310 |
.RB \*(`` use \*('' |
| 311 |
resolution, |
| 312 |
exceed 1023 (4096) bytes. |
| 313 |
Due to a fixed buffer length in older |
| 314 |
.I termcap |
| 315 |
libraries, |
| 316 |
as well as buggy checking of the buffer length |
| 317 |
(and a documented limit in |
| 318 |
.IR \%term\%info ), |
| 319 |
these entries may cause core dumps |
| 320 |
with other implementations. |
| 321 |
.IP |
| 322 |
.B \%tic |
| 323 |
checks string capabilities |
| 324 |
to ensure that those with parameters are valid expressions. |
| 325 |
It validates only standard string capabilities, |
| 326 |
ignoring those defined with the |
| 327 |
.B \-x |
| 328 |
option. |
| 329 |
.TP |
| 330 |
\fB\-D\fP |
| 331 |
tells |
| 332 |
.B \%tic |
| 333 |
to print the database locations that it knows about, and exit. |
| 334 |
The first location shown is the one to which it would write compiled |
| 335 |
terminal descriptions. |
| 336 |
If |
| 337 |
.B \%tic |
| 338 |
is not able to find a writable database location |
| 339 |
according to the rules summarized above, |
| 340 |
it will print a diagnostic and exit with an error rather than |
| 341 |
printing a list of database locations. |
| 342 |
.TP |
| 343 |
\fB\-e \fIlist\fR |
| 344 |
Limit writes and translations to the comma-separated \fIlist\fP of |
| 345 |
terminal types. |
| 346 |
If any name or alias of a terminal matches one of the names in |
| 347 |
the list, the entry will be written or translated as normal. |
| 348 |
Otherwise no output will be generated for it. |
| 349 |
The option value is interpreted as a file containing the list if it |
| 350 |
contains a '/'. |
| 351 |
(Note: depending on how |
| 352 |
.B \%tic |
| 353 |
was compiled, |
| 354 |
this option may require \fB\-I\fP or \fB\-C\fP.) |
| 355 |
.TP |
| 356 |
\fB\-f\fP |
| 357 |
Display complex terminfo strings which contain if/then/else/endif expressions |
| 358 |
indented for readability. |
| 359 |
.TP |
| 360 |
\fB\-G\fP |
| 361 |
Display constant literals in decimal form |
| 362 |
rather than their character equivalents. |
| 363 |
.TP |
| 364 |
\fB\-g\fP |
| 365 |
Display constant character literals in quoted form |
| 366 |
rather than their decimal equivalents. |
| 367 |
.TP |
| 368 |
\fB\-I\fP |
| 369 |
Force source translation to terminfo format. |
| 370 |
.TP |
| 371 |
\fB\-K\fP |
| 372 |
Suppress some longstanding \fI\%ncurses\fP extensions to termcap format, |
| 373 |
e.g., "\es" for space. |
| 374 |
.TP |
| 375 |
\fB\-L\fP |
| 376 |
Force source translation to terminfo format |
| 377 |
using the long C variable names listed in <\fBterm.h\fP> |
| 378 |
.TP |
| 379 |
\fB\-N\fP |
| 380 |
Disable smart defaults. |
| 381 |
Normally, when translating from termcap to terminfo, the compiler makes |
| 382 |
a number of assumptions about the defaults of string capabilities |
| 383 |
\fBreset1_string\fP, \fBcarriage_return\fP, \fBcursor_left\fP, |
| 384 |
\fBcursor_down\fP, \fBscroll_forward\fP, \fBtab\fP, \fBnewline\fP, |
| 385 |
\fBkey_backspace\fP, \fBkey_left\fP, and \fBkey_down\fP, then attempts |
| 386 |
to use obsolete termcap capabilities to deduce correct values. |
| 387 |
It also |
| 388 |
normally suppresses output of obsolete termcap capabilities such as \fBbs\fP. |
| 389 |
This option forces a more literal translation that also preserves the |
| 390 |
obsolete capabilities. |
| 391 |
.TP |
| 392 |
\fB\-o\fIdir\fR |
| 393 |
Write compiled entries to given database location. |
| 394 |
Overrides the \fI\%TERMINFO\fP environment variable. |
| 395 |
.TP |
| 396 |
\fB\-Q\fIn\fR |
| 397 |
Rather than show source in terminfo (text) format, |
| 398 |
print the compiled (binary) format in hexadecimal or base64 form, |
| 399 |
depending on the option's value: |
| 400 |
.RS 8 |
| 401 |
.TP 3 |
| 402 |
1 |
| 403 |
hexadecimal |
| 404 |
.TP 3 |
| 405 |
2 |
| 406 |
base64 |
| 407 |
.TP 3 |
| 408 |
3 |
| 409 |
hexadecimal and base64 |
| 410 |
.RE |
| 411 |
.TP |
| 412 |
\fB\-q\fP |
| 413 |
Suppress comments and blank lines when showing translated source. |
| 414 |
.TP |
| 415 |
\fB\-R\fIsubset\fR |
| 416 |
Restrict output to a given subset. |
| 417 |
This option is for use with archaic |
| 418 |
versions of terminfo like those on SVr1, Ultrix, or HP-UX that do not support |
| 419 |
the full set of SVR4/XSI Curses terminfo; and outright broken ports like AIX 3.x |
| 420 |
that have their own extensions incompatible with SVr4/XSI. |
| 421 |
.IP |
| 422 |
Available subsets are |
| 423 |
.RS |
| 424 |
\*(``SVr1\*('', |
| 425 |
\*(``Ultrix\*('', |
| 426 |
\*(``HP\*('', |
| 427 |
\*(``BSD\*('', and |
| 428 |
\*(``AIX\*('' |
| 429 |
.RE |
| 430 |
.IP |
| 431 |
See \fBterminfo\fP(5) for details. |
| 432 |
.TP |
| 433 |
\fB\-r\fP |
| 434 |
Force entry resolution (so there are no remaining tc capabilities) even |
| 435 |
when doing translation to termcap format. |
| 436 |
This may be needed if you are |
| 437 |
preparing a termcap file for a termcap library (such as GNU termcap through |
| 438 |
version 1.3 or BSD termcap through 4.3BSD) that does not handle multiple |
| 439 |
tc capabilities per entry. |
| 440 |
.TP |
| 441 |
\fB\-s\fP |
| 442 |
Summarize the compile by showing the database location into which entries |
| 443 |
are written, and the number of entries which are compiled. |
| 444 |
.TP |
| 445 |
\fB\-T\fP |
| 446 |
eliminates size-restrictions on the generated text. |
| 447 |
This is mainly useful for testing and analysis, since the compiled |
| 448 |
descriptions are limited (e.g., 1023 for termcap, 4096 for terminfo). |
| 449 |
.TP |
| 450 |
\fB\-t\fP |
| 451 |
tells |
| 452 |
.B \%tic |
| 453 |
to discard commented-out capabilities. |
| 454 |
Normally when translating from terminfo to termcap, |
| 455 |
untranslatable capabilities are commented-out. |
| 456 |
.TP |
| 457 |
\fB\-U\fP |
| 458 |
tells |
| 459 |
.B \%tic |
| 460 |
to not post-process the data after parsing the source file. |
| 461 |
Normally, it infers data which is commonly missing in older terminfo data, |
| 462 |
or in termcaps. |
| 463 |
.TP |
| 464 |
\fB\-V\fP |
| 465 |
reports the version of \fI\%ncurses\fP which was used in this program, |
| 466 |
and exits. |
| 467 |
.TP |
| 468 |
\fB\-v\fIn\fR |
| 469 |
specifies that (verbose) output be written to standard error trace |
| 470 |
information showing |
| 471 |
.BR \%tic 's |
| 472 |
progress. |
| 473 |
.IP |
| 474 |
The optional parameter \fIn\fP is a number from 1 to 9, inclusive, |
| 475 |
indicating the desired level of detail of information. |
| 476 |
.RS |
| 477 |
.bP |
| 478 |
If \fI\%ncurses\fP is built without tracing support, |
| 479 |
the optional parameter is ignored. |
| 480 |
.bP |
| 481 |
If \fIn\fP is omitted, the default level is 1. |
| 482 |
.bP |
| 483 |
If \fIn\fP is specified and greater than 1, the level of |
| 484 |
detail is increased, and the output is written (with tracing information) |
| 485 |
to the \*(``trace\*('' file. |
| 486 |
.RE |
| 487 |
.RS |
| 488 |
.PP |
| 489 |
The debug flag levels are as follows: |
| 490 |
.TP 4 |
| 491 |
1 |
| 492 |
Names of files created and linked |
| 493 |
.TP |
| 494 |
2 |
| 495 |
Information related to the \*(``use\*('' facility |
| 496 |
.TP |
| 497 |
3 |
| 498 |
Statistics from the hashing algorithm |
| 499 |
.TP |
| 500 |
4 |
| 501 |
Details of extended capabilities |
| 502 |
.TP |
| 503 |
5 |
| 504 |
(unused) |
| 505 |
.TP |
| 506 |
6 |
| 507 |
(unused) |
| 508 |
.TP |
| 509 |
7 |
| 510 |
Entries into the string-table |
| 511 |
.TP |
| 512 |
8 |
| 513 |
List of tokens encountered by scanner |
| 514 |
.TP |
| 515 |
9 |
| 516 |
All values computed in construction of the hash table |
| 517 |
.RE |
| 518 |
.TP |
| 519 |
\fB\-W\fP |
| 520 |
By itself, the \fB\-w\fP option will not force long strings to be wrapped. |
| 521 |
Use the \fB\-W\fP option to do this. |
| 522 |
.IP |
| 523 |
If you specify both \fB\-f\fP and \fB\-W\fP options, |
| 524 |
the latter is ignored when \fB\-f\fP has already split the line. |
| 525 |
.TP |
| 526 |
\fB\-w\fIn\fR |
| 527 |
specifies the width of the output. |
| 528 |
The parameter is optional. |
| 529 |
If it is omitted, it defaults to 60. |
| 530 |
.TP |
| 531 |
\fB\-x\fP |
| 532 |
Treat unknown capabilities as user-defined (see \fBuser_caps\fP(5)). |
| 533 |
That is, if you supply a capability name which |
| 534 |
.B \%tic |
| 535 |
does not recognize, |
| 536 |
it will infer its type (Boolean, number or string) from the syntax and |
| 537 |
make an extended table entry for that. |
| 538 |
User-defined capability strings |
| 539 |
whose name begins with \*(``k\*('' are treated as function keys. |
| 540 |
.SS Parameters |
| 541 |
.TP |
| 542 |
.I file |
| 543 |
contains one or more |
| 544 |
.I \%term\%info |
| 545 |
terminal descriptions in source format; see \fBterminfo\fP(5). |
| 546 |
Each description in the file |
| 547 |
describes the capabilities of a particular terminal type. |
| 548 |
.IP |
| 549 |
If |
| 550 |
.I file |
| 551 |
is \*(``\-\*('', |
| 552 |
the data are read from the standard input stream. |
| 553 |
The |
| 554 |
.I file |
| 555 |
parameter may also be the path of a character device. |
| 556 |
.SS Processing |
| 557 |
\fBterminfo\fP(5) documents all but one of the capabilities |
| 558 |
recognized by |
| 559 |
.BR \%tic "." |
| 560 |
The exception is the |
| 561 |
.B use |
| 562 |
capability, |
| 563 |
which enables a terminal type description to incorporate others |
| 564 |
by reference. |
| 565 |
.PP |
| 566 |
.B \%tic |
| 567 |
serially reads and compiles terminal type descriptions; |
| 568 |
at any given time, |
| 569 |
the program compiles at most one |
| 570 |
.I current |
| 571 |
entry. |
| 572 |
.\" That is, tic doesn't recursively compile entries to resolve "use=". |
| 573 |
When |
| 574 |
.B \%tic |
| 575 |
encounters a |
| 576 |
.BI use= entry-name |
| 577 |
field in the current entry, |
| 578 |
it reads the compiled description of |
| 579 |
.I entry-name |
| 580 |
from |
| 581 |
.I \%/etc/terminfo |
| 582 |
to complete the current entry. |
| 583 |
If |
| 584 |
.B \%tic |
| 585 |
has already compiled a description of |
| 586 |
.I entry-name |
| 587 |
preceding the current entry in |
| 588 |
.IR file "," |
| 589 |
.B \%tic |
| 590 |
uses it preferentially. |
| 591 |
.\" XXX: Check this--tic doesn't read ahead in or index the input file, |
| 592 |
.\" does it? Otherwise this feature would break when reading from a |
| 593 |
.\" pipe. --GBR |
| 594 |
.B \%tic |
| 595 |
duplicates the capabilities in |
| 596 |
.I entry-name |
| 597 |
for the current entry, |
| 598 |
excepting those that the current entry explicitly defines. |
| 599 |
The foregoing has implications for capability cancellation. |
| 600 |
When |
| 601 |
.I entry-1 |
| 602 |
declares |
| 603 |
.RB \*(`` use=\c |
| 604 |
.IR entry-2 \*(``, |
| 605 |
any canceled capabilities in |
| 606 |
.I entry-2 |
| 607 |
must also appear in |
| 608 |
.I entry-1 |
| 609 |
prior to |
| 610 |
.RB \*(`` use=\c |
| 611 |
.IR entry-2 \*(`` |
| 612 |
for these capabilities to be canceled in |
| 613 |
.IR entry-1 "." |
| 614 |
.PP |
| 615 |
Compiled entries cannot exceed |
| 616 |
4096 bytes in the legacy storage format, |
| 617 |
or |
| 618 |
32768 using the extended number format. |
| 619 |
The name field cannot |
| 620 |
exceed 512 bytes. |
| 621 |
Terminal names exceeding the maximum alias length |
| 622 |
(32 characters on systems with long filenames, 14 characters otherwise) |
| 623 |
will be truncated to the maximum alias length |
| 624 |
and a warning message will be printed. |
| 625 |
.SH FILES |
| 626 |
.TP |
| 627 |
.I /etc/terminfo |
| 628 |
compiled terminal description database |
| 629 |
.SH NOTES |
| 630 |
There is some evidence that historic |
| 631 |
.B \%tic |
| 632 |
implementations treated |
| 633 |
description fields with no whitespace in them as additional aliases or |
| 634 |
short names. |
| 635 |
This |
| 636 |
.B \%tic |
| 637 |
does not do that, but it does warn when |
| 638 |
description fields may be treated that way and check them for dangerous |
| 639 |
characters. |
| 640 |
.SH EXTENSIONS |
| 641 |
Unlike the SVr4 |
| 642 |
.I tic |
| 643 |
command, |
| 644 |
.I \%ncurses |
| 645 |
.I tic |
| 646 |
can compile |
| 647 |
.I termcap |
| 648 |
sources. |
| 649 |
In fact, |
| 650 |
entries in |
| 651 |
.I \%term\%info |
| 652 |
and |
| 653 |
.I termcap |
| 654 |
syntax can be mixed in a single source file. |
| 655 |
See \fBterminfo\fP(5) for the list of |
| 656 |
.I termcap |
| 657 |
capability names |
| 658 |
.I \%ncurses |
| 659 |
.B \%tic |
| 660 |
treats as equivalent to |
| 661 |
.I \%term\%info |
| 662 |
names. |
| 663 |
.PP |
| 664 |
The SVr4 man pages are not clear on the resolution rules for |
| 665 |
.RB \*(`` use \*('' |
| 666 |
capabilities. |
| 667 |
.IR ncurses 's |
| 668 |
.B \%tic |
| 669 |
finds |
| 670 |
.RB \*(`` use \*('' |
| 671 |
targets anywhere in the source file, |
| 672 |
or anywhere in the file tree rooted at the location in the |
| 673 |
.I \%TERMINFO |
| 674 |
environment variable |
| 675 |
(if |
| 676 |
.I \%TERMINFO |
| 677 |
is defined), |
| 678 |
or in the user's |
| 679 |
.I \%$HOME/.terminfo |
| 680 |
database |
| 681 |
(if it exists), |
| 682 |
or (finally) anywhere in the system's collection of compiled entries. |
| 683 |
.PP |
| 684 |
The error messages from |
| 685 |
.I \%ncurses |
| 686 |
.B \%tic |
| 687 |
have the same format as GNU C error messages, |
| 688 |
and can be parsed by GNU Emacs's \*(``compile\*('' facility. |
| 689 |
.PP |
| 690 |
Aside from |
| 691 |
.B \-c |
| 692 |
and |
| 693 |
.BR \-v "," |
| 694 |
options are not portable. |
| 695 |
.bP |
| 696 |
Most of |
| 697 |
.I \%ncurses |
| 698 |
.BR \%tic 's |
| 699 |
options are not supported by SVr4 |
| 700 |
.IR tic "." |
| 701 |
.PP |
| 702 |
.RS |
| 703 |
.B \-0 |
| 704 |
.B \-1 |
| 705 |
.B \-C |
| 706 |
.B \-G |
| 707 |
.B \-I |
| 708 |
.B \-N |
| 709 |
.B \-R |
| 710 |
.B \-T |
| 711 |
.B \-V |
| 712 |
.B \-a |
| 713 |
.B \-e |
| 714 |
.B \-f |
| 715 |
.B \-g |
| 716 |
.B \-o |
| 717 |
.B \-r |
| 718 |
.B \-s |
| 719 |
.B \-t |
| 720 |
.B \-x |
| 721 |
.RE |
| 722 |
.bP |
| 723 |
NetBSD |
| 724 |
.I tic |
| 725 |
supports a few of the |
| 726 |
.I \%ncurses |
| 727 |
.B \%tic |
| 728 |
options. |
| 729 |
.PP |
| 730 |
.RS |
| 731 |
.B \-a |
| 732 |
.B \-o |
| 733 |
.B \-x |
| 734 |
.RE |
| 735 |
.bP |
| 736 |
NetBSD |
| 737 |
.I tic |
| 738 |
also adds |
| 739 |
.BR \-S "," |
| 740 |
a feature which does the same thing as |
| 741 |
.I \%ncurses |
| 742 |
.BR \%infocmp 's |
| 743 |
.B \-e |
| 744 |
and |
| 745 |
.B \-E |
| 746 |
options. |
| 747 |
.PP |
| 748 |
SVr4 |
| 749 |
.IR tic 's |
| 750 |
.B \-c |
| 751 |
mode does not report bad |
| 752 |
.RB \*(`` use \*('' |
| 753 |
links. |
| 754 |
.PP |
| 755 |
SVr4 does not compile entries to |
| 756 |
or read entries from your |
| 757 |
.I \%$HOME/.terminfo |
| 758 |
database unless the |
| 759 |
.I \%TERMINFO |
| 760 |
environment variable is explicitly set to it. |
| 761 |
.SH PORTABILITY |
| 762 |
X/Open Curses Issue\ 7 (2009) provides a brief description of \fBtic\fP. |
| 763 |
It lists one option: \fB\-c\fP. |
| 764 |
The omission of \fB\-v\fP is unexpected. |
| 765 |
The change history states that the description is derived from Tru64. |
| 766 |
According to its manual pages, that system also supported the \fB\-v\fP option. |
| 767 |
.PP |
| 768 |
Shortly after Issue\ 7 was released, Tru64 was discontinued. |
| 769 |
As of 2019, the surviving implementations of \fBtic\fP |
| 770 |
are SVr4 (AIX, HP-UX and Solaris), |
| 771 |
\fI\%ncurses\fP |
| 772 |
and NetBSD curses. |
| 773 |
The SVr4 \fBtic\fP programs all support the \fB\-v\fP option. |
| 774 |
The NetBSD \fBtic\fP program follows X/Open's documentation, |
| 775 |
omitting the \fB\-v\fP option. |
| 776 |
.PP |
| 777 |
The X/Open rationale states that some implementations of \fBtic\fP |
| 778 |
read terminal descriptions from the standard input if the \fIfile\fP |
| 779 |
parameter is omitted. |
| 780 |
None of these implementations do that. |
| 781 |
Further, it comments that some may choose to read from \*(''./terminfo.src\*('' |
| 782 |
but that is obsolescent behavior from SVr2, |
| 783 |
and is not (for example) a documented feature of SVr3. |
| 784 |
.SH HISTORY |
| 785 |
System V Release 2 provided a \fBtic\fP utility. |
| 786 |
It accepted a single option: \fB\-v\fP (optionally followed by a number). |
| 787 |
According to Ross Ridge's comment in \fImytinfo\fP, |
| 788 |
this version of \fBtic\fP was |
| 789 |
unable to represent canceled capabilities. |
| 790 |
.PP |
| 791 |
System V Release 3 provided a different \fBtic\fP utility, |
| 792 |
written by Pavel Curtis, |
| 793 |
(originally named \*(``compile\*('' in \fIpcurses\fP). |
| 794 |
This added an option \fB\-c\fP to check the file for |
| 795 |
errors, with the caveat that errors in \*(``use=\*('' links |
| 796 |
would not be reported. |
| 797 |
System V Release 3 documented a few warning messages which |
| 798 |
did not appear in \fIpcurses\fP. |
| 799 |
While the program itself was changed little as development |
| 800 |
continued with System V Release 4, |
| 801 |
the table of capabilities grew from 180 (\fIpcurses\fP) to 464 (Solaris). |
| 802 |
.PP |
| 803 |
In early development of \fI\%ncurses\fP (1993), |
| 804 |
Zeyd Ben-Halim used the table from \fImytinfo\fP to |
| 805 |
extend the \fIpcurses\fP table to 469 capabilities |
| 806 |
(456 matched SVr4, 8 were only in SVr4, 13 were not in SVr4). |
| 807 |
Of those 13, 11 were ultimately discarded |
| 808 |
(perhaps to match the draft of X/Open Curses). |
| 809 |
The exceptions were |
| 810 |
\fB\%memory_lock_above\fP and |
| 811 |
\fB\%memory_unlock\fP (see \fB\%user_caps\fP(5)). |
| 812 |
.PP |
| 813 |
Eric Raymond incorporated parts of \fImytinfo\fP into \fI\%ncurses\fP |
| 814 |
to implement the termcap-to-terminfo source conversion, |
| 815 |
and extended that to begin development of |
| 816 |
the corresponding terminfo-to-termcap source conversion, |
| 817 |
Thomas Dickey completed that development over the course of several years. |
| 818 |
.PP |
| 819 |
In 1999, Thomas Dickey added the \fB\-x\fP option |
| 820 |
to support user-defined capabilities. |
| 821 |
.PP |
| 822 |
In 2010, Roy Marples provided a \fBtic\fP program |
| 823 |
and terminfo library for NetBSD. |
| 824 |
That implementation adapts several features from \fI\%ncurses\fP, |
| 825 |
including |
| 826 |
.BR \%tic 's |
| 827 |
\fB\-x\fP option. |
| 828 |
.PP |
| 829 |
The \fB\-c\fP option tells |
| 830 |
.B \%tic |
| 831 |
to check for problems in the |
| 832 |
terminfo source file. |
| 833 |
Continued development provides additional checks: |
| 834 |
.bP |
| 835 |
.I pcurses |
| 836 |
had 8 warnings. |
| 837 |
.bP |
| 838 |
.I \%ncurses |
| 839 |
in 1996 had 16 warnings. |
| 840 |
.bP |
| 841 |
Solaris (SVr4) |
| 842 |
.I curses |
| 843 |
has 28 warnings. |
| 844 |
.bP |
| 845 |
NetBSD |
| 846 |
.I tic |
| 847 |
in 2019 has 19 warnings. |
| 848 |
.bP |
| 849 |
.I \%ncurses |
| 850 |
in 2019 has 96 warnings. |
| 851 |
.PP |
| 852 |
The checking done in |
| 853 |
.IR \%ncurses 's |
| 854 |
.B \%tic |
| 855 |
helps with the |
| 856 |
conversion to termcap, |
| 857 |
as well as pointing out errors and inconsistencies. |
| 858 |
It is also used to ensure consistency with the user-defined capabilities. |
| 859 |
There are 527 distinct capabilities in |
| 860 |
.IR \%ncurses 's |
| 861 |
terminal database; |
| 862 |
128 of those are user-defined. |
| 863 |
.SH AUTHORS |
| 864 |
Eric S. Raymond <[email protected]> |
| 865 |
and |
| 866 |
.br |
| 867 |
Thomas E. Dickey <dickey@invisible\-island.net> |
| 868 |
.SH SEE ALSO |
| 869 |
\fB\%captoinfo\fP(1), |
| 870 |
\fB\%infocmp\fP(1), |
| 871 |
\fB\%infotocap\fP(1), |
| 872 |
\fB\%toe\fP(1), |
| 873 |
\fB\%ncurses\fP(3NCURSES), |
| 874 |
\fB\%term\fP(5), |
| 875 |
\fB\%terminfo\fP(5), |
| 876 |
\fB\%user_caps\fP(5) |