ncurses 6.0 - patch 20170819
[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.1.3 2017/05/27 23:28:31 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/local/ncurses/lib/terminfo</STRONG>.   Two  configurations  are   supported
61        (when building 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/local/ncurses/lib/terminfo/c/name</STRONG>   where
66             <EM>name</EM>  is the name of the terminal, and <EM>c</EM> is the first character of
67             <EM>name</EM>.     Thus,    <EM>act4</EM>    can    be    found    in    the    file
68             <STRONG>/usr/local/ncurses/lib/terminfo/a/act4</STRONG>.   Synonyms  for  the  same
69             terminal are implemented by multiple links to  the  same  compiled
70             file.
71
72        <STRONG>hashed</STRONG> <STRONG>database</STRONG>
73             Using Berkeley database, two types of records are stored: the ter-
74             minfo data in the same format as stored in a directory  tree  with
75             the  terminfo's primary name as a key, and records containing only
76             aliases pointing to the primary name.
77
78             If built to write hashed databases, ncurses can  still  read  ter-
79             minfo  databases  organized  as a directory tree, but cannot write
80             entries into the  directory  tree.   It  can  write  (or  rewrite)
81             entries in the hashed database.
82
83             ncurses  distinguishes  the  two  cases  in  the TERMINFO and TER-
84             MINFO_DIRS environment variable by assuming a directory  tree  for
85             entries that correspond to an existing directory, and hashed data-
86             base otherwise.
87
88
89 </PRE><H3><a name="h3-LEGACY-STORAGE-FORMAT">LEGACY STORAGE FORMAT</a></H3><PRE>
90        The format has been chosen so that it will be the same on all hardware.
91        An  8 or more bit byte is assumed, but no assumptions about byte order-
92        ing or sign extension are made.
93
94        The compiled file is created with the <STRONG>tic</STRONG> program, and read by the rou-
95        tine  <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG>.   The  file is divided into six parts: the header,
96        terminal names, boolean flags, numbers, strings, and string table.
97
98        The header section begins the file.  This section  contains  six  short
99        integers in the format described below.  These integers are
100
101             (1) the magic number (octal 0432);
102
103             (2) the size, in bytes, of the names section;
104
105             (3) the number of bytes in the boolean section;
106
107             (4) the number of short integers in the numbers section;
108
109             (5) the number of offsets (short integers) in the strings section;
110
111             (6) the size, in bytes, of the string table.
112
113        Short  integers are stored in two 8-bit bytes.  The first byte contains
114        the least significant 8 bits of the value, and the second byte contains
115        the  most significant 8 bits.  (Thus, the value represented is 256*sec-
116        ond+first.)  The value -1 is represented by the two bytes  0377,  0377;
117        other  negative values are illegal. This value generally means that the
118        corresponding capability is missing from this terminal.  Note that this
119        format corresponds to the hardware of the VAX and PDP-11 (that is, lit-
120        tle-endian machines).  Machines where this does not correspond  to  the
121        hardware  must  read  the integers as two bytes and compute the little-
122        endian value.
123
124        The terminal names section comes next.  It contains the first  line  of
125        the  terminfo  description, listing the various names for the terminal,
126        separated by the "|" character.  The  section  is  terminated  with  an
127        ASCII NUL character.
128
129        The  boolean  flags have one byte for each flag.  This byte is either 0
130        or 1 as the flag is present or absent.  The  capabilities  are  in  the
131        same order as the file &lt;term.h&gt;.
132
133        Between the boolean section and the number section, a null byte will be
134        inserted, if necessary, to ensure that the number section begins on  an
135        even byte (this is a relic of the PDP-11's word-addressed architecture,
136        originally designed in to avoid IOT traps induced by addressing a  word
137        on  an  odd  byte boundary).  All short integers are aligned on a short
138        word boundary.
139
140        The numbers section is similar to the flags section.   Each  capability
141        takes up two bytes, and is stored as a little-endian short integer.  If
142        the value represented is -1, the capability is taken to be missing.
143
144        The strings section is also similar.  Each capability is  stored  as  a
145        short integer, in the format above.  A value of -1 means the capability
146        is missing.  Otherwise, the value is taken as an offset from the begin-
147        ning  of the string table.  Special characters in ^X or \c notation are
148        stored in their interpreted  form,  not  the  printing  representation.
149        Padding  information  $&lt;nn&gt;  and  parameter  information  %x are stored
150        intact in uninterpreted form.
151
152        The final section is the string table.  It contains all the  values  of
153        string  capabilities  referenced in the string section.  Each string is
154        null terminated.
155
156
157 </PRE><H3><a name="h3-EXTENDED-STORAGE-FORMAT">EXTENDED STORAGE FORMAT</a></H3><PRE>
158        The previous section describes the conventional terminfo binary format.
159        With  some  minor variations of the offsets (see PORTABILITY), the same
160        binary format is used in all modern UNIX systems.  Each system  uses  a
161        predefined set of boolean, number or string capabilities.
162
163        The ncurses libraries and applications support extended terminfo binary
164        format, allowing users to define capabilities which are loaded at  run-
165        time.  This extension is made possible by using the fact that the other
166        implementations stop reading the terminfo data when they  have  reached
167        the  end of the size given in the header.  ncurses checks the size, and
168        if it exceeds that due to  the  predefined  data,  continues  to  parse
169        according to its own scheme.
170
171        First, it reads the extended header (5 short integers):
172
173             (1)  count of extended boolean capabilities
174
175             (2)  count of extended numeric capabilities
176
177             (3)  count of extended string capabilities
178
179             (4)  size of the extended string table in bytes.
180
181             (5)  last offset of the extended string table in bytes.
182
183        Using the counts and sizes, ncurses allocates arrays and reads data for
184        the extended capabilities in the same order as the header information.
185
186        The extended string table  contains  values  for  string  capabilities.
187        After  the  end  of these values, it contains the names for each of the
188        extended capabilities  in  order,  e.g.,  booleans,  then  numbers  and
189        finally strings.
190
191        Applications  which  manipulate  terminal  data can use the definitions
192        described in <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> which  associate  the  long  capability
193        names with members of a <STRONG>TERMTYPE</STRONG> structure.
194
195
196 </PRE><H3><a name="h3-EXTENDED-NUMBER-FORMAT">EXTENDED NUMBER FORMAT</a></H3><PRE>
197        On occasion, 16-bit signed integers are not large enough.  With ncurses
198        6.1, a new format is introduced by making a few changes to  the  legacy
199        format:
200
201        <STRONG>o</STRONG>   a different magic number (0542)
202
203        <STRONG>o</STRONG>   changing  the type for the <EM>number</EM> array from signed 16-bit integers
204            to signed 32-bit integers.
205
206        To maintain compatibility, the library presents the  same  data  struc-
207        tures to direct users of the <STRONG>TERMTYPE</STRONG> structure as in previous formats.
208        However, that cannot provide callers with the  extended  numbers.   The
209        library  uses  a similar but hidden data structure <STRONG>TERMTYPE2</STRONG> to provide
210        data for the terminfo functions.
211
212
213 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
214        Note that it is possible for <STRONG>setupterm</STRONG> to expect  a  different  set  of
215        capabilities  than  are actually present in the file.  Either the data-
216        base may have been updated since <STRONG>setupterm</STRONG> has been recompiled (result-
217        ing  in extra unrecognized entries in the file) or the program may have
218        been recompiled more recently than the database was updated  (resulting
219        in  missing  entries).  The routine <STRONG>setupterm</STRONG> must be prepared for both
220        possibilities - this is why the numbers and sizes are included.   Also,
221        new  capabilities must always be added at the end of the lists of bool-
222        ean, number, and string capabilities.
223
224        Despite the consistent use of little-endian for numbers and the  other-
225        wise  self-describing format, it is not wise to count on portability of
226        binary terminfo entries between commercial UNIX versions.  The  problem
227        is  that  there  are  at least three versions of terminfo (under HP-UX,
228        AIX, and OSF/1) which diverged from System V terminfo after  SVr1,  and
229        have  added  extension  capabilities  to  the string table that (in the
230        binary format) collide with System V and XSI  Curses  extensions.   See
231        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>  for  detailed  discussion of terminfo source compatibility
232        issues.
233
234        Direct access to the <STRONG>TERMTYPE</STRONG> structure is provided for legacy applica-
235        tions.   Portable  applications  should  use  the <STRONG>tigetflag</STRONG> and related
236        functions described in <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> for reading terminal capabili-
237        ties.
238
239
240 </PRE><H2><a name="h2-EXAMPLE">EXAMPLE</a></H2><PRE>
241        As an example, here is a description for the Lear-Siegler ADM-3, a pop-
242        ular though rather stupid early terminal:
243
244          adm3a|lsi adm3a,
245                  am,
246                  cols#80, lines#24,
247                  bel=^G, clear= 32$&lt;1&gt;, cr=^M, cub1=^H, cud1=^J,
248                  cuf1=^L, cup=\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,
249                  home=^^, ind=^J,
250
251
252        and a hexadecimal dump of the compiled terminal description:
253
254          0000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
255          0010  61 7c 6c 73 69 20 61 64  6d 33 61 00 00 01 50 00  a|lsi ad m3a...P.
256          0020  ff ff 18 00 ff ff 00 00  02 00 ff ff ff ff 04 00  ........ ........
257          0030  ff ff ff ff ff ff ff ff  0a 00 25 00 27 00 ff ff  ........ ..%.'...
258          0040  29 00 ff ff ff ff 2b 00  ff ff 2d 00 ff ff ff ff  ).....+. ..-.....
259          0050  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
260          0060  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
261          0070  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
262          0080  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
263          0090  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
264          00a0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
265          00b0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
266          00c0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
267          00d0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
268          00e0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
269          00f0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
270          0100  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
271          0110  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
272          0120  ff ff ff ff ff ff 2f 00  07 00 0d 00 1a 24 3c 31  ....../. .....$&lt;1
273          0130  3e 00 1b 3d 25 70 31 25  7b 33 32 7d 25 2b 25 63  &gt;..=%p1% {32}%+%c
274          0140  25 70 32 25 7b 33 32 7d  25 2b 25 63 00 0a 00 1e  %p2%{32} %+%c....
275          0150  00 08 00 0c 00 0b 00 0a  00                       ........ .
276
277
278
279 </PRE><H2><a name="h2-LIMITS">LIMITS</a></H2><PRE>
280        Some limitations:
281
282        <STRONG>o</STRONG>   total compiled entries cannot exceed 4096 bytes in the legacy  for-
283            mat.
284
285        <STRONG>o</STRONG>   total  compiled  entries  cannot exceed 32768 bytes in the extended
286            format.
287
288        <STRONG>o</STRONG>   the name field cannot exceed 128 bytes.
289
290
291 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
292        /usr/local/ncurses/lib/terminfo/*/*     compiled  terminal   capability
293        data base
294
295
296 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
297        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
298
299
300 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
301        Thomas E. Dickey
302        extended terminfo format for ncurses 5.0
303        hashed database support for ncurses 5.6
304        extended number support for ncurses 6.1
305
306        Eric S. Raymond
307        documented legacy terminfo format, e.g., from pdcurses.
308
309
310
311                                                                        <STRONG><A HREF="term.5.html">term(5)</A></STRONG>
312 </PRE>
313 <div class="nav">
314 <ul>
315 <li><a href="#h2-NAME">NAME</a></li>
316 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
317 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
318 <ul>
319 <li><a href="#h3-STORAGE-LOCATION">STORAGE LOCATION</a></li>
320 <li><a href="#h3-LEGACY-STORAGE-FORMAT">LEGACY STORAGE FORMAT</a></li>
321 <li><a href="#h3-EXTENDED-STORAGE-FORMAT">EXTENDED STORAGE FORMAT</a></li>
322 <li><a href="#h3-EXTENDED-NUMBER-FORMAT">EXTENDED NUMBER FORMAT</a></li>
323 </ul>
324 </li>
325 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
326 <li><a href="#h2-EXAMPLE">EXAMPLE</a></li>
327 <li><a href="#h2-LIMITS">LIMITS</a></li>
328 <li><a href="#h2-FILES">FILES</a></li>
329 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
330 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
331 </ul>
332 </div>
333 </BODY>
334 </HTML>