ncurses 6.0 - patch 20170506
[ncurses.git] / doc / html / man / term.5.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: term.5,v 1.26 2017/02/18 16:58:21 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>term 5</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">term 5</H1>
42 <PRE>
43 <STRONG><A HREF="term.5.html">term(5)</A></STRONG>                                                                <STRONG><A HREF="term.5.html">term(5)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        term - format of compiled term file.
50
51
52 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
53        <STRONG>term</STRONG>
54
55
56 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
57
58 </PRE><H3><a name="h3-STORAGE-LOCATION">STORAGE LOCATION</a></H3><PRE>
59        Compiled   terminfo   descriptions   are  placed  under  the  directory
60        <STRONG>/usr/share/terminfo</STRONG>.  Two configurations are supported  (when  building
61        the ncurses libraries):
62
63        <STRONG>directory</STRONG> <STRONG>tree</STRONG>
64             A two-level scheme is used to avoid a linear search of a huge UNIX
65             system directory: <STRONG>/usr/share/terminfo/c/name</STRONG>  where  <EM>name</EM>  is  the
66             name of the terminal, and <EM>c</EM> is the first character of <EM>name</EM>.  Thus,
67             <EM>act4</EM> can be found in the  file  <STRONG>/usr/share/terminfo/a/act4</STRONG>.   Syn-
68             onyms  for  the same terminal are implemented by multiple links to
69             the same compiled file.
70
71        <STRONG>hashed</STRONG> <STRONG>database</STRONG>
72             Using Berkeley database, two types of records are stored: the ter-
73             minfo  data  in the same format as stored in a directory tree with
74             the terminfo's primary name as a key, and records containing  only
75             aliases pointing to the primary name.
76
77             If  built  to  write hashed databases, ncurses can still read ter-
78             minfo databases organized as a directory tree,  but  cannot  write
79             entries  into  the  directory  tree.   It  can  write (or rewrite)
80             entries in the hashed database.
81
82             ncurses distinguishes the two  cases  in  the  TERMINFO  and  TER-
83             MINFO_DIRS  environment  variable by assuming a directory tree for
84             entries that correspond to an existing directory, and hashed data-
85             base otherwise.
86
87
88 </PRE><H3><a name="h3-STORAGE-FORMAT">STORAGE FORMAT</a></H3><PRE>
89        The format has been chosen so that it will be the same on all hardware.
90        An 8 or more bit byte is assumed, but no assumptions about byte  order-
91        ing or sign extension are made.
92
93        The compiled file is created with the <STRONG>tic</STRONG> program, and read by the rou-
94        tine <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG>.  The file is divided into six  parts:  the  header,
95        terminal names, boolean flags, numbers, strings, and string table.
96
97        The  header  section  begins the file.  This section contains six short
98        integers in the format described below.  These integers are
99
100             (1) the magic number (octal 0432);
101
102             (2) the size, in bytes, of the names section;
103
104             (3) the number of bytes in the boolean section;
105
106             (4) the number of short integers in the numbers section;
107
108             (5) the number of offsets (short integers) in the strings section;
109
110             (6) the size, in bytes, of the string table.
111
112        Short integers are stored in two 8-bit bytes.  The first byte  contains
113        the least significant 8 bits of the value, and the second byte contains
114        the most significant 8 bits.  (Thus, the value represented is  256*sec-
115        ond+first.)   The  value -1 is represented by the two bytes 0377, 0377;
116        other negative values are illegal. This value generally means that  the
117        corresponding capability is missing from this terminal.  Note that this
118        format corresponds to the hardware of the VAX and PDP-11 (that is, lit-
119        tle-endian  machines).   Machines where this does not correspond to the
120        hardware must read the integers as two bytes and  compute  the  little-
121        endian value.
122
123        The  terminal  names section comes next.  It contains the first line of
124        the terminfo description, listing the various names for  the  terminal,
125        separated  by  the  "|"  character.   The section is terminated with an
126        ASCII NUL character.
127
128        The boolean flags have one byte for each flag.  This byte is  either  0
129        or  1  as  the  flag is present or absent.  The capabilities are in the
130        same order as the file &lt;term.h&gt;.
131
132        Between the boolean section and the number section, a null byte will be
133        inserted,  if necessary, to ensure that the number section begins on an
134        even byte (this is a relic of the PDP-11's word-addressed architecture,
135        originally  designed in to avoid IOT traps induced by addressing a word
136        on an odd byte boundary).  All short integers are aligned  on  a  short
137        word boundary.
138
139        The  numbers  section is similar to the flags section.  Each capability
140        takes up two bytes, and is stored as a little-endian short integer.  If
141        the value represented is -1, the capability is taken to be missing.
142
143        The  strings  section  is also similar.  Each capability is stored as a
144        short integer, in the format above.  A value of -1 means the capability
145        is missing.  Otherwise, the value is taken as an offset from the begin-
146        ning of the string table.  Special characters in ^X or \c notation  are
147        stored  in  their  interpreted  form,  not the printing representation.
148        Padding information $&lt;nn&gt;  and  parameter  information  %x  are  stored
149        intact in uninterpreted form.
150
151        The  final  section is the string table.  It contains all the values of
152        string capabilities referenced in the string section.  Each  string  is
153        null terminated.
154
155
156 </PRE><H3><a name="h3-EXTENDED-STORAGE-FORMAT">EXTENDED STORAGE FORMAT</a></H3><PRE>
157        The previous section describes the conventional terminfo binary format.
158        With some minor variations of the offsets (see PORTABILITY),  the  same
159        binary  format  is used in all modern UNIX systems.  Each system uses a
160        predefined set of boolean, number or string capabilities.
161
162        The ncurses libraries and applications support extended terminfo binary
163        format,  allowing users to define capabilities which are loaded at run-
164        time.  This extension is made possible by using the fact that the other
165        implementations  stop  reading the terminfo data when they have reached
166        the end of the size given in the header.  ncurses checks the size,  and
167        if  it  exceeds  that  due  to  the predefined data, continues to parse
168        according to its own scheme.
169
170        First, it reads the extended header (5 short integers):
171
172             (1)  count of extended boolean capabilities
173
174             (2)  count of extended numeric capabilities
175
176             (3)  count of extended string capabilities
177
178             (4)  size of the extended string table in bytes.
179
180             (5)  last offset of the extended string table in bytes.
181
182        Using the counts and sizes, ncurses allocates arrays and reads data for
183        the extended capabilities in the same order as the header information.
184
185        The  extended  string  table  contains  values for string capabilities.
186        After the end of these values, it contains the names for  each  of  the
187        extended  capabilities  in  order,  e.g.,  booleans,  then  numbers and
188        finally strings.
189
190
191 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
192        Note that it is possible for <STRONG>setupterm</STRONG> to expect  a  different  set  of
193        capabilities  than  are actually present in the file.  Either the data-
194        base may have been updated since <STRONG>setupterm</STRONG> has been recompiled (result-
195        ing  in extra unrecognized entries in the file) or the program may have
196        been recompiled more recently than the database was updated  (resulting
197        in  missing  entries).  The routine <STRONG>setupterm</STRONG> must be prepared for both
198        possibilities - this is why the numbers and sizes are included.   Also,
199        new  capabilities must always be added at the end of the lists of bool-
200        ean, number, and string capabilities.
201
202        Despite the consistent use of little-endian for numbers and the  other-
203        wise  self-describing format, it is not wise to count on portability of
204        binary terminfo entries between commercial UNIX versions.  The  problem
205        is  that  there  are  at least three versions of terminfo (under HP-UX,
206        AIX, and OSF/1) which diverged from System V terminfo after  SVr1,  and
207        have  added  extension  capabilities  to  the string table that (in the
208        binary format) collide with System V and XSI  Curses  extensions.   See
209        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>  for  detailed  discussion of terminfo source compatibility
210        issues.
211
212
213 </PRE><H2><a name="h2-EXAMPLE">EXAMPLE</a></H2><PRE>
214        As an example, here is a hex dump of  the  description  for  the  Lear-
215        Siegler ADM-3, a popular though rather stupid early terminal:
216
217        adm3a|lsi adm3a,
218                am,
219                cols#80, lines#24,
220                bel=^G, clear= 32$&lt;1&gt;, cr=^M, cub1=^H, cud1=^J,
221                cuf1=^L, cup=\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,
222                home=^^, ind=^J,
223
224        0000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
225        0010  61 7c 6c 73 69 20 61 64  6d 33 61 00 00 01 50 00  a|lsi ad m3a...P.
226        0020  ff ff 18 00 ff ff 00 00  02 00 ff ff ff ff 04 00  ........ ........
227        0030  ff ff ff ff ff ff ff ff  0a 00 25 00 27 00 ff ff  ........ ..%.'...
228        0040  29 00 ff ff ff ff 2b 00  ff ff 2d 00 ff ff ff ff  ).....+. ..-.....
229        0050  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
230        0060  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
231        0070  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
232        0080  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
233        0090  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
234        00a0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
235        00b0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
236        00c0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
237        00d0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
238        00e0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
239        00f0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
240        0100  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
241        0110  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
242        0120  ff ff ff ff ff ff 2f 00  07 00 0d 00 1a 24 3c 31  ....../. .....$&lt;1
243        0130  3e 00 1b 3d 25 70 31 25  7b 33 32 7d 25 2b 25 63  &gt;..=%p1% {32}%+%c
244        0140  25 70 32 25 7b 33 32 7d  25 2b 25 63 00 0a 00 1e  %p2%{32} %+%c....
245        0150  00 08 00 0c 00 0b 00 0a  00                       ........ .
246
247
248
249 </PRE><H2><a name="h2-LIMITS">LIMITS</a></H2><PRE>
250        Some limitations: total compiled entries cannot exceed 4096 bytes.  The
251        name field cannot exceed 128 bytes.
252
253
254 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
255        /usr/share/terminfo/*/*  compiled terminal capability data base
256
257
258 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
259        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
260
261
262 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
263        Thomas E. Dickey
264        extended terminfo format for ncurses 5.0
265        hashed database support for ncurses 5.6
266
267        Eric S. Raymond
268
269
270
271                                                                        <STRONG><A HREF="term.5.html">term(5)</A></STRONG>
272 </PRE>
273 <div class="nav">
274 <ul>
275 <li><a href="#h2-NAME">NAME</a></li>
276 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
277 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
278 <ul>
279 <li><a href="#h3-STORAGE-LOCATION">STORAGE LOCATION</a></li>
280 <li><a href="#h3-STORAGE-FORMAT">STORAGE FORMAT</a></li>
281 <li><a href="#h3-EXTENDED-STORAGE-FORMAT">EXTENDED STORAGE FORMAT</a></li>
282 </ul>
283 </li>
284 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
285 <li><a href="#h2-EXAMPLE">EXAMPLE</a></li>
286 <li><a href="#h2-LIMITS">LIMITS</a></li>
287 <li><a href="#h2-FILES">FILES</a></li>
288 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
289 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
290 </ul>
291 </div>
292 </BODY>
293 </HTML>