tic.1: mdoc(7) conversion
authorFranco Fichtner <franco@lastsummer.de>
Sat, 14 Sep 2013 09:53:15 +0000 (11:53 +0200)
committerSascha Wildner <saw@online.de>
Fri, 4 Oct 2013 07:19:57 +0000 (09:19 +0200)
usr.bin/tic/tic.1

index 870fd60..1647090 100644 (file)
 .\"***************************************************************************
 .\"
 .\" $Id: tic.1m,v 1.47 2010/12/04 18:38:55 tom Exp $
-.TH tic 1 ""
-.ds n 5
-.ds d /usr/share/terminfo
-.SH NAME
-\fBtic\fR \- the \fIterminfo\fR entry-description compiler
-.SH SYNOPSIS
-\fBtic\fR
-[\fB\-\
-1\
-C\
-G\
-I\
-L\
-N\
-T\
-U\
-V\
-a\
-c\
-f\
-g\
-r\
-s\
-t\
-x\
-\fR]
-[\fB\-e\fR \fInames\fR]
-[\fB\-o\fR \fIdir\fR]
-[\fB\-R\fR \fIsubset\fR]
-[\fB\-v\fR[\fIn\fR]]
-[\fB\-w\fR[\fIn\fR]]
-\fIfile\fR
-.br
-.SH DESCRIPTION
-The command \fBtic\fR translates a \fBterminfo\fR file from source
-format into compiled format.
-The compiled format is necessary for use with
-the library routines in \fBncurses\fR(3).
-.PP
-The results are normally placed in the system terminfo
-directory \fB\*d\fR.
+.Dd September 14, 2013
+.Dt TIC 1
+.Os
+.Sh NAME
+.Nm tic
+.Nd the terminfo entry-description compiler
+.Sh SYNOPSIS
+.Nm
+.Op Fl 1CGILNTUVacfgrstx
+.Op Fl e Ar names
+.Op Fl o Ar dir
+.Op Fl R Ar subset
+.Op Fl v Ns Op Ar n
+.Op Fl w Ns Op Ar n
+.Ar file
+.Sh DESCRIPTION
+The command
+.Nm
+translates a
+.Xr terminfo 5
+file from source format into compiled format.
+The compiled format is necessary for use with the library routines in
+.Xr ncurses 3 .
+.Pp
+The results are normally placed in the system terminfo directory
+.Pa /usr/share/terminfo .
 There are two ways to change this behavior.
-.PP
+.Pp
 First, you may override the system default by setting the variable
-\fBTERMINFO\fR in your shell environment to a valid (existing) directory name.
-.PP
-Secondly, if \fBtic\fR cannot get access to \fI\*d\fR or your TERMINFO
-directory, it looks for the directory \fI$HOME/.terminfo\fR; if that directory
-exists, the entry is placed there.
-.PP
-Libraries that read terminfo entries are expected to check for a TERMINFO
-directory first, look at \fI$HOME/.terminfo\fR if TERMINFO is not set, and
-finally look in \fI\*d\fR.
-.TP
-\fB\-1\fR
+.Ev TERMINFO
+in your shell environment to a valid (existing) directory name.
+.Pp
+Secondly, if
+.Nm
+cannot get access to
+.Pa /usr/share/terminfo
+or your
+.Ev TERMINFO
+directory, it looks for the directory
+.Pa $HOME/.terminfo ;
+if that directory exists, the entry is placed there.
+.Pp
+Libraries that read terminfo entries are expected to check for a
+.Ev TERMINFO
+directory first, look at
+.Pa $HOME/.terminfo
+if
+.Ev TERMINFO
+is not set, and finally look in
+.Pa /usr/share/terminfo .
+.Bl -tag -width ".Fl R subset"
+.It Fl 1
 restricts the output to a single column
-.TP
-\fB\-a\fR
-tells \fBtic\fP to retain commented-out capabilities rather than discarding
-them.
+.It Fl a
+tells
+.Nm
+to retain commented-out capabilities rather than discarding them.
 Capabilities are commented by prefixing them with a period.
-This sets the \fB\-x\fR option, because it treats the commented-out
-entries as user-defined names.
+This sets the
+.Fl x
+option, because it treats the commented-out entries as user-defined names.
 If the source is termcap, accept the 2-character names required by version 6.
 Otherwise these are ignored.
-.TP
-\fB\-C\fR
+.It Fl C
 Force source translation to termcap format.
