Manual Pages for UNIX Darwin command on man tic

tic(1M) tic(1M)

NAME

ttiicc - the terminfo entry-description compiler

SYNOPSIS

ttiicc [-11CCGGIILLNNTTVVaaccffggrrssttxx] [-ee names] [-oo dir] [-RR subset] [-vv[n]] [-ww[n]]

file

DESCRIPTION

The command ttiicc translates a tteerrmmiinnffoo file from source format into com-

piled format. The compiled format is necessary for use with the library routines in nnccuurrsseess(3X). The results are normally placed in the system terminfo directory //uussrr//sshhaarree//tteerrmmiinnffoo. There are two ways to change this behavior.

First, you may override the system default by setting the variable TTEERR-

MMIINNFFOO in your shell environment to a valid (existing) directory name.

Secondly, if ttiicc cannot get access to /usr/share/terminfo or your TER-

MINFO directory, it looks for the directory $HOME/.terminfo; if that

directory exists, the entry is placed there.

Libraries that read terminfo entries are expected to check for a TER-

MINFO directory first, look at $HOME/.terminfo if TERMINFO is not set,

and finally look in /usr/share/terminfo.

-11 restricts the output to a single column

-aa tells ttiicc to retain commented-out capabilities rather than dis-

carding them. Capabilities are commented by prefixing them with

a period. This sets the -xx option, because it treats the com-

mented-out entries as user-defined names. If the source is

termcap, accept the 2-character names required by version 6.

Otherwise these are ignored.

-CC Force source translation to termcap format. Note: this differs

from the -CC option of infocmp(1M) in that it does not merely

translate capability names, but also translates terminfo strings to termcap format. Capabilities that are not translatable are left in the entry under their terminfo names but commented out with two preceding dots.

-cc tells ttiicc to only check file for errors, including syntax prob-

lems and bad use links. If you specify -CC (-II) with this

option, the code will print warnings about entries which, after use resolution, are more than 1023 (4096) bytes long. Due to a fixed buffer length in older termcap libraries (and a documented limit in terminfo), these entries may cause core dumps.

-ee names

Limit writes and translations to the following comma-separated

list of terminals. If any name or alias of a terminal matches one of the names in the list, the entry will be written or translated as normal. Otherwise no output will be generated for it. The option value is interpreted as a file containing the

list if it contains a '/'. (Note: depending on how tic was com-

piled, this option may require -II or -CC.)

-ff Display complex terminfo strings which contain

if/then/else/endif expressions indented for readability.

-GG Display constant literals in decimal form rather than their

character equivalents.

-gg Display constant character literals in quoted form rather than

their decimal equivalents.

-II Force source translation to terminfo format.

-LL Force source translation to terminfo format using the long C

variable names listed in

-NN Disable smart defaults. Normally, when translating from termcap

to terminfo, the compiler makes a number of assumptions about

the defaults of string capabilities rreesseett11ssttrriinngg, ccaarr-

rriiaaggeerreettuurrnn, ccuurrssoorrlleefftt, ccuurrssoorrddoowwnn, ssccrroollllffoorrwwaarrdd, ttaabb, nneewwlliinnee, kkeeyybbaacckkssppaaccee, kkeeyylleefftt, and kkeeyyddoowwnn, then attempts to use obsolete termcap capabilities to deduce correct values. It also normally suppresses output of obsolete termcap capabilities such as bbss. This option forces a more literal translation that also preserves the obsolete capabilities.

-oodir Write compiled entries to given directory. Overrides the TER-

MINFO environment variable.

-RRsubset

Restrict output to a given subset. This option is for use with archaic versions of terminfo like those on SVr1, Ultrix, or

HP/UX that do not support the full set of SVR4/XSI Curses ter-

minfo; and outright broken ports like AIX 3.x that have their own extensions incompatible with SVr4/XSI. Available subsets are "SVr1", "Ultrix", "HP", "BSD" and "AIX"; see tteerrmmiinnffoo(5) for details.

-rr Force entry resolution (so there are no remaining tc capabili-

ties) even when doing translation to termcap format. This may be needed if you are preparing a termcap file for a termcap library (such as GNU termcap through version 1.3 or BSD termcap through 4.3BSD) that does not handle multiple tc capabilities per entry.

-ss Summarize the compile by showing the directory into which

