<!--
****************************************************************************
- * 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: tic.1m,v 1.98 2023/10/14 19:25:26 tom Exp @
+ * @Id: tic.1m,v 1.108 2024/03/16 15:35:01 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>tic 1m 2023-10-14 ncurses 6.4 User commands</TITLE>
+<TITLE>tic 1m 2024-03-16 ncurses 6.4 User commands</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">tic 1m 2023-10-14 ncurses 6.4 User commands</H1>
+<H1 class="no-header">tic 1m 2024-03-16 ncurses 6.4 User commands</H1>
<PRE>
<STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> User commands <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>tic</STRONG> [<STRONG>-01CDGIKLNTUVWacfgqrstx</STRONG>] [<STRONG>-e</STRONG> <EM>names</EM>] [<STRONG>-o</STRONG> <EM>dir</EM>] [<STRONG>-Q</STRONG>[<EM>n</EM>]] [<STRONG>-R</STRONG> <EM>subset</EM>]
- [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-w</STRONG>[<EM>n</EM>]] <EM>file</EM>
+ <STRONG>tic</STRONG> [<STRONG>-01acCDfgGIKLNqrstTUVWx</STRONG>] [<STRONG>-e</STRONG> <EM>terminal-type-list</EM>] [<STRONG>-o</STRONG> <EM>dir</EM>] [<STRONG>-Q</STRONG>[<EM>n</EM>]]
+ [<STRONG>-R</STRONG> <EM>subset</EM>] [<STRONG>-v</STRONG>[<EM>n</EM>]] [<STRONG>-w</STRONG>[<EM>n</EM>]] <EM>file</EM>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
in a different terminfo database. There are two ways to achieve this:
<STRONG>o</STRONG> First, you may override the system default either by using the <STRONG>-o</STRONG>
- option, or by setting the variable <STRONG>TERMINFO</STRONG> in your shell
+ option, or by setting the variable <EM>TERMINFO</EM> in your shell
environment to a valid database location.
<STRONG>o</STRONG> Secondly, if <STRONG>tic</STRONG> cannot write in <EM>/usr/share/terminfo</EM> or the
- location specified using your TERMINFO variable, it looks for the
+ location specified using your <EM>TERMINFO</EM> variable, it looks for the
directory <EM>$HOME/.terminfo</EM> (or hashed database <EM>$HOME/.terminfo.db)</EM>;
if that location exists, the entry is placed there.
Libraries that read terminfo entries are expected to check in
succession
- <STRONG>o</STRONG> a location specified with the TERMINFO environment variable,
+ <STRONG>o</STRONG> a location specified with the <EM>TERMINFO</EM> environment variable,
<STRONG>o</STRONG> <EM>$HOME/.terminfo</EM>,
- <STRONG>o</STRONG> directories listed in the TERMINFO_DIRS environment variable,
+ <STRONG>o</STRONG> directories listed in the <EM>TERMINFO</EM><STRONG>_</STRONG><EM>DIRS</EM> environment variable,
<STRONG>o</STRONG> a compiled-in list of directories (/usr/share/terminfo), and
goes into further detail.
-</PRE><H3><a name="h3-A
LIASES">ALIASES</a></H3><PRE>
+</PRE><H3><a name="h3-A
liases">Aliases</a></H3><PRE>
This is the same program as infotocap and captoinfo; usually those are
linked to, or copied from this program:
<STRONG>o</STRONG> When invoked as captoinfo, tic sets the <STRONG>-C</STRONG> option.
-</PRE><H
3><a name="h3-OPTIONS">OPTIONS</a></H3><PRE>
+</PRE><H
2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
<STRONG>-0</STRONG> restricts the output to a single line
<STRONG>-1</STRONG> restricts the output to a single column
summarized above, it will print a diagnostic and exit with an
error rather than printing a list of database locations.
- <STRONG>-e</STRONG> <EM>names</EM>
- 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
+ <STRONG>-e</STRONG> <EM>list</EM>
+ Limit writes and translations to the comma-separated <EM>list</EM> of
+ terminal types. 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
<STRONG>-I</STRONG> Force source translation to terminfo format.
- <STRONG>-K</STRONG> Suppress some longstanding ncurses extensions to termcap format,
+ <STRONG>-K</STRONG> Suppress some longstanding <EM>ncurses</EM> extensions to termcap format,
e.g., "\s" for space.
<STRONG>-L</STRONG> Force source translation to terminfo format using the long C
also preserves the obsolete capabilities.
<STRONG>-o</STRONG><EM>dir</EM> Write compiled entries to given database location. Overrides
- the TERMINFO environment variable.
+ the <EM>TERMINFO</EM> environment variable.
<STRONG>-Q</STRONG><EM>n</EM> Rather than show source in terminfo (text) format, print the
compiled (binary) format in hexadecimal or base64 form,
file. Normally, it infers data which is commonly missing in older
terminfo data, or in termcaps.
- <STRONG>-V</STRONG> reports the version of ncurses which was used in this program, and
+ <STRONG>-V</STRONG> reports the version of <EM>ncurses</EM> which was used in this program, and
exits.
<STRONG>-v</STRONG><EM>n</EM> specifies that (verbose) output be written to standard error trace
The optional parameter <EM>n</EM> is a number from 1 to 9, inclusive,
indicating the desired level of detail of information.
- <STRONG>o</STRONG> If ncurses is built without tracing support, the optional
+ <STRONG>o</STRONG> If <EM>ncurses</EM> is built without tracing support, the optional
parameter is ignored.
<STRONG>o</STRONG> If <EM>n</EM> is omitted, the default level is 1.
<STRONG>-w</STRONG><EM>n</EM> specifies the width of the output. The parameter is optional. If
it is omitted, it defaults to 60.
- <STRONG>-x</STRONG> Treat unknown capabilities as user-defined (see <STRONG>user_caps(5)</STRONG>).
+ <STRONG>-x</STRONG> Treat unknown capabilities as user-defined (see <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>).
That is, if you supply a capability name which <STRONG>tic</STRONG> does not
- recognize, it will infer its type (boolean, number or string) from
+ 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.
-</PRE><H3><a name="h3-P
ARAMETERS">PARAMETERS</a></H3><PRE>
+</PRE><H3><a name="h3-P
arameters">Parameters</a></H3><PRE>
<EM>file</EM> contains one or more <STRONG>terminfo</STRONG> terminal descriptions in source
format [see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. Each description in the file
describes the capabilities of a particular terminal.
The <EM>file</EM> parameter may also be the path of a character-device.
-</PRE><H3><a name="h3-P
ROCESSING">PROCESSING</a></H3><PRE>
+</PRE><H3><a name="h3-P
rocessing">Processing</a></H3><PRE>
All but one of the capabilities recognized by <STRONG>tic</STRONG> are documented in
<STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. The exception is the <STRONG>use</STRONG> capability.
<STRONG>entry_name_1</STRONG> before <STRONG>use=</STRONG> for these capabilities to be canceled in
<STRONG>entry_name_1</STRONG>.
- 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.
+ Total compiled entries cannot exceed 4096 bytes in the legacy storage
+ format, or 32768 using the extended number format. 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><a name="h2-FILES">FILES</a></H2><PRE>
+ <EM>/usr/share/terminfo</EM>
+ compiled terminal description database
+
+
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ There is some evidence that historic <STRONG>tic</STRONG> implementations treated
+ description fields with no whitespace in them as additional aliases or
+ short names. This <STRONG>tic</STRONG> does not do that, but it does warn when
+ description fields may be treated that way and check them for dangerous
+ characters.
+
+
+</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
+ Unlike the SVr4 <STRONG>tic</STRONG> 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 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> 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 <STRONG>use</STRONG>
+ capabilities. This implementation of <STRONG>tic</STRONG> will find <STRONG>use</STRONG> targets
+ anywhere in the source file, or anywhere in the file tree rooted at
+ <EM>TERMINFO</EM> (if <EM>TERMINFO</EM> is defined), or in the user's <EM>$HOME/.terminfo</EM>
+ database (if it exists), or (finally) anywhere in the system's file
+ tree of compiled entries.
+
+ The error messages from this <STRONG>tic</STRONG> have the same format as GNU C error
+ messages, and can be parsed by GNU Emacs's compile facility.
+
+ Aside from <STRONG>-c</STRONG> and <STRONG>-v</STRONG>, options are not portable:
+
+ <STRONG>o</STRONG> Most of tic's options are not supported by SVr4 <STRONG>tic</STRONG>:
+
+ <STRONG>-0</STRONG> <STRONG>-1</STRONG> <STRONG>-C</STRONG> <STRONG>-G</STRONG> <STRONG>-I</STRONG> <STRONG>-N</STRONG> <STRONG>-R</STRONG> <STRONG>-T</STRONG> <STRONG>-V</STRONG> <STRONG>-a</STRONG> <STRONG>-e</STRONG> <STRONG>-f</STRONG> <STRONG>-g</STRONG> <STRONG>-o</STRONG> <STRONG>-r</STRONG> <STRONG>-s</STRONG> <STRONG>-t</STRONG> <STRONG>-x</STRONG>
+
+ <STRONG>o</STRONG> The NetBSD <STRONG>tic</STRONG> supports a few of the <EM>ncurses</EM> options
+
+ <STRONG>-a</STRONG> <STRONG>-o</STRONG> <STRONG>-x</STRONG>
+
+ and adds <STRONG>-S</STRONG> (a feature which does the same thing as infocmp's <STRONG>-e</STRONG>
+ and <STRONG>-E</STRONG> options).
+
+ The SVr4 <STRONG>-c</STRONG> mode does not report bad "use=" links.
+
+ System V does not compile entries to or read entries from your
+ <EM>$HOME/.terminfo</EM> database unless <EM>TERMINFO</EM> is explicitly set to it.
+
+
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ X/Open Curses, Issue 7 (2009) provides a brief description of <STRONG>tic</STRONG>. It
+ lists one option: <STRONG>-c</STRONG>. The omission of <STRONG>-v</STRONG> is unexpected. The change
+ history states that the description is derived from Tru64. According
+ to its manual pages, that system also supported the <STRONG>-v</STRONG> option.
+
+ Shortly after Issue 7 was released, Tru64 was discontinued. As of
+ 2019, the surviving implementations of <STRONG>tic</STRONG> are SVr4 (AIX, HP-UX and
+ Solaris), <EM>ncurses</EM> and NetBSD curses. The SVr4 <STRONG>tic</STRONG> programs all support
+ the <STRONG>-v</STRONG> option. The NetBSD <STRONG>tic</STRONG> program follows X/Open's documentation,
+ omitting the <STRONG>-v</STRONG> option.
+
+ The X/Open rationale states that some implementations of <STRONG>tic</STRONG> read
+ terminal descriptions from the standard input if the <EM>file</EM> parameter is
+ omitted. None of these implementations do that. Further, it comments
+ that some may choose to read from "./terminfo.src" but that is
+ obsolescent behavior from SVr2, and is not (for example) a documented
+ feature of SVr3.
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
Release 4, the table of capabilities grew from 180 (<EM>pcurses</EM>) to 464
(Solaris).
- In early development of ncurses (1993), Zeyd Ben-Halim used the table
+ In early development of <EM>ncurses</EM> (1993), Zeyd Ben-Halim used the table
from <EM>mytinfo</EM> to extend the <EM>pcurses</EM> 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 <STRONG>memory_lock_above</STRONG> and <STRONG>memory_unlock</STRONG> (see
<STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>).
- Eric Raymond incorporated parts of <EM>mytinfo</EM> into ncurses to implement
+ Eric Raymond incorporated parts of <EM>mytinfo</EM> into <EM>ncurses</EM> to implement
the termcap-to-terminfo source conversion, and extended that to begin
development of the corresponding terminfo-to-termcap source conversion,
Thomas Dickey completed that development over the course of several
capabilities.
In 2010, Roy Marples provided a <STRONG>tic</STRONG> program and terminfo library for
- NetBSD. That implementation adapts several features from ncurses,
+ NetBSD. That implementation adapts several features from <EM>ncurses</EM>,
including <STRONG>tic</STRONG>'s <STRONG>-x</STRONG> option.
The <STRONG>-c</STRONG> option tells <STRONG>tic</STRONG> to check for problems in the terminfo source
<STRONG>o</STRONG> <EM>pcurses</EM> had 8 warnings
- <STRONG>o</STRONG> ncurses in 1996 had 16 warnings
+ <STRONG>o</STRONG> <EM>ncurses</EM> in 1996 had 16 warnings
<STRONG>o</STRONG> Solaris (SVr4) curses has 28 warnings
<STRONG>o</STRONG> NetBSD tic in 2019 has 19 warnings.
- <STRONG>o</STRONG> ncurses in 2019 has 96 warnings
+ <STRONG>o</STRONG> <EM>ncurses</EM> in 2019 has 96 warnings
- The checking done in ncurses' <STRONG>tic</STRONG> helps with the conversion to termcap,
+ The checking done in <EM>ncurses</EM>' <STRONG>tic</STRONG> 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; 128 of those are
+ distinct capabilities in <EM>ncurses</EM>' terminal database; 128 of those are
user-defined.
-</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- X/Open Curses, Issue 7 (2009) provides a brief description of <STRONG>tic</STRONG>. It
- lists one option: <STRONG>-c</STRONG>. The omission of <STRONG>-v</STRONG> is unexpected. The change
- history states that the description is derived from True64 UNIX.
- According to its manual pages, that system also supported the <STRONG>-v</STRONG>
- option.
-
- Shortly after Issue 7 was released, Tru64 was discontinued. As of
- 2019, the surviving implementations of <STRONG>tic</STRONG> are SVr4 (AIX, HP-UX and
- Solaris), ncurses and NetBSD curses. The SVr4 <STRONG>tic</STRONG> programs all support
- the <STRONG>-v</STRONG> option. The NetBSD <STRONG>tic</STRONG> program follows X/Open's documentation,
- omitting the <STRONG>-v</STRONG> option.
-
- The X/Open rationale states that some implementations of <STRONG>tic</STRONG> read
- terminal descriptions from the standard input if the <EM>file</EM> parameter is
- omitted. None of these implementations do that. Further, it comments
- that some may choose to read from "./terminfo.src" but that is
- obsolescent behavior from SVr2, and is not (for example) a documented
- feature of SVr3.
-
-
-</PRE><H3><a name="h3-COMPATIBILITY">COMPATIBILITY</a></H3><PRE>
- There is some evidence that historic <STRONG>tic</STRONG> implementations treated
- description fields with no whitespace in them as additional aliases or
- short names. This <STRONG>tic</STRONG> does not do that, but it does warn when
- description fields may be treated that way and check them for dangerous
- characters.
-
-
-</PRE><H3><a name="h3-EXTENSIONS">EXTENSIONS</a></H3><PRE>
- Unlike the SVr4 <STRONG>tic</STRONG> 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 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> 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 <STRONG>use</STRONG>
- capabilities. This implementation of <STRONG>tic</STRONG> will find <STRONG>use</STRONG> targets
- anywhere in the source file, or anywhere in the file tree rooted at
- <STRONG>TERMINFO</STRONG> (if <STRONG>TERMINFO</STRONG> is defined), or in the user's <EM>$HOME/.terminfo</EM>
- database (if it exists), or (finally) anywhere in the system's file
- tree of compiled entries.
-
- The error messages from this <STRONG>tic</STRONG> have the same format as GNU C error
- messages, and can be parsed by GNU Emacs's compile facility.
-
- Aside from <STRONG>-c</STRONG> and <STRONG>-v</STRONG>, options are not portable:
-
- <STRONG>o</STRONG> Most of tic's options are not supported by SVr4 <STRONG>tic</STRONG>:
-
- <STRONG>-0</STRONG> <STRONG>-1</STRONG> <STRONG>-C</STRONG> <STRONG>-G</STRONG> <STRONG>-I</STRONG> <STRONG>-N</STRONG> <STRONG>-R</STRONG> <STRONG>-T</STRONG> <STRONG>-V</STRONG> <STRONG>-a</STRONG> <STRONG>-e</STRONG> <STRONG>-f</STRONG> <STRONG>-g</STRONG> <STRONG>-o</STRONG> <STRONG>-r</STRONG> <STRONG>-s</STRONG> <STRONG>-t</STRONG> <STRONG>-x</STRONG>
-
- <STRONG>o</STRONG> The NetBSD <STRONG>tic</STRONG> supports a few of the ncurses options
-
- <STRONG>-a</STRONG> <STRONG>-o</STRONG> <STRONG>-x</STRONG>
-
- and adds <STRONG>-S</STRONG> (a feature which does the same thing as infocmp's <STRONG>-e</STRONG>
- and <STRONG>-E</STRONG> options).
-
- The SVr4 <STRONG>-c</STRONG> mode does not report bad "use=" links.
-
- System V does not compile entries to or read entries from your
- <EM>$HOME/.terminfo</EM> database unless TERMINFO is explicitly set to it.
-
-
-</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
- <EM>/usr/share/terminfo</EM>
- compiled terminal description database
-
-
-</PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Eric S. Raymond <esr@snark.thyrsus.com> and
Thomas E. Dickey <dickey@invisible-island.net>
-ncurses 6.4 202
3-10-14 <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>
+ncurses 6.4 202
4-03-16 <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
<ul>
-<li><a href="#h3-ALIASES">ALIASES</a></li>
-<li><a href="#h3-OPTIONS">OPTIONS</a></li>
-<li><a href="#h3-PARAMETERS">PARAMETERS</a></li>
-<li><a href="#h3-PROCESSING">PROCESSING</a></li>
+<li><a href="#h3-Aliases">Aliases</a></li>
</ul>
</li>
-<li><a href="#h2-HISTORY">HISTORY</a></li>
-<li><a href="#h2-PORTABILITY">PORTABILITY</a>
+<li><a href="#h2-OPTIONS">OPTIONS</a>
<ul>
-<li><a href="#h3-COMPATIBILITY">COMPATIBILITY</a></li>
-<li><a href="#h3-EXTENSIONS">EXTENSIONS</a></li>
+<li><a href="#h3-Parameters">Parameters</a></li>
+<li><a href="#h3-Processing">Processing</a></li>
</ul>
</li>
<li><a href="#h2-FILES">FILES</a></li>
-<li><a href="#h2-AUTHOR">AUTHOR</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-HISTORY">HISTORY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
projects / ncurses.git / blobdiff