Seth Woolley's Man Viewer

Manual for term - man term

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

TERM(5)                                                                TERM(5)



NAME
       term(5,7) - format of compiled term(5,7) file.

SYNOPSIS
       term(5,7)

DESCRIPTION
       Compiled  terminfo  descriptions  are  placed under the directory @TER-
       MINFO@.  In order to avoid a linear search of a huge UNIX system direc-
       tory,  a  two-level scheme is used: @TERMINFO@/c/name where name is the
       name of the terminal, and c is the first character of name.  Thus, act4
       can be found in(1,8) the file(1,n) @TERMINFO@/a/act4.  Synonyms for the same ter-
       minal are implemented by multiple links to the same compiled file.

       The format has been chosen so that it will be the same on all hardware.
       An  8 or more bit byte is assumed, but no assumptions about byte order-
       ing or sign extension are made.

       The compiled file(1,n) is created with the tic program, and read(2,n,1 builtins) by the rou-
       tine setupterm.  The file(1,n) is divided into six parts: the header, termi-
       nal names, boolean flags, numbers, strings, and string(3,n) table.

       The header section begins the file.  This section  contains  six  short
       integers  in(1,8)  the  format  described below.  These integers are (1) the
       magic(4,5) number (octal 0432); (2) the size, in(1,8) bytes, of  the  names  sec-
       tion; (3) the number of bytes in(1,8) the boolean section; (4) the number of
       short integers in(1,8) the numbers section; (5) the number of offsets (short
       integers) in(1,8) the strings section; (6) the size, in(1,8) bytes, of the string(3,n)
       table.

       Short integers are stored in(1,8) two 8-bit bytes.  The first byte  contains
       the least significant 8 bits of the value, and the second byte contains
       the most significant 8 bits.  (Thus, the value represented is  256*sec-
       ond+first.)   The  value -1 is represented by the two bytes 0377, 0377;
       other negative values are illegal. This value generally means that  the
       corresponding capability is missing from this terminal.  Note that this
       format corresponds to the hardware of the VAX and PDP-11 (that is, lit-
       tle-endian  machines).   Machines where this does not correspond to the
       hardware must read(2,n,1 builtins) the integers as two bytes and  compute  the  little-
       endian value.

       The  terminal  names section comes next.  It contains the first line of
       the terminfo description, listing the various names for  the  terminal,
       separated  by  the  `|'  character.   The section is terminated with an
       ASCII NUL character.

       The boolean flags have one byte for each flag.  This byte is  either  0
       or  1  as  the  flag is present or absent.  The capabilities are in(1,8) the
       same order as the file(1,n) <term.h>.

       Between the boolean section and the number section, a null byte will be
       inserted,  if(3,n) necessary, to ensure that the number section begins on an
       even byte (this is a relic of the PDP-11's word-addressed architecture,
       originally  designed in(1,8) to avoid IOT traps induced by addressing a word
       on an odd byte boundary).  All short integers are aligned  on  a  short
       word boundary.

       The  numbers  section is similar to the flags section.  Each capability
       takes up two bytes, and is stored as a little-endian short integer.  If
       the value represented is -1, the capability is taken to be missing.

       The  strings  section  is also similar.  Each capability is stored as a
       short integer, in(1,8) the format above.  A value of -1 means the capability
       is missing.  Otherwise, the value is taken as an offset from the begin-
       ning of the string(3,n) table.  Special characters in(1,8) ^X or \c notation  are
       stored  in(1,8)  their  interpreted  form,  not the printing representation.
       Padding information $<nn>  and  parameter  information  %x  are  stored
       intact in(1,8) uninterpreted form.

       The  final  section is the string(3,n) table.  It contains all the values of
       string(3,n) capabilities referenced in(1,8) the string(3,n) section.  Each  string(3,n)  is
       null terminated.

       Note  that  it  is  possible for setupterm to expect a different set(7,n,1 builtins) of
       capabilities than are actually present in(1,8) the file.  Either  the  data-
       base may have been updated since setupterm has been recompiled (result-
       ing in(1,8) extra unrecognized entries in(1,8) the file(1,n)) or the program may  have
       been  recompiled more recently than the database was updated (resulting
       in(1,8) missing entries).  The routine setupterm must be prepared  for  both
       possibilities  - this is why the numbers and sizes are included.  Also,
       new capabilities must always be added  at  the  end  of  the  lists  of
       boolean, number, and string(3,n) capabilities.

       Despite  the consistent use of little-endian for numbers and the other-
       wise self-describing format, it is not wise to count on portability  of
       binary  terminfo entries between commercial UNIX versions.  The problem
       is that there are at least three versions  of  terminfo  (under  HP-UX,
       AIX,  and  OSF/1) which diverged from System V terminfo after SVr1, and
       have added extension capabilities to the  string(3,n)  table  that  (in(1,8)  the
       binary  format)  collide  with System V and XSI Curses extensions.  See
       terminfo(5) for detailed discussion of  terminfo  source  compatibility
       issues.

       As  an  example,  here  is  a hex dump of the description for the Lear-
       Siegler ADM-3, a popular though rather stupid early terminal:

       adm3a|lsi adm3a,
               am,
               cols#80, lines#24,
               bel=^G, clear(1,3x,3x clrtobot)= 32$<1>, cr=^M, cub1=^H, cud1=^J,
               cuf1=^L, cup=\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,
               home=^^, ind=^J,

       0000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
       0010  61 7c 6c 73 69 20 61 64  6d 33 61 00 00 01 50 00  a|lsi ad m3a...P.
       0020  ff ff 18 00 ff ff 00 00  02 00 ff ff ff ff 04 00  ........ ........
       0030  ff ff ff ff ff ff ff ff  0a 00 25 00 27 00 ff ff  ........ ..%.'...
       0040  29 00 ff ff ff ff 2b 00  ff ff 2d 00 ff ff ff ff  ).....+. ..-.....
       0050  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0060  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0070  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0080  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0090  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       00a0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       00b0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       00c0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       00d0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       00e0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       00f0  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0100  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0110  ff ff ff ff ff ff ff ff  ff ff ff ff ff ff ff ff  ........ ........
       0120  ff ff ff ff ff ff 2f 00  07 00 0d 00 1a 24 3c 31  ....../. .....$<1
       0130  3e 00 1b 3d 25 70 31 25  7b 33 32 7d 25 2b 25 63  >..=%p1% {32}%+%c
       0140  25 70 32 25 7b 33 32 7d  25 2b 25 63 00 0a 00 1e  %p2%{32} %+%c....
       0150  00 08 00 0c 00 0b 00 0a  00                       ........ .


       Some limitations: total compiled entries cannot exceed 4096 bytes.  The
       name field cannot exceed 128 bytes.

FILES
       @TERMINFO@/*/* compiled terminal capability data base

SEE ALSO
       curses(3X), terminfo(5).



                                                                       TERM(5)

References for this manual (incoming links)