.\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey *
.\" Copyright 1998-2016,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: tic.1m,v 1.81 2021/12/25 17:39:16 tom Exp $
-.TH @TIC@ 1M ""
-.ie \n(.g .ds `` \(lq
-.el .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el .ds '' ''
-.ds n 5
-.ds d @TERMINFO@
+.\" $Id: tic.1m,v 1.98 2023/10/14 19:25:26 tom Exp $
+.TH @TIC@ 1M 2023-10-14 "ncurses 6.4" "User commands"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el .ds `` ""
+.ie t .ds '' ''
+.el .ds '' ""
+.\}
+.
.de bP
.ie n .IP \(bu 4
.el .IP \(bu 2
..
+.
+.ds n 5
+.ds d @TERMINFO@
.SH NAME
-\fB@TIC@\fP \- the \fIterminfo\fP entry-description compiler
+\fB\%@TIC@\fP \-
+compile terminal descriptions for \fIterminfo\fR or \fItermcap\fR
.SH SYNOPSIS
\fB@TIC@\fP
[\fB\-\
[\fB\-v\fP[\fIn\fP]]
[\fB\-w\fP[\fIn\fP]]
\fIfile\fP
-.br
.SH DESCRIPTION
The \fB@TIC@\fP command translates a \fBterminfo\fP file from source
format into compiled format.
a compiled-in list of directories (@TERMINFO_DIRS@), and
.bP
the system terminfo database (\fI\*d\fP).
-.SS ALIASES
.PP
+The \fIFetching Compiled Descriptions\fP section in the \fBterminfo\fR(\*n)
+manual goes into further detail.
+.SS ALIASES
This is the same program as @INFOTOCAP@ and @CAPTOINFO@;
usually those are linked to, or copied from this program:
.bP
it will print a diagnostic and exit with an error rather than
printing a list of database locations.
.TP
-\fB\-e \fP\fInames\fP
+\fB\-e \fInames\fR
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
.TP
\fB\-K\fP
Suppress some longstanding ncurses extensions to termcap format,
-e.g., "\\s" for space.
+e.g., "\es" for space.
.TP
\fB\-L\fP
Force source translation to terminfo format
This option forces a more literal translation that also preserves the
obsolete capabilities.
.TP
-\fB\-o\fP\fIdir\fP
+\fB\-o\fIdir\fR
Write compiled entries to given database location.
Overrides the TERMINFO environment variable.
.TP
-\fB\-Q\fP\fIn\fP
+\fB\-Q\fIn\fR
Rather than show source in terminfo (text) format,
print the compiled (binary) format in hexadecimal or base64 form,
depending on the option's value:
\fB\-q\fP
Suppress comments and blank lines when showing translated source.
.TP
-\fB\-R\fP\fIsubset\fP
+\fB\-R\fIsubset\fR
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
that have their own extensions incompatible with SVr4/XSI.
-Available subsets
-are \*(``SVr1\*('', \*(``Ultrix\*('', \*(``HP\*('', \*(``BSD\*('' and \*(``AIX\*('';
-see \fBterminfo\fP(\*n) for details.
+.IP
+Available subsets are
+.RS
+\*(``SVr1\*('',
+\*(``Ultrix\*('',
+\*(``HP\*('',
+\*(``BSD\*('', and
+\*(``AIX\*(''
+.RE
+.IP
+See \fBterminfo\fP(\*n) for details.
.TP
\fB\-r\fP
Force entry resolution (so there are no remaining tc capabilities) even
\fB\-V\fP
reports the version of ncurses which was used in this program, and exits.
.TP
-\fB\-v\fP\fIn\fP
+\fB\-v\fIn\fR
specifies that (verbose) output be written to standard error trace
information showing \fB@TIC@\fP's progress.
.IP
-The optional parameter \fIn\fP is a number from 1 to 10, inclusive,
+The optional parameter \fIn\fP is a number from 1 to 9, inclusive,
indicating the desired level of detail of information.
+.RS
+.bP
If ncurses is built without tracing support, the optional parameter is ignored.
+.bP
If \fIn\fP is omitted, the default level is 1.
+.bP
If \fIn\fP is specified and greater than 1, the level of
-detail is increased.
+detail is increased, and the output is written (with tracing information)
+to the \*(``trace\*('' file.
+.RE
.RS
.PP
The debug flag levels are as follows:
-.TP
+.TP 4
1
Names of files created and linked
.TP
3
Statistics from the hashing algorithm
.TP
+4
+Details of extended capabilities
+.TP
5
-String-table memory allocations
+(unused)
+.TP
+6
+(unused)
.TP
7
Entries into the string-table
.TP
9
All values computed in construction of the hash table
-.LP
-If the debug level \fIn\fP is not given, it is taken to be one.
.RE
.TP
\fB\-W\fP
If you specify both \fB\-f\fP and \fB\-W\fP options,
the latter is ignored when \fB\-f\fP has already split the line.
.TP
-\fB\-w\fP\fIn\fP
+\fB\-w\fIn\fR
specifies the width of the output.
The parameter is optional.
If it is omitted, it defaults to 60.
If \fIfile\fP is \*(``-\*('', then the data is read from the standard input.
The \fIfile\fP parameter may also be the path of a character-device.
.SS PROCESSING
-.PP
All but one of the capabilities recognized by \fB@TIC@\fP are documented
in \fBterminfo\fP(\*n).
The exception is the \fBuse\fP capability.
those capabilities that explicitly are defined in the current entry.
.PP
When an entry, e.g., \fBentry_name_1\fP, contains a
-\fBuse=\fP\fIentry\fR_\fIname\fR_\fI2\fP field, any canceled
+\fBuse=\fIentry\fR_\fIname\fR_\fI2\fR field, any canceled
capabilities in \fIentry\fR_\fIname\fR_\fI2\fP must also appear in
\fBentry_name_1\fP before \fBuse=\fP for these capabilities to be
canceled in \fBentry_name_1\fP.
will be truncated to the maximum alias length
and a warning message will be printed.
.SH HISTORY
-.PP
System V Release 2 provided a \fBtic\fP utility.
It accepted a single option: \fB\-v\fP (optionally followed by a number).
According to Ross Ridge's comment in \fImytinfo\fP,
There are 527 distinct capabilities in ncurses' terminal database;
128 of those are user-defined.
.SH PORTABILITY
-.PP
X/Open Curses, Issue 7 (2009) provides a brief description of \fBtic\fP.
It lists one option: \fB\-c\fP.
The omission of \fB\-v\fP is unexpected.
System V does not compile entries to or read entries from your
\fI$HOME/.terminfo\fP database unless TERMINFO is explicitly set to it.
.SH FILES
-.TP 5
-\fB\*d/?/*\fP
-Compiled terminal description database.
-.SH SEE ALSO
-\fB@CAPTOINFO@\fP(1M),
-\fB@INFOCMP@\fP(1M),
-\fB@INFOTOCAP@\fP(1M),
-\fB@TOE@\fP(1M),
-\fBcurses\fP(3X),
-\fBterm\fP(\*n).
-\fBterminfo\fP(\*n).
-\fBuser_caps\fP(\*n).
-.PP
-This describes \fBncurses\fP
-version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
+.TP
+.I \*d
+compiled terminal description database
.SH AUTHOR
Eric S. Raymond <esr@snark.thyrsus.com>
and
.br
-Thomas E. Dickey <dickey@invisible-island.net>
+Thomas E. Dickey <dickey@invisible\-island.net>
+.SH SEE ALSO
+\fB\%@CAPTOINFO@\fP(1M),
+\fB\%@INFOCMP@\fP(1M),
+\fB\%@INFOTOCAP@\fP(1M),
+\fB\%@TOE@\fP(1M),
+\fB\%curses\fP(3X),
+\fB\%term\fP(\*n),
+\fB\%terminfo\fP(\*n),
+\fB\%user_caps\fP(\*n)
projects / ncurses.git / blobdiff