man/term.7

   1 .\"***************************************************************************
   2 .\" Copyright 2018-2023,2024 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.49 2024/05/11 20:39:53 tom Exp $
  31 .TH term 7 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" 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 .SH NAME
  44 term \-
  45 conventions for naming terminal types
  46 .\"SH SYNOPSIS
  47 .SH DESCRIPTION
  48 The environment variable \fITERM\fP should normally contain the type
  49 name of the terminal,
  50 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 \fITERM\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 \fITERM\fP environment variable from the local
  66 side to 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 \fITERM\fP setting to
  74 your 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 \fITERM\fP value may also be useful if you have created
  80 a custom entry incorporating options
  81 (such as visual bell or reverse-video)
  82 which you wish to override the system default type for your line.
  83 .PP
  84 Terminal type descriptions are stored as files of capability data underneath
  85 @TERMINFO@.
  86 To browse a list of all terminal names recognized by the system, do
  87 .sp
  88         @TOE@ | more
  89 .sp
  90 from your shell.
  91 These capability files are in a binary format optimized for
  92 retrieval speed (unlike the old text-based \fBtermcap\fP format they replace);
  93 to examine an entry, you must use the \fB@INFOCMP@\fP(1M) command.
  94 Invoke it as follows:
  95 .sp
  96         @INFOCMP@ \fIentry_name\fP
  97 .sp
  98 where \fIentry_name\fP is the name of the type you wish to examine (and the
  99 name of its capability file the subdirectory of @TERMINFO@ named for its first
 100 letter).
 101 This command dumps a capability file in the text format described by
 102 \fBterminfo\fP(5).
 103 .PP
 104 The first line of a \fBterminfo\fP(5) description gives the names by which
 105 terminfo knows a terminal,
 106 separated by \*(``|\*('' (pipe-bar) characters with the last
 107 name field terminated by a comma.
 108 The first name field is the type's
 109 \fIprimary name\fP,
 110 and is the one to use when setting \fITERM\fP.
 111 The last name field
 112 (if distinct from the first)
 113 is actually a description of the
 114 terminal type (it may contain blanks; the others must be single words).
 115 Name
 116 fields between the first and last (if present) are aliases for the terminal,
 117 usually historical names retained for compatibility.
 118 .PP
 119 There are some conventions for how to choose terminal primary names that help
 120 keep them informative and unique.
 121 Here is a step-by-step guide to naming
 122 terminals that also explains how to parse them:
 123 .PP
 124 First, choose a root name.
 125 The root will consist of a lower-case letter
 126 followed by up to seven lower-case letters or digits.
 127 You need to avoid using
 128 punctuation characters in root names, because they are used and interpreted as
 129 filenames and shell meta-characters (such as !, $, *, ?, etc.) embedded in them
 130 may cause odd and unhelpful behavior.
 131 The slash (/), or any other character
 132 that may be interpreted by anyone's file system (\e, $, [, ]), is especially
 133 dangerous (terminfo is platform-independent, and choosing names with special
 134 characters could someday make life difficult for users of a future port).
 135 The
 136 dot (.) character is relatively safe as long as there is at most one per root
 137 name; some historical terminfo names use it.
 138 .PP
 139 The root name for a terminal or workstation console type should almost always
 140 begin with a vendor prefix (such as \fBhp\fP for Hewlett-Packard, \fBwy\fP for
 141 Wyse, or \fBatt\fP for AT&T terminals), or a common name of the terminal line
 142 (\fBvt\fP for the VT series of terminals from DEC, or \fBsun\fP for Sun
 143 Microsystems workstation consoles, or \fBregent\fP for the ADDS Regent series.
 144 You can list the terminfo tree to see what prefixes are already in common use.
 145 The root name prefix should be followed when appropriate by a model number;
 146 thus \fBvt100\fP, \fBhp2621\fP, \fBwy50\fP.
 147 .PP
 148 The root name for a PC-Unix console type should be the OS name,
 149 i.e., \fBlinux\fP, \fBbsdos\fP, \fBfreebsd\fP, \fBnetbsd\fP.  It should
 150 \fInot\fP be \fBconsole\fP or any other generic that might cause confusion in a
 151 multi-platform environment!  If a model number follows, it should indicate
 152 either the OS release level or the console driver release level.
 153 .PP
 154 The root name for a terminal emulator (assuming it does not fit one of the
 155 standard ANSI or vt100 types) should be the program name or a readily
 156 recognizable abbreviation of it (i.e., \fBversaterm\fP, \fBctrm\fP).
 157 .PP
 158 Following the root name, you may add any reasonable number of hyphen-separated
 159 feature suffixes.
 160 .TP 5
 161 2p
 162 Has two pages of memory.
 163 Likewise 4p, 8p, etc.
 164 .TP 5
 165 mc
 166 Magic-cookie.
 167 Some terminals (notably older Wyses) can only support one
 168 attribute without magic-cookie lossage.
 169 Their base entry is usually paired
 170 with another that has this suffix and uses magic cookies to support multiple
 171 attributes.
 172 .TP 5
 173 \-am
 174 Enable auto-margin (right-margin wraparound).
 175 .TP 5
 176 \-m
 177 Mono mode \- suppress color support.
 178 .TP 5
 179 \-na
 180 No arrow keys \- termcap ignores arrow keys which are actually there on the
 181 terminal, so the user can use the arrow keys locally.
 182 .TP 5
 183 \-nam
 184 No auto-margin \- suppress am capability.
 185 .TP 5
 186 \-nl
 187 No labels \- suppress soft labels.
 188 .TP 5
 189 \-nsl
 190 No status line \- suppress status line.
 191 .TP 5
 192 \-pp
 193 Has a printer port which is used.
 194 .TP 5
 195 \-rv
 196 Terminal in reverse video mode (black on white).
 197 .TP 5
 198 \-s
 199 Enable status line.
 200 .TP 5
 201 \-vb
 202 Use visible bell (flash) rather than beep.
 203 .TP 5
 204 \-w
 205 Wide; terminal is in 132-column mode.
 206 .PP
 207 Conventionally, if your terminal type is a variant intended to specify a
 208 line height, that suffix should go first.
 209 So, for a hypothetical FuBarCo
 210 model 2317 terminal in 30-line mode with reverse video, best form would be
 211 \fBfubar\-30\-rv\fP (rather than, say, \*(``fubar\-rv\-30\*('').
 212 .PP
 213 Terminal types that are written not as standalone entries, but rather as
 214 components to be plugged into other entries via \fBuse\fP capabilities,
 215 are distinguished by using embedded plus signs rather than dashes.
 216 .PP
 217 Commands which use a terminal type to control display often accept a \-T
 218 option that accepts a terminal name argument.
 219 Such programs should fall back
 220 on the \fITERM\fP environment variable when no \-T option is specified.
 221 .SH FILES
 222 .TP
 223 .I @TERMINFO@
 224 compiled terminal description database
 225 .TP
 226 .I /etc/inittab
 227 tty line initialization (AT&T-like Unices)
 228 .TP
 229 .I /etc/ttys
 230 tty line initialization (BSD-like Unices)
 231 .SH PORTABILITY
 232 For maximum compatibility with older System V Unices, names and aliases
 233 should be unique within the first 14 characters.
 234 .SH SEE ALSO
 235 \fB\%curses\fP(3X),
 236 \fB\%term\fP(5),
 237 \fB\%terminfo\fP(5)