.\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey *
+.\" Copyright 2018-2023,2024 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.101 2023/11/25 23:02:52 tom Exp $
-.TH @TIC@ 1M 2023-11-25 "ncurses 6.4" "User commands"
+.\" $Id: tic.1m,v 1.110 2024/04/27 17:57:06 tom Exp $
+.TH @TIC@ 1M 2024-04-27 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
The \fB@TIC@\fP command translates a \fBterminfo\fP file from source
format into compiled format.
The compiled format is necessary for use with
-the library routines in \fBncurses\fP(3X).
+the library routines in \fB\%ncurses\fP(3X).
.PP
As described in \fBterm\fP(5), the database may be either a directory
tree (one file per terminal entry) or a hashed database (one record per entry).
.bP
First, you may override the system default either by
using the \fB\-o\fP option,
-or by setting the variable \fBTERMINFO\fP
+or by setting the variable \fI\%TERMINFO\fP
in your shell environment to a valid database location.
.bP
Secondly, if \fB@TIC@\fP cannot write in \fI\*d\fP
-or the location specified using your TERMINFO variable,
+or the location specified using your \fI\%TERMINFO\fP variable,
it looks for the directory \fI$HOME/.terminfo\fP
(or hashed database \fI$HOME/.terminfo.db)\fP;
if that location exists, the entry is placed there.
.PP
Libraries that read terminfo entries are expected to check in succession
.bP
-a location specified with the TERMINFO environment variable,
+a location specified with the \fI\%TERMINFO\fP environment variable,
.bP
\fI$HOME/.terminfo\fP,
.bP
-directories listed in the TERMINFO_DIRS environment variable,
+directories listed in the \fI\%TERMINFO_DIRS\fP environment variable,
.bP
a compiled-in list of directories (@TERMINFO_DIRS@), and
.bP
.PP
The \fIFetching Compiled Descriptions\fP section in the \fBterminfo\fR(5)
manual goes into further detail.
-.SS ALIASES
+.SS Aliases
This is the same program as @INFOTOCAP@ and @CAPTOINFO@;
usually those are linked to, or copied from this program:
.bP
Force source translation to terminfo format.
.TP
\fB\-K\fP
-Suppress some longstanding ncurses extensions to termcap format,
+Suppress some longstanding \fI\%ncurses\fP extensions to termcap format,
e.g., "\es" for space.
.TP
\fB\-L\fP
.TP
\fB\-o\fIdir\fR
Write compiled entries to given database location.
-Overrides the TERMINFO environment variable.
+Overrides the \fI\%TERMINFO\fP environment variable.
.TP
\fB\-Q\fIn\fR
Rather than show source in terminfo (text) format,
tells \fB@TIC@\fP to discard commented-out capabilities.
Normally when translating from terminfo to termcap,
untranslatable capabilities are commented-out.
-.TP 5
+.TP
\fB\-U\fP
tells \fB@TIC@\fP 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\fP
-reports the version of ncurses which was used in this program, and exits.
+reports the version of \fI\%ncurses\fP which was used in this program,
+and exits.
.TP
\fB\-v\fIn\fR
specifies that (verbose) output be written to standard error trace
indicating the desired level of detail of information.
.RS
.bP
-If ncurses is built without tracing support, the optional parameter is ignored.
+If \fI\%ncurses\fP is built without tracing support,
+the optional parameter is ignored.
.bP
If \fIn\fP is omitted, the default level is 1.
.bP
\fB\-x\fP
Treat unknown capabilities as user-defined (see \fBuser_caps\fP(5)).
That is, if you supply a capability name which \fB@TIC@\fP does not recognize,
-it will infer its type (boolean, number or string) from the syntax and
+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.
-.SS PARAMETERS
+.SS Parameters
.TP
\fIfile\fP
contains one or more \fBterminfo\fP terminal descriptions in source
.IP
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
+.SS Processing
All but one of the capabilities recognized by \fB@TIC@\fP are documented
in \fBterminfo\fP(5).
The exception is the \fBuse\fP capability.
The SVr4 manual pages are not clear on the resolution rules for \fBuse\fP
capabilities.
This implementation of \fB@TIC@\fP will find \fBuse\fP targets anywhere
-in the source file, or anywhere in the file tree rooted at \fBTERMINFO\fP (if
-\fBTERMINFO\fP is defined),
+in the source file,
+or anywhere in the file tree rooted at
+\fI\%TERMINFO\fP
+(if
+\fI\%TERMINFO\fP is defined),
or in the user's \fI$HOME/.terminfo\fP database
(if it exists),
or (finally) anywhere in the system's file tree of
\fB\-x\fP
.RE
.bP
-The NetBSD \fBtic\fP supports a few of the ncurses options
+The NetBSD \fBtic\fP supports a few of the \fI\%ncurses\fP options
.sp
.RS
\fB\-a\fP
The SVr4 \fB\-c\fP mode does not report bad \*(``use=\*('' links.
.PP
System V does not compile entries to or read entries from your
-\fI$HOME/.terminfo\fP database unless TERMINFO is explicitly set to it.
+\fI$HOME/.terminfo\fP database unless \fI\%TERMINFO\fP is explicitly set
+to it.
.SH PORTABILITY
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.
-The change history states that the description is derived from Tru64 UNIX.
+The change history states that the description is derived from Tru64.
According to its manual pages, that system also supported the \fB\-v\fP option.
.PP
Shortly after Issue 7 was released, Tru64 was discontinued.
As of 2019, the surviving implementations of \fBtic\fP
are SVr4 (AIX, HP-UX and Solaris),
-ncurses
+\fI\%ncurses\fP
and NetBSD curses.
The SVr4 \fBtic\fP programs all support the \fB\-v\fP option.
The NetBSD \fBtic\fP program follows X/Open's documentation,
continued with System V Release 4,
the table of capabilities grew from 180 (\fIpcurses\fP) to 464 (Solaris).
.PP
-In early development of ncurses (1993),
+In early development of \fI\%ncurses\fP (1993),
Zeyd Ben-Halim used the table from \fImytinfo\fP to
extend the \fIpcurses\fP table to 469 capabilities
(456 matched SVr4, 8 were only in SVr4, 13 were not in SVr4).
Of those 13, 11 were ultimately discarded
(perhaps to match the draft of X/Open Curses).
The exceptions were
-\fBmemory_lock_above\fP and
-\fBmemory_unlock\fP (see \fBuser_caps\fP(5)).
+\fB\%memory_lock_above\fP and
+\fB\%memory_unlock\fP (see \fB\%user_caps\fP(5)).
.PP
-Eric Raymond incorporated parts of \fImytinfo\fP into ncurses
+Eric Raymond incorporated parts of \fImytinfo\fP into \fI\%ncurses\fP
to implement the termcap-to-terminfo source conversion,
and extended that to begin development of
the corresponding terminfo-to-termcap source conversion,
.PP
In 2010, Roy Marples provided a \fBtic\fP program
and terminfo library for NetBSD.
-That implementation adapts several features from ncurses,
+That implementation adapts several features from \fI\%ncurses\fP,
including \fB@TIC@\fP's \fB\-x\fP option.
.PP
The \fB\-c\fP option tells \fB@TIC@\fP to check for problems in the
.bP
\fIpcurses\fP had 8 warnings
.bP
-ncurses in 1996 had 16 warnings
+\fI\%ncurses\fP in 1996 had 16 warnings
.bP
Solaris (SVr4) curses has 28 warnings
.bP
NetBSD tic in 2019 has 19 warnings.
.bP
-ncurses in 2019 has 96 warnings
+\fI\%ncurses\fP in 2019 has 96 warnings
.PP
-The checking done in ncurses' \fB@TIC@\fP helps with the conversion to
-termcap, as well as pointing out errors and inconsistencies.
+The checking done in \fI\%ncurses\fP' \fB@TIC@\fP helps with the
+conversion to termcap,
+as well as pointing out errors and inconsistencies.
It is also used to ensure consistency with the user-defined capabilities.
-There are 527 distinct capabilities in ncurses' terminal database;
+There are 527 distinct capabilities in \fI\%ncurses\fP' terminal
+database;
128 of those are user-defined.
.SH AUTHORS
Eric S. Raymond <esr@snark.thyrsus.com>
projects / ncurses.git / blobdiff