ncurses 6.0 - patch 20180121
[ncurses.git] / man / term.5
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: term.5,v 1.27 2017/12/16 21:27:20 tom Exp $
30 .TH term 5
31 .ie \n(.g .ds `` \(lq
32 .el       .ds `` ``
33 .ie \n(.g .ds '' \(rq
34 .el       .ds '' ''
35 .de NS
36 .ie n  .sp
37 .el    .sp .5
38 .ie n  .in +4
39 .el    .in +2
40 .nf
41 .ft C                   \" Courier
42 ..
43 .de NE
44 .fi
45 .ft R
46 .in -4
47 ..
48 .de bP
49 .ie n  .IP \(bu 4
50 .el    .IP \(bu 2
51 ..
52 .ds n 5
53 .ds d @TERMINFO@
54 .SH NAME
55 term \- format of compiled term file.
56 .SH SYNOPSIS
57 .B term
58 .SH DESCRIPTION
59 .SS STORAGE LOCATION
60 Compiled terminfo descriptions are placed under the directory \fB\*d\fP.
61 Two configurations are supported (when building the ncurses libraries):
62 .TP 5
63 .B directory tree
64 A two-level scheme is used to avoid a linear search
65 of a huge \s-1UNIX\s+1 system directory: \fB\*d/c/name\fP where
66 .I name
67 is the name of the terminal, and
68 .I c
69 is the first character of
70 .IR name .
71 Thus,
72 .I act4
73 can be found in the file \fB\*d/a/act4\fP.
74 Synonyms for the same terminal are implemented by multiple
75 links to the same compiled file.
76 .TP 5
77 .B hashed database
78 Using Berkeley database, two types of records are stored:
79 the terminfo data in the same format as stored in a directory tree with
80 the terminfo's primary name as a key,
81 and records containing only aliases pointing to the primary name.
82 .IP
83 If built to write hashed databases,
84 ncurses can still read terminfo databases organized as a directory tree,
85 but cannot write entries into the directory tree.
86 It can write (or rewrite) entries in the hashed database.
87 .IP
88 ncurses distinguishes the two cases in the TERMINFO and TERMINFO_DIRS
89 environment variable by assuming a directory tree for entries that
90 correspond to an existing directory,
91 and hashed database otherwise.
92 .SS LEGACY STORAGE FORMAT
93 The format has been chosen so that it will be the same on all hardware.
94 An 8 or more bit byte is assumed, but no assumptions about byte ordering
95 or sign extension are made.
96 .PP
97 The compiled file is created with the \fB@TIC@\fP program,
98 and read by the routine \fBsetupterm\fP(3X).
99 The file is divided into six parts:
100 the header,
101 terminal names,
102 boolean flags,
103 numbers,
104 strings,
105 and
106 string table.
107 .PP
108 The header section begins the file.
109 This section contains six short integers in the format
110 described below.
111 These integers are
112 .RS 5
113 .TP 5
114 (1) the magic number (octal 0432);
115 .TP 5
116 (2) the size, in bytes, of the names section;
117 .TP 5
118 (3) the number of bytes in the boolean section;
119 .TP 5
120 (4) the number of short integers in the numbers section;
121 .TP 5
122 (5) the number of offsets (short integers) in the strings section;
123 .TP 5
124 (6) the size, in bytes, of the string table.
125 .RE
126 .PP
127 Short integers are stored in two 8-bit bytes.
128 The first byte contains the least significant 8 bits of the value,
129 and the second byte contains the most significant 8 bits.
130 (Thus, the value represented is 256*second+first.)
131 The value \-1 is represented by the two bytes 0377, 0377; other negative
132 values are illegal. This value generally
133 means that the corresponding capability is missing from this terminal.
134 Note that this format corresponds to the hardware of the \s-1VAX\s+1
135 and \s-1PDP\s+1-11 (that is, little-endian machines).
136 Machines where this does not correspond to the hardware must read the
137 integers as two bytes and compute the little-endian value.
138 .PP
139 The terminal names section comes next.
140 It contains the first line of the terminfo description,
141 listing the various names for the terminal,
142 separated by the \*(``|\*('' character.
143 The section is terminated with an \s-1ASCII NUL\s+1 character.
144 .PP
145 The boolean flags have one byte for each flag.
146 This byte is either 0 or 1 as the flag is present or absent.
147 The capabilities are in the same order as the file <term.h>.
148 .PP
149 Between the boolean section and the number section,
150 a null byte will be inserted, if necessary,
151 to ensure that the number section begins on an even byte (this is a
152 relic of the PDP\-11's word-addressed architecture, originally
153 designed in to avoid IOT traps induced by addressing a word on an
154 odd byte boundary).
155 All short integers are aligned on a short word boundary.
156 .PP
157 The numbers section is similar to the flags section.
158 Each capability takes up two bytes,
159 and is stored as a little-endian short integer.
160 If the value represented is \-1, the capability is taken to be missing.
161 .PP
162 The strings section is also similar.
163 Each capability is stored as a short integer, in the format above.
164 A value of \-1 means the capability is missing.
165 Otherwise, the value is taken as an offset from the beginning
166 of the string table.
167 Special characters in ^X or \ec notation are stored in their
168 interpreted form, not the printing representation.
169 Padding information $<nn> and parameter information %x are
170 stored intact in uninterpreted form.
171 .PP
172 The final section is the string table.
173 It contains all the values of string capabilities referenced in
174 the string section.
175 Each string is null terminated.
176 .SS EXTENDED STORAGE FORMAT
177 The previous section describes the conventional terminfo binary format.
178 With some minor variations of the offsets (see PORTABILITY),
179 the same binary format is used in all modern UNIX systems.
180 Each system uses a predefined set of boolean, number or string capabilities.
181 .PP
182 The ncurses libraries and applications support extended terminfo binary format,
183 allowing users to define capabilities which are loaded at runtime.  This
184 extension is made possible by using the fact that the other implementations
185 stop reading the terminfo data when they have reached the end of the size given
186 in the header.
187 ncurses checks the size, and if it exceeds that due to the predefined data,
188 continues to parse according to its own scheme.
189 .PP
190 First, it reads the extended header (5 short integers):
191 .RS 5
192 .TP 5
193 (1)
194 count of extended boolean capabilities
195 .TP 5
196 (2)
197 count of extended numeric capabilities
198 .TP 5
199 (3)
200 count of extended string capabilities
201 .TP 5
202 (4)
203 size of the extended string table in bytes.
204 .TP 5
205 (5)
206 last offset of the extended string table in bytes.
207 .RE
208 .PP
209 Using the counts and sizes, ncurses allocates arrays and reads data
210 for the extended capabilities in the same order as the header information.
211 .PP
212 The extended string table contains values for string capabilities.
213 After the end of these values, it contains the names for each of
214 the extended capabilities in order, e.g., booleans, then numbers and
215 finally strings.
216 .PP
217 Applications which manipulate terminal data can use the definitions
218 described in \fBterm_variables\fP(3X) which associate the long capability
219 names with members of a \fBTERMTYPE\fP structure.
220 .
221 .SS EXTENDED NUMBER FORMAT
222 .PP
223 On occasion, 16-bit signed integers are not large enough.
224 With ncurses 6.1, a new format is introduced by making a few changes
225 to the legacy format:
226 .bP
227 a different magic number (0542)
228 .bP
229 changing the type for the \fInumber\fP array from signed 16-bit integers
230 to signed 32-bit integers.
231 .PP
232 To maintain compatibility, the library presents the same data structures
233 to direct users of the \fBTERMTYPE\fP structure as in previous formats.
234 However, that cannot provide callers with the extended numbers.
235 The library uses a similar but hidden data structure \fBTERMTYPE2\fP
236 to provide data for the terminfo functions.
237 .SH PORTABILITY
238 Note that it is possible for
239 .B setupterm
240 to expect a different set of capabilities
241 than are actually present in the file.
242 Either the database may have been updated since
243 .B setupterm
244 has been recompiled
245 (resulting in extra unrecognized entries in the file)
246 or the program may have been recompiled more recently
247 than the database was updated
248 (resulting in missing entries).
249 The routine
250 .B setupterm
251 must be prepared for both possibilities \-
252 this is why the numbers and sizes are included.
253 Also, new capabilities must always be added at the end of the lists
254 of boolean, number, and string capabilities.
255 .PP
256 Despite the consistent use of little-endian for numbers and the otherwise
257 self-describing format, it is not wise to count on portability of binary
258 terminfo entries between commercial UNIX versions.  The problem is that there
259 are at least three versions of terminfo (under HP\-UX, AIX, and OSF/1) which
260 diverged from System V terminfo after SVr1, and have added extension
261 capabilities to the string table that (in the binary format) collide with
262 System V and XSI Curses extensions.  See \fBterminfo\fR(\*n) for detailed
263 discussion of terminfo source compatibility issues.
264 .PP
265 Direct access to the \fBTERMTYPE\fP structure is provided for legacy
266 applications.
267 Portable applications should use the \fBtigetflag\fP and related functions
268 described in \fBcurs_terminfo\fP(3X) for reading terminal capabilities.
269 .PP
270 A small number of terminal descriptions use uppercase characters in
271 their names.
272 If the underlying filesystem ignores the difference between
273 uppercase and lowercase,
274 ncurses represents the \*(``first character\*('' of the terminal name used as
275 the intermediate level of a directory tree in (two-character) hexadecimal form.
276 .SH EXAMPLE
277 As an example, here is a description for the Lear-Siegler
278 ADM\-3, a popular though rather stupid early terminal:
279 .NS
280 adm3a|lsi adm3a,
281         am,
282         cols#80, lines#24,
283         bel=^G, clear=\032$<1>, cr=^M, cub1=^H, cud1=^J,
284         cuf1=^L, cup=\\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,
285         home=^^, ind=^J,
286 .NS
287 .PP
288 and a hexadecimal dump of the compiled terminal description:
289 .NS
290 .ft CW
291 \s-20000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
292 0010  61 7c 6c 73 69 20 61 64  6d 33 61 00 00 01 50 00  a|lsi ad m3a...P.
293 0020  ff ff 18 00 ff ff 00 00  02 00 ff ff ff ff 04 00  ........ ........
294 0030  ff ff ff ff ff ff ff ff  0a 00 25 00 27 00 ff ff  ........ ..%.'...
295 0040  29 00 ff ff ff ff 2b 00  ff ff 2d 00 ff ff ff ff  ).....+. ..-.....
296 0050  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
297 0060  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
298 0070  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
299 0080  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
300 0090  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
301 00a0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
302 00b0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
303 00c0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
304 00d0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
305 00e0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
306 00f0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
307 0100  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
308 0110  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
309 0120  ff ff ff ff ff ff 2f 00  07 00 0d 00 1a 24 3c 31  ....../. .....$<1
310 0130  3e 00 1b 3d 25 70 31 25  7b 33 32 7d 25 2b 25 63  >..=%p1% {32}%+%c
311 0140  25 70 32 25 7b 33 32 7d  25 2b 25 63 00 0a 00 1e  %p2%{32} %+%c....
312 0150  00 08 00 0c 00 0b 00 0a  00                       ........ .\s+2
313 .ft R
314 .NE
315 .sp
316 .SH LIMITS
317 Some limitations:
318 .bP
319 total compiled entries cannot exceed 4096 bytes in the legacy format.
320 .bP
321 total compiled entries cannot exceed 32768 bytes in the extended format.
322 .bP
323 the name field cannot exceed 128 bytes.
324 .SH FILES
325 \*d/*/* compiled terminal capability data base
326 .SH SEE ALSO
327 \fBcurses\fR(3X), \fBterminfo\fR(\*n).
328 .SH AUTHORS
329 Thomas E. Dickey
330 .br
331 extended terminfo format for ncurses 5.0
332 .br
333 hashed database support for ncurses 5.6
334 .br
335 extended number support for ncurses 6.1
336 .sp
337 Eric S. Raymond
338 .br
339 documented legacy terminfo format, e.g., from pcurses.