ncurses 5.5

[ncurses.git] / man / term.5

diff --git a/man/term.5 b/man/term.5
index 3ac1fa8686202863b5d81fcce69829563b7a1298..e999b2e8c5142e5edf1138d8b2b5c64c0f3edbdb 100644 (file)
--- a/man/term.5
+++ b/man/term.5
@@ -1,6 +1,35 @@
+.\"***************************************************************************
+.\" Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
+.\"                                                                          *
+.\" Permission is hereby granted, free of charge, to any person obtaining a  *
+.\" copy of this software and associated documentation files (the            *
+.\" "Software"), to deal in the Software without restriction, including      *
+.\" without limitation the rights to use, copy, modify, merge, publish,      *
+.\" distribute, distribute with modifications, sublicense, and/or sell       *
+.\" copies of the Software, and to permit persons to whom the Software is    *
+.\" furnished to do so, subject to the following conditions:                 *
+.\"                                                                          *
+.\" The above copyright notice and this permission notice shall be included  *
+.\" in all copies or substantial portions of the Software.                   *
+.\"                                                                          *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+.\"                                                                          *
+.\" Except as contained in this notice, the name(s) of the above copyright   *
+.\" holders shall not be used in advertising or otherwise to promote the     *
+.\" sale, use or other dealings in this Software without prior written       *
+.\" authorization.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: term.5,v 1.16 2004/07/05 13:16:08 tom Exp $

 .TH TERM 5
 .ds n 5
 .TH TERM 5
 .ds n 5

-.ds d @DATADIR@/terminfo
+.ds d @TERMINFO@

 .SH NAME
 term \- format of compiled term file.
 .SH SYNOPSIS
 .SH NAME
 term \- format of compiled term file.
 .SH SYNOPSIS


@@ -9,7 +38,7 @@ term \- format of compiled term file.
 .PP
 Compiled terminfo descriptions are placed under the directory \fB\*d\fP.
 In order to avoid a linear search of a huge \s-1UNIX\s+1 system directory, a
 .PP
 Compiled terminfo descriptions are placed under the directory \fB\*d\fP.
 In order to avoid a linear search of a huge \s-1UNIX\s+1 system directory, a

-two-level scheme is used: \fB\*b/c/name\fP
+two-level scheme is used: \fB\*d/c/name\fP

 where
 .I name
 is the name of the terminal, and
 where
 .I name
 is the name of the terminal, and


@@ -27,7 +56,7 @@ An 8 or more bit byte is assumed, but no assumptions about byte ordering
 or sign extension are made.
 .PP
 The compiled file is created with the
 or sign extension are made.
 .PP
 The compiled file is created with the

-.I tic 
+.I tic

 program, and read by the routine
 .IR setupterm .
 The file is divided into six parts:
 program, and read by the routine
 .IR setupterm .
 The file is divided into six parts:


@@ -54,8 +83,8 @@ Short integers are stored in 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*second+first.)
 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*second+first.)

-The value \-1 is represented by the two bytes 0377, 0377; other negative
-values are illegal. This value generally 
+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 \s-1VAX\s+1
 and \s-1PDP\s+1-11 (that is, little-endian machines).
 means that the corresponding capability is missing from this terminal.
 Note that this format corresponds to the hardware of the \s-1VAX\s+1
 and \s-1PDP\s+1-11 (that is, little-endian machines).


@@ -83,11 +112,11 @@ 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.
 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.
+If the value represented is -1, the capability is taken to be missing.

 .PP
 The strings section is also similar.
 Each capability is stored as a short integer, in the format above.
 .PP
 The strings section is also similar.
 Each capability is stored as a short integer, in the format above.

-A value of \-1 means the capability is missing.
+A value of -1 means the capability is missing.

 Otherwise, the value is taken as an offset from the beginning
 of the string table.
 Special characters in ^X or \ec notation are stored in their
 Otherwise, the value is taken as an offset from the beginning
 of the string table.
 Special characters in ^X or \ec notation are stored in their


@@ -131,12 +160,12 @@ As an example, here is a hex dump of the description for the Lear-Siegler
 ADM-3, a popular though rather stupid early terminal:
 .nf
 .sp
 ADM-3, a popular though rather stupid early terminal:
 .nf
 .sp

-adm3a|lsi adm3a, 
-        am, 
-        cols#80, lines#24, 
-        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, 
+adm3a|lsi adm3a,
+        am,
+        cols#80, lines#24,
+        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,

 .sp
 .ft CW
 \s-20000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3
 .sp
 .ft CW
 \s-20000  1a 01 10 00 02 00 03 00  82 00 31 00 61 64 6d 33  ........ ..1.adm3


@@ -169,8 +198,8 @@ Some limitations: total compiled entries cannot exceed 4096 bytes.
 The name field cannot exceed 128 bytes.
 .SH FILES
 \*d/*/*        compiled terminal capability data base
 The name field cannot exceed 128 bytes.
 .SH FILES
 \*d/*/*        compiled terminal capability data base

-.SH "SEE ALSO"
-curses(3X), terminfo(\*n).
+.SH SEE ALSO
+\fBcurses\fR(3X), \fBterminfo\fR(\*n).

 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables:
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: