man/term.7

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2021,2023 Thomas E. Dickey                                *
   3 .\" Copyright 1998-2011,2017 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: term.7,v 1.44 2023/11/25 17:20:42 tom Exp $
  31 .TH term 7 2023-11-25 "ncurses 6.4" Miscellaneous
  32 .ie \n(.g \{\
  33 .ds `` \(lq
  34 .ds '' \(rq
  35 .\}
  36 .el \{\
  37 .ie t .ds `` ``
  38 .el   .ds `` ""
  39 .ie t .ds '' ''
  40 .el   .ds '' ""
  41 .\}
  42 .
  43 .ds d @TERMINFO@
  44 .SH NAME
  45 term \-
  46 conventions for naming terminal types
  47 .\"SH SYNOPSIS
  48 .SH DESCRIPTION
  49 The environment variable \fBTERM\fP should normally contain the type name of
  50 the terminal, console or display-device type you are using.
  51 This information
  52 is critical for all screen-oriented programs, including your editor and mailer.
  53 .PP
  54 A default \fBTERM\fP value will be set on a per-line basis by either
  55 \fB/etc/inittab\fP (e.g., System\-V-like Unices)
  56 or \fB/etc/ttys\fP (BSD Unices).
  57 This will nearly always suffice for workstation and microcomputer consoles.
  58 .PP
  59 If you use a dialup line, the type of device attached to it may vary.
  60 Older Unix systems pre-set a very dumb terminal type
  61 like \*(``dumb\*('' or \*(``dialup\*('' on dialup lines.
  62 Newer ones may pre-set \*(``vt100\*('', reflecting the prevalence of DEC
  63 VT100-compatible terminals and personal-computer emulators.
  64 .PP
  65 Modern telnets pass your \fBTERM\fP environment variable from the local side to
  66 the remote one.
  67 There can be problems if the remote terminfo or termcap entry
  68 for your type is not compatible with yours, but this situation is rare and
  69 can almost always be avoided by explicitly exporting \*(``vt100\*(''
  70 (assuming you are in fact using a VT100-superset console,
  71 terminal, or terminal emulator).
  72 .PP
  73 In any case, you are free to override the system \fBTERM\fP setting to your
  74 taste in your shell profile.
  75 The \fB@TSET@\fP(1) utility may be of assistance;
  76 you can give it a set of rules for deducing or requesting a terminal type based
  77 on the tty device and baud rate.
  78 .PP
  79 Setting your own \fBTERM\fP value may also be useful if you have created a
  80 custom entry incorporating options (such as visual bell or reverse-video)
  81 which you wish to override the system default type for your line.
  82 .PP
  83 Terminal type descriptions are stored as files of capability data underneath
  84 \*d.
  85 To browse a list of all terminal names recognized by the system, do
  86 .sp
  87         @TOE@ | more
  88 .sp
  89 from your shell.
  90 These capability files are in a binary format optimized for
  91 retrieval speed (unlike the old text-based \fBtermcap\fP format they replace);
  92 to examine an entry, you must use the \fB@INFOCMP@\fP(1M) command.
  93 Invoke it as follows:
  94 .sp
  95         @INFOCMP@ \fIentry_name\fP
  96 .sp
  97 where \fIentry_name\fP is the name of the type you wish to examine (and the
  98 name of its capability file the subdirectory of \*d named for its first
  99 letter).
 100 This command dumps a capability file in the text format described by
 101 \fBterminfo\fP(5).
 102 .PP
 103 The first line of a \fBterminfo\fP(5) description gives the names by which
 104 terminfo knows a terminal,
 105 separated by \*(``|\*('' (pipe-bar) characters with the last
 106 name field terminated by a comma.
 107 The first name field is the type's
 108 \fIprimary name\fP, and is the one to use when setting \fBTERM\fP.  The last
 109 name field (if distinct from the first) is actually a description of the
 110 terminal type (it may contain blanks; the others must be single words).
 111 Name
 112 fields between the first and last (if present) are aliases for the terminal,
 113 usually historical names retained for compatibility.
 114 .PP
 115 There are some conventions for how to choose terminal primary names that help
 116 keep them informative and unique.
 117 Here is a step-by-step guide to naming
 118 terminals that also explains how to parse them:
 119 .PP
 120 First, choose a root name.
 121 The root will consist of a lower-case letter
 122 followed by up to seven lower-case letters or digits.
 123 You need to avoid using
 124 punctuation characters in root names, because they are used and interpreted as
 125 filenames and shell meta-characters (such as !, $, *, ?, etc.) embedded in them
 126 may cause odd and unhelpful behavior.
 127 The slash (/), or any other character
 128 that may be interpreted by anyone's file system (\e, $, [, ]), is especially
 129 dangerous (terminfo is platform-independent, and choosing names with special
 130 characters could someday make life difficult for users of a future port).
 131 The
 132 dot (.) character is relatively safe as long as there is at most one per root
 133 name; some historical terminfo names use it.
 134 .PP
 135 The root name for a terminal or workstation console type should almost always
 136 begin with a vendor prefix (such as \fBhp\fP for Hewlett-Packard, \fBwy\fP for
 137 Wyse, or \fBatt\fP for AT&T terminals), or a common name of the terminal line
 138 (\fBvt\fP for the VT series of terminals from DEC, or \fBsun\fP for Sun
 139 Microsystems workstation consoles, or \fBregent\fP for the ADDS Regent series.
 140 You can list the terminfo tree to see what prefixes are already in common use.
 141 The root name prefix should be followed when appropriate by a model number;
 142 thus \fBvt100\fP, \fBhp2621\fP, \fBwy50\fP.
 143 .PP
 144 The root name for a PC-Unix console type should be the OS name,
 145 i.e., \fBlinux\fP, \fBbsdos\fP, \fBfreebsd\fP, \fBnetbsd\fP.  It should
 146 \fInot\fP be \fBconsole\fP or any other generic that might cause confusion in a
 147 multi-platform environment!  If a model number follows, it should indicate
 148 either the OS release level or the console driver release level.
 149 .PP
 150 The root name for a terminal emulator (assuming it does not fit one of the
 151 standard ANSI or vt100 types) should be the program name or a readily
 152 recognizable abbreviation of it (i.e., \fBversaterm\fP, \fBctrm\fP).
 153 .PP
 154 Following the root name, you may add any reasonable number of hyphen-separated
 155 feature suffixes.
 156 .TP 5
 157 2p
 158 Has two pages of memory.
 159 Likewise 4p, 8p, etc.
 160 .TP 5
 161 mc
 162 Magic-cookie.
 163 Some terminals (notably older Wyses) can only support one
 164 attribute without magic-cookie lossage.
 165 Their base entry is usually paired
 166 with another that has this suffix and uses magic cookies to support multiple
 167 attributes.
 168 .TP 5
 169 \-am
 170 Enable auto-margin (right-margin wraparound).
 171 .TP 5
 172 \-m
 173 Mono mode \- suppress color support.
 174 .TP 5
 175 \-na
 176 No arrow keys \- termcap ignores arrow keys which are actually there on the
 177 terminal, so the user can use the arrow keys locally.
 178 .TP 5
 179 \-nam
 180 No auto-margin \- suppress am capability.
 181 .TP 5
 182 \-nl
 183 No labels \- suppress soft labels.
 184 .TP 5
 185 \-nsl
 186 No status line \- suppress status line.
 187 .TP 5
 188 \-pp
 189 Has a printer port which is used.
 190 .TP 5
 191 \-rv
 192 Terminal in reverse video mode (black on white).
 193 .TP 5
 194 \-s
 195 Enable status line.
 196 .TP 5
 197 \-vb
 198 Use visible bell (flash) rather than beep.
 199 .TP 5
 200 \-w
 201 Wide; terminal is in 132-column mode.
 202 .PP
 203 Conventionally, if your terminal type is a variant intended to specify a
 204 line height, that suffix should go first.
 205 So, for a hypothetical FuBarCo
 206 model 2317 terminal in 30-line mode with reverse video, best form would be
 207 \fBfubar\-30\-rv\fP (rather than, say, \*(``fubar\-rv\-30\*('').
 208 .PP
 209 Terminal types that are written not as standalone entries, but rather as
 210 components to be plugged into other entries via \fBuse\fP capabilities,
 211 are distinguished by using embedded plus signs rather than dashes.
 212 .PP
 213 Commands which use a terminal type to control display often accept a \-T
 214 option that accepts a terminal name argument.
 215 Such programs should fall back
 216 on the \fBTERM\fP environment variable when no \-T option is specified.
 217 .SH FILES
 218 .TP 5
 219 .I \*d
 220 compiled terminal description database
 221 .TP 5
 222 /etc/inittab
 223 tty line initialization (AT&T-like Unices)
 224 .TP 5
 225 /etc/ttys
 226 tty line initialization (BSD-like Unices)
 227 .SH PORTABILITY
 228 For maximum compatibility with older System V Unices, names and aliases
 229 should be unique within the first 14 characters.
 230 .SH SEE ALSO
 231 \fB\%curses\fP(3X),
 232 \fB\%term\fP(5),
 233 \fB\%terminfo\fP(5)