ncurses 5.7 - patch 20110108
[ncurses.git] / man / terminfo.head
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2009,2010 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: terminfo.head,v 1.18 2010/07/31 16:08:48 tom Exp $
30 .TH terminfo 5 "" "" "File Formats"
31 .ds n 5
32 .ds d @TERMINFO@
33 .SH NAME
34 terminfo \- terminal capability data base
35 .SH SYNOPSIS
36 \*d/*/*
37 .SH DESCRIPTION
38 .I Terminfo
39 is a data base describing terminals, used by screen-oriented programs such as
40 \fBnvi\fR(1),
41 \fBrogue\fR(1)
42 and libraries such as
43 \fBcurses\fR(3X).
44 .I Terminfo
45 describes terminals by giving a set of capabilities which they
46 have, by specifying how to perform screen operations, and by
47 specifying padding requirements and initialization sequences.
48 This describes \fBncurses\fR
49 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
50 .PP
51 Entries in
52 .I terminfo
53 consist of a sequence of `,' separated fields (embedded commas may be
54 escaped with a backslash or notated as \\054).
55 White space after the `,' separator is ignored.
56 The first entry for each terminal gives the names which are known for the
57 terminal, separated by `|' characters.
58 The first name given is the most common abbreviation for the terminal,
59 the last name given should be a long name fully identifying the terminal,
60 and all others are understood as synonyms for the terminal name.
61 All names but the last should be in lower case and contain no blanks;
62 the last name may well contain upper case and blanks for readability.
63 .PP
64 Lines beginning with a `#' in the first column are treated as comments.
65 While comment lines are legal at any point, the output of \fB@CAPTOINFO@\fP
66 and \fB@INFOTOCAP@\fP (aliases for \fB@TIC@\fP)
67 will move comments so they occur only between entries.
68 .PP
69 Newlines and leading tabs may be used for formatting entries for readability.
70 These are removed from parsed entries.
71 The \fB@INFOCMP@\ \-f\fP option relies on this to format if-then-else expressions:
72 the result can be read by \fB@TIC@\fP.
73 .PP
74 Terminal names (except for the last, verbose entry) should
75 be chosen using the following conventions.
76 The particular piece of hardware making up the terminal should
77 have a root name, thus ``hp2621''.
78 This name should not contain hyphens.
79 Modes that the hardware can be in, or user preferences, should
80 be indicated by appending a hyphen and a mode suffix.
81 Thus, a vt100 in 132 column mode would be vt100\-w.
82 The following suffixes should be used where possible:
83 .PP
84 .TS
85 center ;
86 l c l
87 l l l.
88 \fBSuffix       Meaning Example\fP
89 \-\fInn\fP      Number of lines on the screen   aaa\-60
90 \-\fIn\fPp      Number of pages of memory       c100\-4p
91 \-am    With automargins (usually the default)  vt100\-am
92 \-m     Mono mode; suppress color               ansi\-m
93 \-mc    Magic cookie; spaces when highlighting  wy30\-mc
94 \-na    No arrow keys (leave them in local)     c100\-na
95 \-nam   Without automatic margins               vt100\-nam
96 \-nl    No status line                          att4415\-nl
97 \-ns    No status line                          hp2626\-ns
98 \-rv    Reverse video                           c100\-rv
99 \-s     Enable status line                      vt100\-s
100 \-vb    Use visible bell instead of beep        wy370\-vb
101 \-w     Wide mode (> 80 columns, usually 132)   vt100\-w
102 .TE
103 .PP
104 For more on terminal naming conventions, see the \fBterm(7)\fR manual page.
105 .SS Capabilities
106 .\" Head of terminfo man page ends here
107 .ps -1