ncurses 5.9 - patch 20140712

[ncurses.git] / man / terminfo.head

diff --git a/man/terminfo.head b/man/terminfo.head
index 3118c1577fcfb97ead81bb93d4f267340c2886c5..c4cc072baeb05461da82805ab8e1cbfcee7f73db 100644 (file)
--- a/man/terminfo.head
+++ b/man/terminfo.head
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2012,2013 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,10 +26,17 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: terminfo.head,v 1.8 1998/03/11 21:12:53 juergen Exp $
-.TH TERMINFO 5 "" "" "File Formats"
+.\" $Id: terminfo.head,v 1.21 2013/03/09 22:11:36 tom Exp $
+.TH terminfo 5 "" "" "File Formats"

 .ds n 5
 .ds n 5

-.ds d @DATADIR@/terminfo
+.ds d @TERMINFO@
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''
+.de bP
+.IP \(bu 4
+..

 .SH NAME
 terminfo \- terminal capability data base
 .SH SYNOPSIS
 .SH NAME
 terminfo \- terminal capability data base
 .SH SYNOPSIS


@@ -45,11 +52,13 @@ and libraries such as
 describes terminals by giving a set of capabilities which they
 have, by specifying how to perform screen operations, and by
 specifying padding requirements and initialization sequences.
 describes terminals by giving a set of capabilities which they
 have, by specifying how to perform screen operations, and by
 specifying padding requirements and initialization sequences.

+This describes \fBncurses\fR
+version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).

 .PP
 Entries in
 .I terminfo
 consist of a sequence of `,' separated fields (embedded commas may be
 .PP
 Entries in
 .I terminfo
 consist of a sequence of `,' separated fields (embedded commas may be

-escaped with a  backslash or notated as \e072).
+escaped with a backslash or notated as \\054).

 White space after the `,' separator is ignored.
 The first entry for each terminal gives the names which are known for the
 terminal, separated by `|' characters.
 White space after the `,' separator is ignored.
 The first entry for each terminal gives the names which are known for the
 terminal, separated by `|' characters.


@@ -59,14 +68,24 @@ and all others are understood as synonyms for the terminal name.
 All names but the last should be in lower case and contain no blanks;
 the last name may well contain upper case and blanks for readability.
 .PP
 All names but the last should be in lower case and contain no blanks;
 the last name may well contain upper case and blanks for readability.
 .PP

+Lines beginning with a `#' in the first column are treated as comments.
+While comment lines are legal at any point, the output of \fB@CAPTOINFO@\fP
+and \fB@INFOTOCAP@\fP (aliases for \fB@TIC@\fP)
+will move comments so they occur only between entries.
+.PP
+Newlines and leading tabs may be used for formatting entries for readability.
+These are removed from parsed entries.
+The \fB@INFOCMP@\ \-f\fP option relies on this to format if-then-else expressions:
+the result can be read by \fB@TIC@\fP.
+.PP

 Terminal names (except for the last, verbose entry) should
 be chosen using the following conventions.
 The particular piece of hardware making up the terminal should
 Terminal names (except for the last, verbose entry) should
 be chosen using the following conventions.
 The particular piece of hardware making up the terminal should

-have a root name, thus ``hp2621''.
+have a root name, thus \*(``hp2621\*(''.

 This name should not contain hyphens.
 Modes that the hardware can be in, or user preferences, should
 be indicated by appending a hyphen and a mode suffix.
 This name should not contain hyphens.
 Modes that the hardware can be in, or user preferences, should
 be indicated by appending a hyphen and a mode suffix.

-Thus, a vt100 in 132 column mode would be vt100-w.
+Thus, a vt100 in 132 column mode would be vt100\-w.

 The following suffixes should be used where possible:
 .PP
 .TS
 The following suffixes should be used where possible:
 .PP
 .TS


@@ -74,22 +93,22 @@ center ;
 l c l
 l l l.
 \fBSuffix      Meaning Example\fP
 l c l
 l l l.
 \fBSuffix      Meaning Example\fP

--\fInn\fP      Number of lines on the screen   aaa-60
--\fIn\fPp      Number of pages of memory       c100-4p
--am    With automargins (usually the default)  vt100-am
--m     Mono mode; suppress color               ansi-m
--mc    Magic cookie; spaces when highlighting  wy30-mc
--na    No arrow keys (leave them in local)     c100-na
--nam   Without automatic margins               vt100-nam
--nl    No status line                          att4415-nl
--ns    No status line                          hp2626-ns
--rv    Reverse video                           c100-rv
--s     Enable status line                      vt100-s
--vb    Use visible bell instead of beep        wy370-vb
--w     Wide mode (> 80 columns, usually 132)   vt100-w
+\-\fInn\fP     Number of lines on the screen   aaa\-60
+\-\fIn\fPp     Number of pages of memory       c100\-4p
+\-am   With automargins (usually the default)  vt100\-am
+\-m    Mono mode; suppress color               ansi\-m
+\-mc   Magic cookie; spaces when highlighting  wy30\-mc
+\-na   No arrow keys (leave them in local)     c100\-na
+\-nam  Without automatic margins               vt100\-nam
+\-nl   No status line                          att4415\-nl
+\-ns   No status line                          hp2626\-ns
+\-rv   Reverse video                           c100\-rv
+\-s    Enable status line                      vt100\-s
+\-vb   Use visible bell instead of beep        wy370\-vb
+\-w    Wide mode (> 80 columns, usually 132)   vt100\-w

 .TE
 .PP
 For more on terminal naming conventions, see the \fBterm(7)\fR manual page.
 .TE
 .PP
 For more on terminal naming conventions, see the \fBterm(7)\fR manual page.

-.SS Capabilities
+.SS Predefined Capabilities

 .\" Head of terminfo man page ends here
 .ps -1
 .\" Head of terminfo man page ends here
 .ps -1