-Note: this differs from the \fB\-C\fR
-option of \fBinfocmp\fR(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.
-.TP
-\fB\-c\fR
-tells \fBtic\fP to only check \fIfile\fR for errors, including syntax problems and
-bad use links.
-If you specify \fB\-C\fR (\fB\-I\fR) 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.
-.TP
-\fB\-e \fR\fInames\fR
+Capabilities that are not translatable are left in the entry under
+their terminfo names but commented out with two preceding dots.
+.It Fl c
+tells
+.Nm
+to only check
+.Ar file
+for errors, including syntax problems and bad use links.
+If you specify
+.Fl C
+.Pq Fl I
+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.
+.It Fl e Ar 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 compiled, this option may require \fB\-I\fR or \fB\-C\fR.)
-.TP
-\fB\-f\fR
+contains a
+.Sq / .
+Note: depending on how
+.Nm
+was compiled, this option may require
+.Fl I
+or
+.Fl C .
+.It Fl f
 Display complex terminfo strings which contain if/then/else/endif expressions
 indented for readability.
-.TP
-\fB\-G\fR
+.It Fl G
 Display constant literals in decimal form
 rather than their character equivalents.
-.TP
-\fB\-g\fR
+.It Fl g
 Display constant character literals in quoted form
 rather than their decimal equivalents.
-.TP
-\fB\-I\fR
+.It Fl I
 Force source translation to terminfo format.
-.TP
-\fB\-L\fR
+.It Fl L
 Force source translation to terminfo format
-using the long C variable names listed in <\fBterm.h\fR>
-.TP
-\fB\-N\fR
+using the long C variable names listed in
+.In term.h
+.It Fl N
 Disable smart defaults.
 Normally, when translating from termcap to terminfo, the compiler makes
 a number of assumptions about the defaults of string capabilities
-\fBreset1_string\fR, \fBcarriage_return\fR, \fBcursor_left\fR,
-\fBcursor_down\fR, \fBscroll_forward\fR, \fBtab\fR, \fBnewline\fR,
-\fBkey_backspace\fR, \fBkey_left\fR, and \fBkey_down\fR, then attempts
-to use obsolete termcap capabilities to deduce correct values.
-It also
-normally suppresses output of obsolete termcap capabilities such as \fBbs\fR.
+.Cm reset1_string ,
+.Cm carriage_return ,
+.Cm cursor_left ,
+.Cm cursor_down ,
+.Cm scroll_forward ,
+.Cm tab ,
+.Cm newline ,
+.Cm key_backspace ,
+.Cm key_left ,
+and
+.Cm key_down ,
+then attempts to use obsolete termcap capabilities to deduce correct values.
+It also normally suppresses output of obsolete termcap capabilities such as
+.Cm bs .
 This option forces a more literal translation that also preserves the
 obsolete capabilities.
-.TP
-\fB\-o\fR\fIdir\fR
+.It Fl o Ar dir
 Write compiled entries to given directory.
-Overrides the TERMINFO environment
-variable.
-.TP
-\fB\-R\fR\fIsubset\fR
+Overrides the
+.Ev TERMINFO
+environment variable.
+.It Fl R Ar subset
 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 terminfo; and outright broken ports like AIX 3.x
+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 terminfo;
+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 \fBterminfo\fR(\*n) for details.
-.TP
-\fB\-r\fR
+Available subsets are
+.Dq SVr1 ,
+.Dq Ultrix ,
+.Dq HP ,
+.Dq BSD
+and
+.Dq AIX ;
+see
+.Xr terminfo 5
+for details.
+.It Fl r
 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 through
-version 1.3 or BSD termcap through 4.3BSD) that does not handle multiple
-tc capabilities per entry.
-.TP
-\fB\-s\fR
+version 1.3 or BSD termcap through
+.Bx 4.3 )
+that does not handle multiple tc capabilities per entry.
+.It Fl s
 Summarize the compile by showing the directory into which entries
 are written, and the number of entries which are compiled.
-.TP
-\fB\-T\fR
+.It Fl T
 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).
-.TP
-\fB\-t\fR
-tells \fBtic\fP to discard commented-out capabilities.
+descriptions are limited (e.g. 1023 for termcap, 4096 for terminfo).
+.It Fl t
+tells
+.Nm
+to discard commented-out capabilities.
 Normally when translating from terminfo to termcap,
 untranslatable capabilities are commented-out.
-.TP 5
-\fB\-U\fR
-tells \fBtic\fP to not post-process the data after parsing the source file.
+.It Fl U
+tells
+.Nm
+to not post-process the data after parsing the source file.
 Normally, it infers data which is commonly missing in older terminfo data,
 or in termcaps.
-.TP
-\fB\-V\fR
-reports the version of ncurses which was used in this program, and exits.
-.TP
-\fB\-v\fR\fIn\fR
+.It Fl V
+reports the version of
+.Xr ncurses 3
+which was used in this program, and exits.
+.It Fl v Ns Op Ar n
 specifies that (verbose) output be written to standard error trace
