| 1 | .\"*************************************************************************** | 
|---|
| 2 | .\" Copyright (c) 1998-2002,2004 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.12 2004/09/25 19:07:11 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 | .PP | 
|---|
| 49 | Entries in | 
|---|
| 50 | .I terminfo | 
|---|
| 51 | consist of a sequence of `,' separated fields (embedded commas may be | 
|---|
| 52 | escaped with a backslash or notated as \e054). | 
|---|
| 53 | White space after the `,' separator is ignored. | 
|---|
| 54 | The first entry for each terminal gives the names which are known for the | 
|---|
| 55 | terminal, separated by `|' characters. | 
|---|
| 56 | The first name given is the most common abbreviation for the terminal, | 
|---|
| 57 | the last name given should be a long name fully identifying the terminal, | 
|---|
| 58 | and all others are understood as synonyms for the terminal name. | 
|---|
| 59 | All names but the last should be in lower case and contain no blanks; | 
|---|
| 60 | the last name may well contain upper case and blanks for readability. | 
|---|
| 61 | .PP | 
|---|
| 62 | Lines beginning with a `#' in the first column are treated as comments. | 
|---|
| 63 | While comment lines are legal at any point, the output of \fIcaptoinfo\fP | 
|---|
| 64 | and \fIinfotocap\fP (aliases for \fItic\fP) | 
|---|
| 65 | will move comments so they occur only between entries. | 
|---|
| 66 | .PP | 
|---|
| 67 | Newlines and leading tabs may be used for formatting entries for readability. | 
|---|
| 68 | These are removed from parsed entries. | 
|---|
| 69 | The \fIinfocmp\ -f\fP option relies on this to format if-then-else expressions: | 
|---|
| 70 | the result can be read by \fItic\fP. | 
|---|
| 71 | .PP | 
|---|
| 72 | Terminal names (except for the last, verbose entry) should | 
|---|
| 73 | be chosen using the following conventions. | 
|---|
| 74 | The particular piece of hardware making up the terminal should | 
|---|
| 75 | have a root name, thus ``hp2621''. | 
|---|
| 76 | This name should not contain hyphens. | 
|---|
| 77 | Modes that the hardware can be in, or user preferences, should | 
|---|
| 78 | be indicated by appending a hyphen and a mode suffix. | 
|---|
| 79 | Thus, a vt100 in 132 column mode would be vt100-w. | 
|---|
| 80 | The following suffixes should be used where possible: | 
|---|
| 81 | .PP | 
|---|
| 82 | .TS | 
|---|
| 83 | center ; | 
|---|
| 84 | l c l | 
|---|
| 85 | l l l. | 
|---|
| 86 | \fBSuffix       Meaning Example\fP | 
|---|
| 87 | -\fInn\fP       Number of lines on the screen   aaa-60 | 
|---|
| 88 | -\fIn\fPp       Number of pages of memory       c100-4p | 
|---|
| 89 | -am     With automargins (usually the default)  vt100-am | 
|---|
| 90 | -m      Mono mode; suppress color               ansi-m | 
|---|
| 91 | -mc     Magic cookie; spaces when highlighting  wy30-mc | 
|---|
| 92 | -na     No arrow keys (leave them in local)     c100-na | 
|---|
| 93 | -nam    Without automatic margins               vt100-nam | 
|---|
| 94 | -nl     No status line                          att4415-nl | 
|---|
| 95 | -ns     No status line                          hp2626-ns | 
|---|
| 96 | -rv     Reverse video                           c100-rv | 
|---|
| 97 | -s      Enable status line                      vt100-s | 
|---|
| 98 | -vb     Use visible bell instead of beep        wy370-vb | 
|---|
| 99 | -w      Wide mode (> 80 columns, usually 132)   vt100-w | 
|---|
| 100 | .TE | 
|---|
| 101 | .PP | 
|---|
| 102 | For more on terminal naming conventions, see the \fBterm(7)\fR manual page. | 
|---|
| 103 | .SS Capabilities | 
|---|
| 104 | .\" Head of terminfo man page ends here | 
|---|
| 105 | .ps -1 | 
|---|