00a85106c80177342f089fa88a4f0ece7b83a4a8
[ncurses.git] / man / terminfo.head
1 .\" $Id: terminfo.head,v 1.7 1997/12/14 01:49:17 tom Exp $
2 .TH TERMINFO 5 "" "" "File Formats"
3 .ds n 5
4 .ds d @DATADIR@/terminfo
5 .SH NAME
6 terminfo \- terminal capability data base
7 .SH SYNOPSIS
8 \*d/*/*
9 .SH DESCRIPTION
10 .I Terminfo
11 is a data base describing terminals, used by screen-oriented programs such as
12 \fBnvi\fR(1),
13 \fBrogue\fR(1)
14 and libraries such as
15 \fBcurses\fR(3X).
16 .I Terminfo
17 describes terminals by giving a set of capabilities which they
18 have, by specifying how to perform screen operations, and by
19 specifying padding requirements and initialization sequences.
20 .PP
21 Entries in
22 .I terminfo
23 consist of a sequence of `,' separated fields (embedded commas may be
24 escaped with a  backslash or notated as \e072).
25 White space after the `,' separator is ignored.
26 The first entry for each terminal gives the names which are known for the
27 terminal, separated by `|' characters.
28 The first name given is the most common abbreviation for the terminal,
29 the last name given should be a long name fully identifying the terminal,
30 and all others are understood as synonyms for the terminal name.
31 All names but the last should be in lower case and contain no blanks;
32 the last name may well contain upper case and blanks for readability.
33 .PP
34 Terminal names (except for the last, verbose entry) should
35 be chosen using the following conventions.
36 The particular piece of hardware making up the terminal should
37 have a root name, thus ``hp2621''.
38 This name should not contain hyphens.
39 Modes that the hardware can be in, or user preferences, should
40 be indicated by appending a hyphen and a mode suffix.
41 Thus, a vt100 in 132 column mode would be vt100-w.
42 The following suffixes should be used where possible:
43 .PP
44 .TS
45 center ;
46 l c l
47 l l l.
48 \fBSuffix       Meaning Example\fP
49 -\fInn\fP       Number of lines on the screen   aaa-60
50 -\fIn\fPp       Number of pages of memory       c100-4p
51 -am     With automargins (usually the default)  vt100-am
52 -m      Mono mode; suppress color               ansi-m
53 -mc     Magic cookie; spaces when highlighting  wy30-mc
54 -na     No arrow keys (leave them in local)     c100-na
55 -nam    Without automatic margins               vt100-nam
56 -nl     No status line                          att4415-nl
57 -ns     No status line                          hp2626-ns
58 -rv     Reverse video                           c100-rv
59 -s      Enable status line                      vt100-s
60 -vb     Use visible bell instead of beep        wy370-vb
61 -w      Wide mode (> 80 columns, usually 132)   vt100-w
62 .TE
63 .PP
64 For more on terminal naming conventions, see the \fBterm(7)\fR manual page.
65 .SS Capabilities
66 .\" Head of terminfo man page ends here
67 .ps -1