-information showing \fBtic\fR's progress.
-The optional parameter \fIn\fR is a number from 1 to 10, inclusive,
+information showing
+.Nm Ns 's
+progress.
+The optional parameter
+.Ar n
+is a number from 1 to 10, inclusive,
 indicating the desired level of detail of information.
-If \fIn\fR is omitted, the default level is 1.
-If \fIn\fR is specified and greater than 1, the level of
+If
+.Ar n
+is omitted, the default level is 1.
+If
+.Ar n
+is specified and greater than 1, the level of
 detail is increased.
-.TP
-\fB\-w\fR\fIn\fR
+.It Fl w Ns Op Ar n
 specifies the width of the output.
 The parameter is optional.
 If it is omitted, it defaults to 60.
-.TP
-\fB\-x\fR
+.It Fl x
 Treat unknown capabilities as user-defined.
-That is, if you supply a capability name which \fBtic\fP does not recognize,
-it will infer its type (boolean, number or string) from the syntax and
-make an extended table entry for that.
+That is, if you supply a capability name which
+.Nm
+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.
-.TP
-\fIfile\fR
-contains one or more \fBterminfo\fR terminal descriptions in source
-format [see \fBterminfo\fR(\*n)].
+whose name begins with
+.Sq k
+are treated as function keys.
+.Ar file
+contains one or more
+.Xr terminfo 5
+terminal descriptions in source format.
 Each description in the file
 describes the capabilities of a particular terminal.
-.PP
+.El
+.Pp
 The debug flag levels are as follows:
-.TP
-1
+.Bl -tag -width "1xxx"
+.It 1
 Names of files created and linked
-.TP
-2
-Information related to the ``use'' facility
-.TP
-3
+.It 2
+Information related to the
+.Dq use
+facility
+.It 3
 Statistics from the hashing algorithm
-.TP
-5
+.It 5
 String-table memory allocations
-.TP
-7
+.It 7
 Entries into the string-table
-.TP
-8
+.It 8
 List of tokens encountered by scanner
-.TP
-9
+.It 9
 All values computed in construction of the hash table
-.LP
-If the debug level \fIn\fR is not given, it is taken to be one.
-.PP
-All but one of the capabilities recognized by \fBtic\fR are documented
-in \fBterminfo\fR(\*n).
-The exception is the \fBuse\fR capability.
-.PP
-When a \fBuse\fR=\fIentry\fR\-\fIname\fR field is discovered in a
-terminal entry currently being compiled, \fBtic\fR reads in the binary
-from \fB\*d\fR to complete the entry.
+.El
+.Pp
+If the debug level
+.Ar n
+is not given, it is taken to be one.
+.Pp
+All but one of the capabilities recognized by
+.Nm
+are documented in
+.Xr terminfo 5 .
+The exception is the
+.Cm use
+capability.
+.Pp
+When a
+.Cm use Ns Li = Ns Ar entry-name
+field is discovered in a terminal entry currently being compiled,
+.Nm
+reads in the binary from
+.Pa /usr/share/terminfo
+to complete the entry.
 (Entries created from
-\fIfile\fR will be used first.
+.Ar file
+will be used first.
 If the environment variable
-\fBTERMINFO\fR is set, that directory is searched instead of
-\fB\*d\fR.)  \fBtic\fR duplicates the capabilities in
-\fIentry\fR\-\fIname\fR for the current entry, with the exception of
+.Ev TERMINFO
+is set, that directory is searched instead of
+.Pa /usr/share/terminfo . )
+.Nm
+duplicates the capabilities in
+.Ar entry-name
+for the current entry, with the exception of
 those capabilities that explicitly are defined in the current entry.
-.PP
-When an entry, e.g., \fBentry_name_1\fR, contains a
-\fBuse=\fR\fIentry\fR_\fIname\fR_\fI2\fR field, any canceled
-capabilities in \fIentry\fR_\fIname\fR_\fI2\fR must also appear in
-\fBentry_name_1\fR before \fBuse=\fR for these capabilities to be
-canceled in \fBentry_name_1\fR.
-.PP
-If the environment variable \fBTERMINFO\fR is set, the compiled
-results are placed there instead of \fB\*d\fR.
-.PP
+.Pp
+When an entry, e.g.\&
+.Li entry_name_1 ,
+contains a
+.Cm use Ns Li = Ns Li entry_name_2
+field, any canceled capabilities in
+.Li entry_name_2
+must also appear in
+.Li entry_name_1
+before
+.Cm use Ns Li =
+for these capabilities to be canceled in
+.Li entry_name_1 .
+.Pp
+If the environment variable
+.Ev TERMINFO
+is set, the compiled results are placed there instead of
+.Pa /usr/share/terminfo .
+.Pp
 Total compiled entries cannot exceed 4096 bytes.
-The name field cannot
-exceed 512 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.
-.SH COMPATIBILITY
-There is some evidence that historic \fBtic\fR implementations treated
-description fields with no whitespace in them as additional aliases or
-short names.
-This \fBtic\fR does not do that, but it does warn when
-description fields may be treated that way and check them for dangerous
-characters.
-.SH EXTENSIONS
-Unlike the stock SVr4 \fBtic\fR command, this implementation can actually
-compile termcap sources.
+will be truncated to the maximum alias length and a warning message
+will be printed.
+.Ss COMPATIBILITY
+There is some evidence that historic
+.Nm
+implementations treated description fields with no whitespace
+in them as additional aliases or short names.
+This
+.Nm
+does not do that, but it does warn when description fields may be
+treated that way and check them for dangerous characters.
+.Ss EXTENSIONS
+Unlike the stock SVr4
+.Nm
+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 \fBterminfo\fR(\*n) for the list of
-termcap names taken to be equivalent to terminfo names.
-.PP
-The SVr4 manual pages are not clear on the resolution rules for \fBuse\fR
+See
+.Xr terminfo 5
+for the list of termcap names taken to be equivalent to terminfo names.
+.Pp
+The SVr4 manual pages are not clear on the resolution rules for
+.Cm use
 capabilities.
-This implementation of \fBtic\fR will find \fBuse\fR targets anywhere
-in the source file, or anywhere in the file tree rooted at \fBTERMINFO\fR (if
-\fBTERMINFO\fR is defined), or in the user's \fI$HOME/.terminfo\fR directory
-(if it exists), or (finally) anywhere in the system's file tree of
-compiled entries.
-.PP
-The error messages from this \fBtic\fR have the same format as GNU C
-error messages, and can be parsed by GNU Emacs's compile facility.
-.PP
+This implementation of
+.Nm
+will find
+.Cm use
+targets anywhere in the source file,
+or anywhere in the file tree rooted at
+.Ev TERMINFO
+(if it is defined), or in the user's
+.Pa $HOME/.terminfo
+directory (if it exists), or (finally) anywhere in the system's
+file tree of compiled entries.
+.Pp
+The error messages from this
+.Nm
+have the same format as GNU C error messages,
+and can be parsed by GNU Emacs's compile facility.
+.Pp
 The
-\fB\-C\fR,
-\fB\-G\fR,
-\fB\-I\fR,
-\fB\-N\fR,
-\fB\-R\fR,
-\fB\-T\fR,
-\fB\-V\fR,
-\fB\-a\fR,
-\fB\-e\fR,
-\fB\-f\fR,
-\fB\-g\fR,
-\fB\-o\fR,
-\fB\-r\fR,
-\fB\-s\fR,
-\fB\-t\fR and
-\fB\-x\fR
-options
-are not supported under SVr4.
-The SVr4 \fB\-c\fR mode does not report bad use links.
-.PP
+.Fl C ,
+.Fl G ,
+.Fl I ,
+.Fl N ,
+.Fl R ,
+.Fl T ,
+.Fl V ,
+.Fl a ,
+.Fl e ,
+.Fl f ,
+.Fl g ,
+.Fl o ,
+.Fl r ,
+.Fl s ,
+.Fl t
+and
+.Fl x
+options are not supported under SVr4.
+The SVr4
+.Fl c
+mode does not report bad use links.
+.Pp
 System V does not compile entries to or read entries from your
-\fI$HOME/.terminfo\fR directory unless TERMINFO is explicitly set to it.
-.SH FILES
-.TP 5
-\fB\*d/?/*\fR
+.Pa $HOME/.terminfo
+directory unless
+.Ev TERMINFO
+is explicitly set to it.
+.Sh FILES
+.Bl -tag -width "Pa /usr/share/terminfo/?/*"
+.It Pa /usr/share/terminfo/?/*
 Compiled terminal description database.
-.SH SEE ALSO
-\fBcurses\fR(3),
-\fBterminfo\fR(\*n).
-.PP
-This describes \fBncurses\fR
-version 5.9 (patch 20110404).
-.SH AUTHOR
-Eric S. Raymond <esr@snark.thyrsus.com>
-and
-.br
-Thomas E. Dickey <dickey@invisible-island.net>
+.El
+.Sh SEE ALSO
+.Xr ncurses 3 ,
+.Xr terminfo 5
+.Sh AUTHORS
+.An Eric S. Raymond Aq Mt esr@snark.thyrsus.com
+.An Thomas E. Dickey Aq Mt dickey@invisible-island.net