summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/tic.1m.html
diff options
context:
space:
mode:
Diffstat (limited to 'ncurses-5.2/doc/html/man/tic.1m.html')
-rw-r--r--ncurses-5.2/doc/html/man/tic.1m.html297
1 files changed, 297 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/tic.1m.html b/ncurses-5.2/doc/html/man/tic.1m.html
new file mode 100644
index 0000000..eddb819
--- /dev/null
+++ b/ncurses-5.2/doc/html/man/tic.1m.html
@@ -0,0 +1,297 @@
+<HTML>
+<BODY>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <B>tic</B> - the <I>terminfo</I> entry-description compiler
+
+
+</PRE>
+<H2>SYNOPSIS</H2><PRE>
+ <B>tic</B> [<B>-1CINRTVacfrsx</B>] [<B>-e</B> <I>names</I>] [<B>-o</B> <I>dir</I>] [<B>-v</B>[<I>n</I>]] [<B>-w</B>[<I>n</I>]]
+ <I>file</I>
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+ The command <B>tic</B> translates a <B>terminfo</B> file from source
+ format into compiled format. The compiled format is nec-
+ essary for use with the library routines in <B><A HREF="ncurses.3x.html">ncurses(3x)</A></B>.
+
+ The results are normally placed in the system terminfo
+ directory <B>/usr/share/terminfo</B>. There are two ways to
+ change this behavior.
+
+ First, you may override the system default by setting the
+ variable <B>TERMINFO</B> in your shell environment to a valid
+ (existing) directory name.
+
+ Secondly, if <B>tic</B> cannot get access to <I>/usr/share/terminfo</I>
+ or your TERMINFO directory, it looks for the directory
+ <I>$HOME/.terminfo</I>; if that directory exists, the entry is
+ placed there.
+
+ Libraries that read terminfo entries are expected to check
+ for a TERMINFO directory first, look at <I>$HOME/.terminfo</I> if
+ TERMINFO is not set, and finally look in <I>/usr/share/ter-</I>
+ <I>minfo</I>.
+
+ <B>-a</B> tells <B>tic</B> to retain commented-out capabilities
+ rather than discarding them. Capabilities are com-
+ mented by prefixing them with a period. This sets
+ the <B>-x</B> option, because it treats the commented-out
+ entries as user-defined names.
+
+ <B>-c</B> tells <B>tic</B> to only check <I>file</I> for errors, including
+ syntax problems and bad use links. If you specify
+ <B>-C</B> (<B>-I</B>) with this option, the code will print warn-
+ ings 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.
+
+ <B>-v</B><I>n</I> specifies that (verbose) output be written to stan-
+ dard error trace information showing <B>tic</B>'s
+ progress. The optional integer <I>n</I> is a number from
+ 1 to 10, inclusive, indicating the desired level of
+ detail of information. If <I>n</I> is omitted, the
+ default level is 1. If <I>n</I> is specified and greater
+ than 1, the level of detail is increased.
+
+ <B>-o</B><I>dir</I> Write compiled entries to given directory.
+ Overrides the TERMINFO environment variable.
+
+ <B>-w</B><I>n</I> specifies the width of the output.
+
+ <B>-1</B> restricts the output to a single column
+
+ <B>-C</B> Force source translation to termcap format. Note:
+ this differs from the -C option of <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B> 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.
+
+ <B>-G</B> Display constant literals in decimal form rather
+ than their character equivalents.
+
+ <B>-I</B> Force source translation to terminfo format.
+
+ <B>-L</B> Force source translation to terminfo format using
+ the long C variable names listed in &lt;<B>term.h</B>&gt;
+
+ <B>-N</B> Disable smart defaults. Normally, when translating
+ from termcap to terminfo, the compiler makes a num-
+ ber of assumptions about the defaults of string
+ capabilities <B>reset1_string</B>, <B>carriage_return</B>, <B>cur-</B>
+ <B>sor_left</B>, <B>cursor_down</B>, <B>scroll_forward</B>, <B>tab</B>, <B>new-</B>
+ <B>line</B>, <B>key_backspace</B>, <B>key_left</B>, and <B>key_down</B>, then
+ attempts to use obsolete termcap capabilities to
+ deduce correct values. It also normally suppresses
+ output of obsolete termcap capabilities such as <B>bs</B>.
+ This option forces a more literal translation that
+ also preserves the obsolete capabilities.
+
+ <B>-R</B><I>subset</I>
+ 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 don't support
+ the full set of SVR4/XSI Curses terminfo; and out-
+ right 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 <B><A HREF="terminfo.5.html">terminfo(5)</A></B> for details.
+
+ <B>-T</B> 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 terminfo).
+
+ <B>-V</B> reports the version of ncurses which was used in
+ this program, and exits.
+
+ <B>-r</B> Force entry resolution (so there are no remaining
+ tc capabilities) 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 up to version 1.3 or BSD term-
+ cap up to 4.3BSD) that doesn't handle multiple tc
+ capabilities per entry.
+
+ <B>-e</B> 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 con-
+ taining the list if it contains a '/'. (Note:
+ depending on how tic was compiled, this option may
+ require -I or -C.)
+
+ <B>-f</B> Display complex terminfo strings which contain
+ if/then/else/endif expressions indented for read-
+ ability.
+
+ <B>-g</B> Display constant character literals in quoted form
+ rather than their decimal equivalents.
+
+ <B>-s</B> Summarize the compile by showing the directory into
+ which entries are written, and the number of
+ entries which are compiled.
+
+ <B>-x</B> Treat unknown capabilities as user-defined. That
+ is, if you supply a capability name which <B>tic</B> does
+ not recognize, it will infer its type (boolean,
+ number or string) from the syntax and make an
+ extended table entry for that.
+
+ <I>file</I> contains one or more <B>terminfo</B> terminal descriptions
+ in source format [see <B><A HREF="terminfo.5.html">terminfo(5)</A></B>]. Each descrip-
+ tion 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 n is not given, it is taken to be one.
+
+ All but one of the capabilities recognized by <B>tic</B> are doc-
+ umented in <B><A HREF="terminfo.5.html">terminfo(5)</A></B>. The exception is the <B>use</B> capabil-
+ ity.
+
+ When a <B>use</B>=<I>entry</I>-<I>name</I> field is discovered in a terminal
+ entry currently being compiled, <B>tic</B> reads in the binary
+ from <B>/usr/share/terminfo</B> to complete the entry. (Entries
+ created from <I>file</I> will be used first. If the environment
+ variable <B>TERMINFO</B> is set, that directory is searched
+ instead of <B>/usr/share/terminfo</B>.) <B>tic</B> duplicates the capa-
+ bilities in <I>entry</I>-<I>name</I> for the current entry, with the
+ exception of those capabilities that explicitly are
+ defined in the current entry.
+
+ When an entry, e.g., <B>entry_name_1</B>, contains a
+ <B>use=</B><I>entry</I>_<I>name</I>_<I>2</I> field, any canceled capabilities in
+ <I>entry</I>_<I>name</I>_<I>2</I> must also appear in <B>entry_name_1</B> before <B>use=</B>
+ for these capabilities to be canceled in <B>entry_name_1</B>.
+
+ If the environment variable <B>TERMINFO</B> is set, the compiled
+ results are placed there instead of <B>/usr/share/terminfo</B>.
+
+ 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.
+
+
+</PRE>
+<H2>COMPATIBILITY</H2><PRE>
+ There is some evidence that historic <B>tic</B> implementations
+ treated description fields with no whitespace in them as
+ additional aliases or short names. This <B>tic</B> does not do
+ that, but it does warn when description fields may be
+ treated that way and check them for dangerous characters.
+
+
+</PRE>
+<H2>EXTENSIONS</H2><PRE>
+ Unlike the stock SVr4 <B>tic</B> command, this implementation can
+ actually compile termcap sources. In fact, entries in
+ terminfo and termcap syntax can be mixed in a single
+ source file. See <B><A HREF="terminfo.5.html">terminfo(5)</A></B> 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 <B>use</B> capabilities. This implementation of <B>tic</B>
+ will find <B>use</B> targets anywhere in the source file, or any-
+ where in the file tree rooted at <B>TERMINFO</B> (if <B>TERMINFO</B> is
+ defined), or in the user's <I>$HOME/.terminfo</I> directory (if
+ it exists), or (finally) anywhere in the system's file
+ tree of compiled entries.
+
+ The error messages from this <B>tic</B> have the same format as
+ GNU C error messages, and can be parsed by GNU Emacs's
+ compile facility.
+
+ The <B>-C</B>, <B>-G</B>, <B>-I</B>, <B>-N</B>, <B>-R</B>, <B>-T</B>, <B>-V</B>, <B>-a</B>, <B>-e</B>, <B>-f</B>, <B>-g</B>, <B>-o</B>, <B>-r</B>, <B>-s</B>
+ and <B>-x</B> options are not supported under SVr4. The SVr4 -c
+ mode does not report bad use links.
+
+ System V does not compile entries to or read entries from
+ your <I>$HOME/.terminfo</I> directory unless TERMINFO is explic-
+ itly set to it.
+
+
+</PRE>
+<H2>FILES</H2><PRE>
+ <B>/usr/share/terminfo/?/*</B>
+ Compiled terminal description database.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <B><A HREF="infocmp.1m.html">infocmp(1m)</A></B>, <B><A HREF="captoinfo.1m.html">captoinfo(1m)</A></B>, <B><A HREF="infotocap.1m.html">infotocap(1m)</A></B>, <B><A HREF="toe.1m.html">toe(1m)</A></B>,
+ <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>