man/term.5

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2021,2023 Thomas E. Dickey                                *
   3 .\" Copyright 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 .\"
  30 .\" $Id: term.5,v 1.58 2023/09/30 21:26:43 tom Exp $
  31 .TH term 5 2023-09-30 "ncurses 6.4" "File formats"
  32 .ie \n(.g .ds `` \(lq
  33 .el       .ds `` ``
  34 .ie \n(.g .ds '' \(rq
  35 .el       .ds '' ''
  36 .ie n .ds CW R
  37 .el   \{
  38 .ie \n(.g .ds CW CR
  39 .el       .ds CW CW
  40 .\}
  41 .de NS
  42 .ie n  .sp
  43 .el    .sp .5
  44 .ie n  .in +4
  45 .el    .in +2
  46 .nf
  47 .ft \*(CW
  48 ..
  49 .de NE
  50 .fi
  51 .ft R
  52 .ie n  .in -4
  53 .el    .in -2
  54 ..
  55 .de bP
  56 .ie n  .IP \(bu 4
  57 .el    .IP \(bu 2
  58 ..
  59 .ds n 5
  60 .ds d @TERMINFO@
  61 .SH NAME
  62 term \-
  63 compiled \fIterminfo\fR terminal description
  64 .SH SYNOPSIS
  65 .B term
  66 .SH DESCRIPTION
  67 .SS STORAGE LOCATION
  68 Compiled terminfo descriptions are placed under the directory \fB\*d\fP.
  69 Two configurations are supported (when building the \fBncurses\fP libraries):
  70 .TP 5
  71 .B directory tree
  72 A two-level scheme is used to avoid a linear search
  73 of a huge \s-1UNIX\s+1 system directory: \fB\*d/c/name\fP where
  74 .I name
  75 is the name of the terminal, and
  76 .I c
  77 is the first character of
  78 .IR name .
  79 Thus,
  80 .I act4
  81 can be found in the file \fB\*d/a/act4\fP.
  82 Synonyms for the same terminal are implemented by multiple
  83 links to the same compiled file.
  84 .TP 5
  85 .B hashed database
  86 Using Berkeley database, two types of records are stored:
  87 the terminfo data in the same format as stored in a directory tree with
  88 the terminfo's primary name as a key,
  89 and records containing only aliases pointing to the primary name.
  90 .IP
  91 If built to write hashed databases,
  92 \fBncurses\fP can still read terminfo databases organized as a directory tree,
  93 but cannot write entries into the directory tree.
  94 It can write (or rewrite) entries in the hashed database.
  95 .IP
  96 \fBncurses\fP distinguishes the two cases in the TERMINFO and TERMINFO_DIRS
  97 environment variable by assuming a directory tree for entries that
  98 correspond to an existing directory,
  99 and hashed database otherwise.
 100 .SS LEGACY STORAGE FORMAT
 101 The format has been chosen so that it will be the same on all hardware.
 102 An 8 or more bit byte is assumed, but no assumptions about byte ordering
 103 or sign extension are made.
 104 .PP
 105 The compiled file is created with the \fB@TIC@\fP program,
 106 and read by the routine \fBsetupterm\fP(3X).
 107 The file is divided into six parts:
 108 .RS 5
 109 .TP 3
 110 a) \fIheader\fP,
 111 .TP 3
 112 b) \fIterminal names\fP,
 113 .TP 3
 114 c) \fIboolean flags\fP,
 115 .TP 3
 116 d) \fInumbers\fP,
 117 .TP 3
 118 e) \fIstrings\fP, and
 119 .TP 3
 120 f) \fIstring table\fP.
 121 .RE
 122 .PP
 123 The \fIheader\fP section begins the file.
 124 This section contains six short integers in the format
 125 described below.
 126 These integers are
 127 .RS 5
 128 .TP 5
 129 (1) the \fImagic number\fP (octal 0432);
 130 .TP 5
 131 (2) the size, in bytes, of the \fIterminal names\fP section;
 132 .TP 5
 133 (3) the number of bytes in the \fIboolean flags\fP section;
 134 .TP 5
 135 (4) the number of short integers in the \fInumbers\fP section;
 136 .TP 5
 137 (5) the number of offsets (short integers) in the \fIstrings\fP section;
 138 .TP 5
 139 (6) the size, in bytes, of the \fIstring table\fP.
 140 .RE
 141 .PP
 142 The capabilities in the
 143 \fIboolean flags\fP,
 144 \fInumbers\fP, and
 145 \fIstrings\fP
 146 sections are in the same order as the file <term.h>.
 147 .PP
 148 Short integers are signed, in the range \-32768 to 32767.
 149 They are stored as two 8-bit bytes.
 150 The first byte contains the least significant 8 bits of the value,
 151 and the second byte contains the most significant 8 bits.
 152 (Thus, the value represented is 256*second+first.)
 153 This format corresponds to the hardware of the \s-1VAX\s+1
 154 and \s-1PDP\s+1-11 (that is, little-endian machines).
 155 Machines where this does not correspond to the hardware must read the
 156 integers as two bytes and compute the little-endian value.
 157 .PP
 158 Numbers in a terminal description,
 159 whether they are entries in the \fInumbers\fP or \fIstrings\fP table,
 160 are positive integers.
 161 Boolean flags are treated as positive one-byte integers.
 162 In each case, those positive integers represent a terminal capability.
 163 The terminal compiler @TIC@ uses negative integers to handle the cases where
 164 a capability is not available:
 165 .bP
 166 If a capability is absent from this terminal,
 167 @TIC@ stores a \-1 in the corresponding table.
 168 .IP
 169 The integer value \-1 is represented by two bytes 0377, 0377.
 170 .br
 171 Absent boolean values are represented by the byte 0 (false).
 172 .bP
 173 If a capability has been canceled from this terminal,
 174 @TIC@ stores a \-2 in the corresponding table.
 175 .IP
 176 The integer value \-2 is represented by two bytes 0377, 0376.
 177 .br
 178 The boolean value \-2 is represented by the byte 0376.
 179 .br
 180 .bP
 181 Other negative values are illegal.
 182 .PP
 183 The \fIterminal names\fP section comes after the \fIheader\fP.
 184 It contains the first line of the terminfo description,
 185 listing the various names for the terminal,
 186 separated by the \*(``|\*('' character.
 187 The \fIterminal names\fP section is terminated
 188 with an \s-1ASCII NUL\s+1 character.
 189 .PP
 190 The \fIboolean flags\fP section has one byte for each flag.
 191 Boolean capabilities are either 1 or 0 (true or false)
 192 according to whether the terminal supports the given capability or not.
 193 .PP
 194 Between the \fIboolean flags\fP section and the \fInumber\fP section,
 195 a null byte will be inserted, if necessary,
 196 to ensure that the \fInumber\fP section begins on an even byte
 197 This is a relic of the PDP\-11's word-addressed architecture,
 198 originally designed to avoid traps induced
 199 by addressing a word on an odd byte boundary.
 200 All short integers are aligned on a short word boundary.
 201 .PP
 202 The \fInumbers\fP section is similar to the \fIboolean flags\fP section.
 203 Each capability takes up two bytes,
 204 and is stored as a little-endian short integer.
 205 .PP
 206 The \fIstrings\fP section is also similar.
 207 Each capability is stored as a short integer.
 208 The capability value is an index into the \fIstring table\fP.
 209 .PP
 210 The \fIstring table\fP is the last section.
 211 It contains all of the values of string capabilities referenced in
 212 the \fIstrings\fP section.
 213 Each string is null-terminated.
 214 Special characters in ^X or \ec notation are stored in their
 215 interpreted form, not the printing representation.
 216 Padding information $<nn> and parameter information %x are
 217 stored intact in uninterpreted form.
 218 .SS EXTENDED STORAGE FORMAT
 219 The previous section describes the conventional terminfo binary format.
 220 With some minor variations of the offsets (see PORTABILITY),
 221 the same binary format is used in all modern UNIX systems.
 222 Each system uses a predefined set of boolean, number or string capabilities.
 223 .PP
 224 The \fBncurses\fP libraries and applications support
 225 extended terminfo binary format,
 226 allowing users to define capabilities which are loaded at runtime.
 227 This
 228 extension is made possible by using the fact that the other implementations
 229 stop reading the terminfo data when they have reached the end of the size given
 230 in the header.
 231 \fBncurses\fP checks the size,
 232 and if it exceeds that due to the predefined data,
 233 continues to parse according to its own scheme.
 234 .PP
 235 First, it reads the extended header (5 short integers):
 236 .RS 5
 237 .TP 5
 238 (1)
 239 count of extended boolean capabilities
 240 .TP 5
 241 (2)
 242 count of extended numeric capabilities
 243 .TP 5
 244 (3)
 245 count of extended string capabilities
 246 .TP 5
 247 (4)
 248 count of the items in extended string table
 249 .TP 5
 250 (5)
 251 size of the extended string table in bytes
 252 .RE
 253 .PP
 254 The count- and size-values for the extended string table
 255 include the extended capability \fInames\fP as well as
 256 extended capability \fIvalues\fP.
 257 .PP
 258 Using the counts and sizes, \fBncurses\fP allocates arrays and reads data
 259 for the extended capabilities in the same order as the header information.
 260 .PP
 261 The extended string table contains values for string capabilities.
 262 After the end of these values, it contains the names for each of
 263 the extended capabilities in order, e.g., booleans, then numbers and
 264 finally strings.
 265 .PP
 266 Applications which manipulate terminal data can use the definitions
 267 described in \fBterm_variables\fP(3X) which associate the long capability
 268 names with members of a \fBTERMTYPE\fP structure.
 269 .
 270 .SS EXTENDED NUMBER FORMAT
 271 On occasion, 16-bit signed integers are not large enough.
 272 With \fBncurses\fP 6.1, a new format was introduced by making a few changes
 273 to the legacy format:
 274 .bP
 275 a different magic number (octal 01036)
 276 .bP
 277 changing the type for the \fInumber\fP array from signed 16-bit integers
 278 to signed 32-bit integers.
 279 .PP
 280 To maintain compatibility, the library presents the same data structures
 281 to direct users of the \fBTERMTYPE\fP structure as in previous formats.
 282 However, that cannot provide callers with the extended numbers.
 283 The library uses a similar but hidden data structure \fBTERMTYPE2\fP
 284 to provide data for the terminfo functions.
 285 .SH PORTABILITY
 286 .SS setupterm
 287 Note that it is possible for
 288 .B setupterm
 289 to expect a different set of capabilities
 290 than are actually present in the file.
 291 Either the database may have been updated since
 292 .B setupterm
 293 was recompiled
 294 (resulting in extra unrecognized entries in the file)
 295 or the program may have been recompiled more recently
 296 than the database was updated
 297 (resulting in missing entries).
 298 The routine
 299 .B setupterm
 300 must be prepared for both possibilities \-
 301 this is why the numbers and sizes are included.
 302 Also, new capabilities must always be added at the end of the lists
 303 of boolean, number, and string capabilities.
 304 .SS Binary format
 305 X/Open Curses does not specify a format for the terminfo database.
 306 UNIX System V curses used a directory-tree of binary files,
 307 one per terminal description.
 308 .PP
 309 Despite the consistent use of little-endian for numbers and the otherwise
 310 self-describing format, it is not wise to count on portability of binary
 311 terminfo entries between commercial UNIX versions.
 312 The problem is that there
 313 are at least three versions of terminfo (under HP\-UX, AIX, and OSF/1) which
 314 diverged from System V terminfo after SVr1, and have added extension
 315 capabilities to the string table that (in the binary format) collide with
 316 System V and XSI Curses extensions.
 317 See \fBterminfo\fP(\*n) for detailed
 318 discussion of terminfo source compatibility issues.
 319 .PP
 320 This implementation is by default compatible with the binary
 321 terminfo format used by Solaris curses,
 322 except in a few less-used details
 323 where it was found that the latter did not match X/Open Curses.
 324 The format used by the other Unix versions
 325 can be matched by building ncurses
 326 with different configuration options.
 327 .SS Magic codes
 328 The magic number in a binary terminfo file is the first 16-bits (two bytes).
 329 Besides making it more reliable for the library to check that a file
 330 is terminfo,
 331 utilities such as \fBfile\fP(1) also use that to tell what the file-format is.
 332 System V defined more than one magic number,
 333 with 0433, 0435 as screen-dumps (see \fBscr_dump\fP(5)).
 334 This implementation uses 01036 as a continuation of that sequence,
 335 but with a different high-order byte to avoid confusion.
 336 .SS The TERMTYPE structure
 337 Direct access to the \fBTERMTYPE\fP structure is provided for legacy
 338 applications.
 339 Portable applications should use the \fBtigetflag\fP and related functions
 340 described in \fBcurs_terminfo\fP(3X) for reading terminal capabilities.
 341 .SS Mixed-case terminal names
 342 A small number of terminal descriptions use uppercase characters in
 343 their names.
 344 If the underlying filesystem ignores the difference between
 345 uppercase and lowercase,
 346 \fBncurses\fP represents the \*(``first character\*(''
 347 of the terminal name used as
 348 the intermediate level of a directory tree in (two-character) hexadecimal form.
 349 .SH EXAMPLE
 350 As an example, here is a description for the Lear-Siegler
 351 ADM\-3, a popular though rather stupid early terminal:
 352 .NS
 353 adm3a|lsi adm3a,
 354         am,
 355         cols#80, lines#24,
 356         bel=^G, clear=\032$<1>, cr=^M, cub1=^H, cud1=^J,
 357         cuf1=^L, cup=\\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,
 358         home=^^, ind=^J,
 359 .NE
 360 .PP
 361 and a hexadecimal dump of the compiled terminal description:
 362 .PP
 363 .ie n .in -2n
 364 .el   .in +4n
 365 .TS
 366 lp-1f(\*(CW).
 367 0000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
 368 0010  61 7c 6c 73 69 20 61 64  6d 33 61 00 00 01 50 00  a|lsi ad m3a...P.
 369 0020  ff ff 18 00 ff ff 00 00  02 00 ff ff ff ff 04 00  ........ ........
 370 0030  ff ff ff ff ff ff ff ff  0a 00 25 00 27 00 ff ff  ........ ..%.'...
 371 0040  29 00 ff ff ff ff 2b 00  ff ff 2d 00 ff ff ff ff  ).....+. ..-.....
 372 0050  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 373 0060  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 374 0070  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 375 0080  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 376 0090  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 377 00a0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 378 00b0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 379 00c0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 380 00d0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 381 00e0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 382 00f0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 383 0100  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 384 0110  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
 385 0120  ff ff ff ff ff ff 2f 00  07 00 0d 00 1a 24 3c 31  ....../. .....$<1
 386 0130  3e 00 1b 3d 25 70 31 25  7b 33 32 7d 25 2b 25 63  >..=%p1% {32}%+%c
 387 0140  25 70 32 25 7b 33 32 7d  25 2b 25 63 00 0a 00 1e  %p2%{32} %+%c....
 388 0150  00 08 00 0c 00 0b 00 0a  00                       ........ .
 389 .TE
 390 .in
 391 .SH LIMITS
 392 Some limitations:
 393 .bP
 394 total compiled entries cannot exceed 4096 bytes in the legacy format.
 395 .bP
 396 total compiled entries cannot exceed 32768 bytes in the extended format.
 397 .bP
 398 the name field cannot exceed 128 bytes.
 399 .PP
 400 Compiled entries are limited to 32768 bytes because offsets into the
 401 \fIstrings table\fP use two-byte integers.
 402 The legacy format could have supported 32768-byte entries,
 403 but was limited a virtual memory page's 4096 bytes.
 404 .SH FILES
 405 \*d/*/* compiled terminal capability database
 406 .SH AUTHORS
 407 Thomas E. Dickey
 408 .br
 409 extended terminfo format for ncurses 5.0
 410 .br
 411 hashed database support for ncurses 5.6
 412 .br
 413 extended number support for ncurses 6.1
 414 .sp
 415 Eric S. Raymond
 416 .br
 417 documented legacy terminfo format, e.g., from \fIpcurses\fP.
 418 .SH SEE ALSO
 419 \fB\%curses\fP(3X),
 420 \fB\%curs_terminfo\fP(3X),
 421 \fB\%terminfo\fP(\*n)