ncurses 6.4 - patch 20230917

[ncurses.git] / man / term.5

diff --git a/man/term.5 b/man/term.5
index b21e90f8ffa669277448b372c66983e663beb48d..2db2d5028c8d1e85c80f6ffd4f81a5ac4e69205c 100644 (file)
--- a/man/term.5
+++ b/man/term.5
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2018-2021,2023 Thomas E. Dickey                                *
 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,19 +27,24 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: term.5,v 1.43 2021/12/25 21:28:59 tom Exp $
-.TH term 5
+.\" $Id: term.5,v 1.56 2023/09/16 23:38:39 tom Exp $
+.TH term 5 2023-09-16 "ncurses 6.4" "File formats"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
+.ie n .ds CW R
+.el   \{
+.ie \n(.g .ds CW CR
+.el       .ds CW CW
+.\}
 .de NS
 .ie n  .sp
 .el    .sp .5
 .ie n  .in +4
 .el    .in +2
 .nf
-.ft C                  \" Courier
+.ft \*(CW
 ..
 .de NE
 .fi
@@ -54,7 +59,8 @@
 .ds n 5
 .ds d @TERMINFO@
 .SH NAME
-term \- format of compiled term file.
+term \-
+compiled \fIterminfo\fR terminal description
 .SH SYNOPSIS
 .B term
 .SH DESCRIPTION
@@ -262,7 +268,6 @@ described in \fBterm_variables\fP(3X) which associate the long capability
 names with members of a \fBTERMTYPE\fP structure.
 .
 .SS EXTENDED NUMBER FORMAT
-.PP
 On occasion, 16-bit signed integers are not large enough.
 With \fBncurses\fP 6.1, a new format was introduced by making a few changes
 to the legacy format:
@@ -279,7 +284,6 @@ The library uses a similar but hidden data structure \fBTERMTYPE2\fP
 to provide data for the terminfo functions.
 .SH PORTABILITY
 .SS setupterm
-.PP
 Note that it is possible for
 .B setupterm
 to expect a different set of capabilities
@@ -298,7 +302,6 @@ 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 capabilities.
 .SS Binary format
-.PP
 X/Open Curses does not specify a format for the terminfo database.
 UNIX System V curses used a directory-tree of binary files,
 one per terminal description.
@@ -322,7 +325,6 @@ The format used by the other Unix versions
 can be matched by building ncurses
 with different configuration options.
 .SS Magic codes
-.PP
 The magic number in a binary terminfo file is the first 16-bits (two bytes).
 Besides making it more reliable for the library to check that a file
 is terminfo,
@@ -332,13 +334,11 @@ with 0433, 0435 as screen-dumps (see \fBscr_dump\fP(5)).
 This implementation uses 01036 as a continuation of that sequence,
 but with a different high-order byte to avoid confusion.
 .SS The TERMTYPE structure
-.PP
 Direct access to the \fBTERMTYPE\fP structure is provided for legacy
 applications.
 Portable applications should use the \fBtigetflag\fP and related functions
 described in \fBcurs_terminfo\fP(3X) for reading terminal capabilities.
 .SS Mixed-case terminal names
-.PP
 A small number of terminal descriptions use uppercase characters in
 their names.
 If the underlying filesystem ignores the difference between
@@ -356,12 +356,15 @@ adm3a|lsi adm3a,
         bel=^G, clear=\032$<1>, cr=^M, cub1=^H, cud1=^J,
         cuf1=^L, cup=\\E=%p1%{32}%+%c%p2%{32}%+%c, cuu1=^K,
         home=^^, ind=^J,
-.NS
+.NE
 .PP
 and a hexadecimal dump of the compiled terminal description:
-.NS
-.ft CW
-\s-20000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
+.PP
+.ie n .in -2n
+.el   .in +4n
+.TS
+lp-1f(\*(CW).
+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  ........ ..%.'...
@@ -382,10 +385,9 @@ and a hexadecimal dump of the compiled terminal description:
 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                       ........ .\s+2
-.ft R
-.NE
-.sp
+0150  00 08 00 0c 00 0b 00 0a  00                       ........ .
+.TE
+.in
 .SH LIMITS
 Some limitations:
 .bP
@@ -400,7 +402,7 @@ Compiled entries are limited to 32768 bytes because offsets into the
 The legacy format could have supported 32768-byte entries,
 but was limited a virtual memory page's 4096 bytes.
 .SH FILES
-\*d/*/*        compiled terminal capability database
+\*d/*/* compiled terminal capability database
 .SH SEE ALSO
 \fBcurses\fP(3X), \fBterminfo\fP(\*n).
 .SH AUTHORS