entries are written, and the number of entries which are com-

piled.

-TT eliminates size-restrictions on the generated text. This is

mainly useful for testing and analysis, since the compiled

descriptions are limited (e.g., 1023 for termcap, 4096 for ter-

minfo).

-tt tells ttiicc to discard commented-out capabilities. Normally when

translating from terminfo to termcap, untranslatable capabili-

ties are commented-out.

-VV reports the version of ncurses which was used in this program,

and exits.

-vvn specifies that (verbose) output be written to standard error

trace information showing ttiicc's progress. The optional integer n is a number from 1 to 10, inclusive, indicating the desired level of detail of information. If n is omitted, the default level is 1. If n is specified and greater than 1, the level of detail is increased.

-wwn specifies the width of the output.

-xx Treat unknown capabilities as user-defined. That is, if you

supply a capability name which ttiicc does not recognize, it will infer its type (boolean, number or string) from the syntax and

make an extended table entry for that. User-defined capability

strings whose name begins with ``k'' are treated as function keys. file contains one or more tteerrmmiinnffoo terminal descriptions in source format [see tteerrmmiinnffoo(5)]. Each description in the file

describes the capabilities of a particular terminal.

The debug flag levels are as follows: 1 Names of files created and linked 2 Information related to the ``use'' facility

3 Statistics from the hashing algorithm

5 String-table memory allocations

7 Entries into the string-table

8 List of tokens encountered by scanner 9 All values computed in construction of the hash table If the debug level n is not given, it is taken to be one. All but one of the capabilities recognized by ttiicc are documented in tteerrmmiinnffoo(5). The exception is the uussee capability.

When a uussee=entry-name field is discovered in a terminal entry currently

being compiled, ttiicc reads in the binary from //uussrr//sshhaarree//tteerrmmiinnffoo to complete the entry. (Entries created from file will be used first. If the environment variable TTEERRMMIINNFFOO is set, that directory is searched instead of //uussrr//sshhaarree//tteerrmmiinnffoo.) ttiicc duplicates the capabilities in

entry-name for the current entry, with the exception of those capabili-

ties that explicitly are defined in the current entry. When an entry, e.g., eennttrryynnaammee11, contains a uussee==entryname2 field, any canceled capabilities in entryname2 must also appear in eennttrryynnaammee11 before uussee== for these capabilities to be canceled in eennttrryynnaammee11. If the environment variable TTEERRMMIINNFFOO is set, the compiled results are placed there instead of //uussrr//sshhaarree//tteerrmmiinnffoo. Total compiled entries cannot exceed 4096 bytes. The name field cannot exceed 512 bytes. Terminal names exceeding the maximum alias length (32 characters on systems with long filenames, 14 characters otherwise) will be truncated to the maximum alias length and a warning message will be printed. CCOOMMPPAATTIIBBIILLIITTYY There is some evidence that historic ttiicc implementations treated description fields with no whitespace in them as additional aliases or

short names. This ttiicc does not do that, but it does warn when descrip-

tion fields may be treated that way and check them for dangerous char-

acters. EEXXTTEENNSSIIOONNSS Unlike the stock SVr4 ttiicc command, this implementation can actually

compile termcap sources. In fact, entries in terminfo and termcap syn-

tax can be mixed in a single source file. See tteerrmmiinnffoo(5) for the list of termcap names taken to be equivalent to terminfo names. The SVr4 manual pages are not clear on the resolution rules for uussee

capabilities. This implementation of ttiicc will find uussee targets any-

where in the source file, or anywhere in the file tree rooted at TTEERR-

MMIINNFFOO (if TTEERRMMIINNFFOO is defined), or in the user's $HOME/.terminfo direc-

tory (if it exists), or (finally) anywhere in the system's file tree of compiled entries. The error messages from this ttiicc have the same format as GNU C error messages, and can be parsed by GNU Emacs's compile facility.

The -CC, -GG, -II, -NN, -RR, -TT, -VV, -aa, -ee, -ff, -gg, -oo, -rr, -ss, -tt and -xx

options are not supported under SVr4. The SVr4 -cc mode does not report

bad use links. System V does not compile entries to or read entries from your

$HOME/.terminfo directory unless TERMINFO is explicitly set to it.

FILES //uussrr//sshhaarree//tteerrmmiinnffoo//??//** Compiled terminal description database.