+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+N\bNA\bAM\bME\bE
+ termcap - terminal capability data base
+
+S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
+ /etc/termcap
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+ _\bT_\be_\br_\bm_\bc_\ba_\bp is a data base describing terminals, used, _\be._\bg., by
+ _\bv_\bi(1) and _\bc_\bu_\br_\bs_\be_\bs(3X). Terminals are described in _\bt_\be_\br_\bm_\bc_\ba_\bp by
+ giving a set of capabilities that they have and by describ-
+ ing how operations are performed. Padding requirements and
+ initialization sequences are included in _\bt_\be_\br_\bm_\bc_\ba_\bp.
+
+ Entries in _\bt_\be_\br_\bm_\bc_\ba_\bp consist of a number of `:'-separated
+ fields. The first entry for each terminal gives the names
+ that are known for the terminal, separated by `|' charac-
+ ters. The first name is always two characters long and is
+ used by older systems which store the terminal type in a
+ 16-bit word in a system-wide data base. The second name
+ given is the most common abbreviation for the terminal, the
+ last name given should be a long name fully identifying the
+ terminal, and all others are understood as synonyms for the
+ terminal name. All names but the first and last should be
+ in lower case and contain no blanks; the last name may well
+ contain upper case and blanks for readability.
+
+ 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 chosen, thus "hp2621". This name should not contain
+ hyphens. Modes that the hardware can be in or user prefer-
+ ences should be indicated by appending a hyphen and an indi-
+ cator of the mode. Therefore, a "vt100" in 132-column mode
+ would be "vt100-w". The following suffixes should be used
+ where possible:
+
+ S\bSu\buf\bff\bfi\bix\bx M\bMe\bea\ban\bni\bin\bng\bg E\bEx\bxa\bam\bmp\bpl\ble\be
+ -w Wide mode (more than 80 columns) vt100-w
+ -am With automatic margins (usually default) vt100-am
+ -nam Without automatic margins vt100-nam
+ -_\bn Number of lines on the screen aaa-60
+ -na No arrow keys (leave them in local) concept100-na
+ -_\bnp Number of pages of memory concept100-4p
+ -rv Reverse video concept100-rv
+
+C\bCA\bAP\bPA\bAB\bBI\bIL\bLI\bIT\bTI\bIE\bES\bS
+ The characters in the _\bN_\bo_\bt_\be_\bs field in the table have the fol-
+ lowing meanings (more than one may apply to a capability):
+
+ N indicates numeric parameter(s)
+ P indicates that padding may be specified
+ * indicates that padding may be based on the number of lines affected
+
+
+
+Printed 7/9/88 1 November 1985 1
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ o indicates capability is obsolete
+
+ "Obsolete" capabilities have no _\bt_\be_\br_\bm_\bi_\bn_\bf_\bo equivalents, since
+ they were considered useless, or are subsumed by other capa-
+ bilities. New software should not rely on them at all.
+
+ N\bNa\bam\bme\be T\bTy\byp\bpe\be N\bNo\bot\bte\bes\bs D\bDe\bes\bsc\bcr\bri\bip\bpt\bti\bio\bon\bn
+ ae str (P) End alternate character set
+ AL str (NP*) Add _\bn new blank lines
+ al str (P*) Add new blank line
+ am bool Terminal has automatic margins
+ as str (P) Start alternate character set
+ bc str (o) Backspace if not ^\b^H\bH
+ bl str (P) Audible signal (bell)
+ bs bool (o) Terminal can backspace with ^\b^H\bH
+ bt str (P) Back tab
+ bw bool l\ble\be (backspace) wraps from column 0 to last column
+ CC str Terminal settable command character in prototype
+ cd str (P*) Clear to end of display
+ ce str (P) Clear to end of line
+ ch str (NP) Set cursor column (horizontal position)
+ cl str (P*) Clear screen and home cursor
+ CM str (NP) Memory-relative cursor addressing
+ cm str (NP) Screen-relative cursor motion
+ co num Number of columns in a line (See BUGS section below)
+ cr str (P) Carriage return
+ cs str (NP) Change scrolling region (VT100)
+ ct str (P) Clear all tab stops
+ cv str (NP) Set cursor row (vertical position)
+ da bool Display may be retained above the screen
+ dB num (o) Milliseconds of b\bbs\bs delay needed (default 0)
+ db bool Display may be retained below the screen
+ DC str (NP*) Delete _\bn characters
+ dC num (o) Milliseconds of c\bcr\br delay needed (default 0)
+ dc str (P*) Delete character
+ dF num (o) Milliseconds of f\bff\bf delay needed (default 0)
+ DL str (NP*) Delete _\bn lines
+ dl str (P*) Delete line
+ dm str Enter delete mode
+ dN num (o) Milliseconds of n\bnl\bl delay needed (default 0)
+ DO str (NP*) Move cursor down _\bn lines
+ do str Down one line
+ ds str Disable status line
+ dT num (o) Milliseconds of horizontal tab delay needed (default 0)
+ dV num (o) Milliseconds of vertical tab delay needed (default 0)
+ ec str (NP) Erase _\bn characters
+ ed str End delete mode
+ ei str End insert mode
+ eo bool Can erase overstrikes with a blank
+ EP bool (o) Even parity
+ es bool Escape can be used on the status line
+ ff str (P*) Hardcopy terminal page eject
+
+
+
+Printed 7/9/88 1 November 1985 2
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ fs str Return from status line
+ gn bool Generic line type (_\be._\bg. dialup, switch)
+ hc bool Hardcopy terminal
+ HD bool (o) Half-duplex
+ hd str Half-line down (forward 1/2 linefeed)
+ ho str (P) Home cursor
+ hs bool Has extra "status line"
+ hu str Half-line up (reverse 1/2 linefeed)
+ hz bool Cannot print ~s (Hazeltine)
+ i1-i3 str Terminal initialization strings (_\bt_\be_\br_\bm_\bi_\bn_\bf_\bo only)
+ IC str (NP*) Insert _\bn blank characters
+ ic str (P*) Insert character
+ if str Name of file containing initialization string
+ im str Enter insert mode
+ in bool Insert mode distinguishes nulls
+ iP str Pathname of program for initialization (_\bt_\be_\br_\bm_\bi_\bn_\bf_\bo only)
+ ip str (P*) Insert pad after character inserted
+ is str Terminal initialization string (_\bt_\be_\br_\bm_\bc_\ba_\bp only)
+ it num Tabs initially every _\bn positions
+ K1 str Sent by keypad upper left
+ K2 str Sent by keypad upper right
+ K3 str Sent by keypad center
+ K4 str Sent by keypad lower left
+ K5 str Sent by keypad lower right
+ k0-k9 str Sent by function keys 0-9
+ kA str Sent by insert-line key
+ ka str Sent by clear-all-tabs key
+ kb str Sent by backspace key
+ kC str Sent by clear-screen or erase key
+ kD str Sent by delete-character key
+ kd str Sent by down-arrow key
+ kE str Sent by clear-to-end-of-line key
+ ke str Out of "keypad transmit" mode
+ kF str Sent by scroll-forward/down key
+ kH str Sent by home-down key
+ kh str Sent by home key
+ kI str Sent by insert-character or enter-insert-mode key
+ kL str Sent by delete-line key
+ kl str Sent by left-arrow key
+ kM str Sent by insert key while in insert mode
+ km bool Has a "meta" key (shift, sets parity bit)
+ kN str Sent by next-page key
+ kn num (o) Number of function (k\bk0\b0-k\bk9\b9) keys (default 0)
+ ko str (o) Termcap entries for other non-function keys
+ kP str Sent by previous-page key
+ kR str Sent by scroll-backward/up key
+ kr str Sent by right-arrow key
+ kS str Sent by clear-to-end-of-screen key
+ ks str Put terminal in "keypad transmit" mode
+ kT str Sent by set-tab key
+ kt str Sent by clear-tab key
+ ku str Sent by up-arrow key
+
+
+
+Printed 7/9/88 1 November 1985 3
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ l0-l9 str Labels on function keys if not "f_\bn"
+ LC bool (o) Lower-case only
+ LE str (NP) Move cursor left _\bn positions
+ le str (P) Move cursor left one position
+ li num Number of lines on screen or page (See BUGS section below)
+ ll str Last line, first column
+ lm num Lines of memory if > l\bli\bi (0 means varies)
+ ma str (o) Arrow key map (used by _\bv_\bi version 2 only)
+ mb str Turn on blinking attribute
+ md str Turn on bold (extra bright) attribute
+ me str Turn off all attributes
+ mh str Turn on half-bright attribute
+ mi bool Safe to move while in insert mode
+ mk str Turn on blank attribute (characters invisible)
+ ml str (o) Memory lock on above cursor
+ mm str Turn on "meta mode" (8th bit)
+ mo str Turn off "meta mode"
+ mp str Turn on protected attribute
+ mr str Turn on reverse-video attibute
+ ms bool Safe to move in standout modes
+ mu str (o) Memory unlock (turn off memory lock)
+ nc bool (o) No correctly-working c\bcr\br (Datamedia 2500, Hazeltine 2000)
+ nd str Non-destructive space (cursor right)
+ NL bool (o) \\b\n\bn is newline, not line feed
+ nl str (o) Newline character if not \\b\n\bn
+ ns bool (o) Terminal is a CRT but doesn't scroll
+ nw str (P) Newline (behaves like c\bcr\br followed by d\bdo\bo)
+ OP bool (o) Odd parity
+ os bool Terminal overstrikes
+ pb num Lowest baud where delays are required
+ pc str Pad character (default NUL)
+ pf str Turn off the printer
+ pk str Program function key _\bn to type string _\bs (_\bt_\be_\br_\bm_\bi_\bn_\bf_\bo only)
+ pl str Program function key _\bn to execute string _\bs (_\bt_\be_\br_\bm_\bi_\bn_\bf_\bo only)
+ pO str (N) Turn on the printer for _\bn bytes
+ po str Turn on the printer
+ ps str Print contents of the screen
+ pt bool (o) Has hardware tabs (may need to be set with i\bis\bs)
+ px str Program function key _\bn to transmit string _\bs (_\bt_\be_\br_\bm_\bi_\bn_\bf_\bo only)
+ r1-r3 str Reset terminal completely to sane modes (_\bt_\be_\br_\bm_\bi_\bn_\bf_\bo only)
+ rc str (P) Restore cursor to position of last s\bsc\bc
+ rf str Name of file containing reset codes
+ RI str (NP) Move cursor right _\bn positions
+ rp str (NP*) Repeat character _\bc _\bn times
+ rs str Reset terminal completely to sane modes (_\bt_\be_\br_\bm_\bc_\ba_\bp only)
+ sa str (NP) Define the video attributes
+ sc str (P) Save cursor position
+ se str End standout mode
+ SF str (NP*) Scroll forward _\bn lines
+ sf str (P) Scroll text up
+ sg num Number of garbage chars left by s\bso\bo or s\bse\be (default 0)
+ so str Begin standout mode
+
+
+
+Printed 7/9/88 1 November 1985 4
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ SR str (NP*) Scroll backward _\bn lines
+ sr str (P) Scroll text down
+ st str Set a tab in all rows, current column
+ ta str (P) Tab to next 8-position hardware tab stop
+ tc str Entry of similar terminal - must be last
+ te str String to end programs that use _\bt_\be_\br_\bm_\bc_\ba_\bp
+ ti str String to begin programs that use _\bt_\be_\br_\bm_\bc_\ba_\bp
+ ts str (N) Go to status line, column _\bn
+ UC bool (o) Upper-case only
+ uc str Underscore one character and move past it
+ ue str End underscore mode
+ ug num Number of garbage chars left by u\bus\bs or u\bue\be (default 0)
+ ul bool Underline character overstrikes
+ UP str (NP*) Move cursor up _\bn lines
+ up str Upline (cursor up)
+ us str Start underscore mode
+ vb str Visible bell (must not move cursor)
+ ve str Make cursor appear normal (undo v\bvs\bs/v\bvi\bi)
+ vi str Make cursor invisible
+ vs str Make cursor very visible
+ vt num Virtual terminal number (not supported on all systems)
+ wi str (N) Set current window
+ ws num Number of columns in status line
+ xb bool Beehive (f1=ESC, f2=^C)
+ xn bool Newline ignored after 80 cols (Concept)
+ xo bool Terminal uses xoff/xon (DC3/DC1) handshaking
+ xr bool (o) Return acts like c\bce\be c\bcr\br n\bnl\bl (Delta Data)
+ xs bool Standout not erased by overwriting (Hewlett-Packard)
+ xt bool Tabs ruin, magic s\bso\bo char (Teleray 1061)
+ xx bool (o) Tektronix 4025 insert-line
+
+ A\bA S\bSa\bam\bmp\bpl\ble\be E\bEn\bnt\btr\bry\by
+
+ The following entry, which describes the Concept-100, is
+ among the more complex entries in the _\bt_\be_\br_\bm_\bc_\ba_\bp file as of
+ this writing.
+
+ ca|concept100|c100|concept|c104|concept100-4p|HDS Concept-100:\
+ :al=3*\E^R:am:bl=^G:cd=16*\E^C:ce=16\E^U:cl=2*^L:cm=\Ea%+ %+ :\
+ :co#80:.cr=9^M:db:dc=16\E^A:dl=3*\E^B:do=^J:ei=\E\200:eo:im=\E^P:in:\
+ :ip=16*:is=\EU\Ef\E7\E5\E8\El\ENH\EK\E\200\Eo&\200\Eo\47\E:k1=\E5:\
+ :k2=\E6:k3=\E7:kb=^h:kd=\E<:ke=\Ex:kh=\E?:kl=\E>:kr=\E=:ks=\EX:\
+ :ku=\E;:le=^H:li#24:mb=\EC:me=\EN\200:mh=\EE:mi:mk=\EH:mp=\EI:\
+ :mr=\ED:nd=\E=:pb#9600:rp=0.2*\Er%.%+ :se=\Ed\Ee:sf=^J:so=\EE\ED:\
+ :.ta=8\t:te=\Ev \200\200\200\200\200\200\Ep\r\n:\
+ :ti=\EU\Ev 8p\Ep\r:ue=\Eg:ul:up=\E;:us=\EG:\
+ :vb=\Ek\200\200\200\200\200\200\200\200\200\200\200\200\200\200\EK:\
+ :ve=\Ew:vs=\EW:vt#8:xn:\
+ :bs:cr=^M:dC#9:dT#8:nl=^J:ta=^I:pt:
+
+ Entries may continue onto multiple lines by giving a \ as
+ the last character of a line, and empty fields may be
+
+
+
+Printed 7/9/88 1 November 1985 5
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ included for readability (here between the last field on a
+ line and the first field on the next). Comments may be
+ included on lines beginning with "#".
+
+ T\bTy\byp\bpe\bes\bs o\bof\bf C\bCa\bap\bpa\bab\bbi\bil\bli\bit\bti\bie\bes\bs
+
+ Capabilities in _\bt_\be_\br_\bm_\bc_\ba_\bp are of three types: Boolean capabil-
+ ities, which indicate particular features that the terminal
+ has; numeric capabilities, giving the size of the display or
+ the size of other attributes; and string capabilities, which
+ give character sequences that can be used to perform partic-
+ ular terminal operations. All capabilities have two-letter
+ codes. For instance, the fact that the Concept has
+ _\ba_\bu_\bt_\bo_\bm_\ba_\bt_\bi_\bc _\bm_\ba_\br_\bg_\bi_\bn_\bs (_\bi._\be., an automatic return and linefeed
+ when the end of a line is reached) is indicated by the
+ Boolean capability a\bam\bm. Hence the description of the Concept
+ includes a\bam\bm.
+
+ Numeric capabilities are followed by the character `#' then
+ the value. In the example above c\bco\bo, which indicates the
+ number of columns the display has, gives the value `80' for
+ the Concept.
+
+ Finally, string-valued capabilities, such as c\bce\be (clear-to-
+ end-of-line sequence) are given by the two-letter code, an
+ `=', then a string ending at the next following `:'. A
+ delay in milliseconds may appear after the `=' in such a
+ capability, which causes padding characters to be supplied
+ by _\bt_\bp_\bu_\bt_\bs after the remainder of the string is sent to pro-
+ vide this delay. The delay can be either a number, _\be._\bg.
+ `20', or a number followed by an `*', _\bi._\be., `3*'. An `*'
+ indicates that the padding required is proportional to the
+ number of lines affected by the operation, and the amount
+ given is the per-affected-line padding required. (In the
+ case of insert-character, the factor is still the number of
+ _\bl_\bi_\bn_\be_\bs affected; this is always 1 unless the terminal has i\bin\bn
+ and the software uses it.) When an `*' is specified, it is
+ sometimes useful to give a delay of the form `3.5' to
+ specify a delay per line to tenths of milliseconds. (Only
+ one decimal place is allowed.)
+
+ A number of escape sequences are provided in the string-
+ valued capabilities for easy encoding of control characters
+ there. \\b\E\bE maps to an ESC character, ^\b^X\bX maps to a control-X
+ for any appropriate X, and the sequences \\b\n\bn \\b\r\br \\b\t\bt \\b\b\bb \\b\f\bf map
+ to linefeed, return, tab, backspace, and formfeed, respec-
+ tively. Finally, characters may be given as three octal
+ digits after a \\b\, and the characters ^\b^ and \\b\ may be given as
+ \\b\^\b^ and \\b\\\b\. If it is necessary to place a :\b: in a capability
+ it must be escaped in octal as \\b\0\b07\b72\b2. If it is necessary to
+ place a NUL character in a string capability it must be
+ encoded as \\b\2\b20\b00\b0. (The routines that deal with _\bt_\be_\br_\bm_\bc_\ba_\bp use C
+
+
+
+Printed 7/9/88 1 November 1985 6
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ strings and strip the high bits of the output very late, so
+ that a \\b\2\b20\b00\b0 comes out as a \\b\0\b00\b00\b0 would.)
+
+ Sometimes individual capabilities must be commented out. To
+ do this, put a period before the capability name. For exam-
+ ple, see the first c\bcr\br and t\bta\ba in the example above.
+
+ P\bPr\bre\bep\bpa\bar\bri\bin\bng\bg D\bDe\bes\bsc\bcr\bri\bip\bpt\bti\bio\bon\bns\bs
+
+ We now outline how to prepare descriptions of terminals.
+ The most effective way to prepare a terminal description is
+ by imitating the description of a similar terminal in
+ _\bt_\be_\br_\bm_\bc_\ba_\bp and to build up a description gradually, using par-
+ tial descriptions with _\bv_\bi to check that they are correct.
+ Be aware that a very unusual terminal may expose deficien-
+ cies in the ability of the _\bt_\be_\br_\bm_\bc_\ba_\bp file to describe it or
+ bugs in _\bv_\bi. To easily test a new terminal description you
+ are working on you can put it in your home directory in a
+ file called ._\bt_\be_\br_\bm_\bc_\ba_\bp and programs will look there before
+ looking in /_\be_\bt_\bc/_\bt_\be_\br_\bm_\bc_\ba_\bp. You can also set the environment
+ variable T\bTE\bER\bRM\bMP\bPA\bAT\bTH\bH to a list of absolute file pathnames
+ (separated by spaces or colons), one of which contains the
+ description you are working on, and programs will search
+ them in the order listed, and nowhere else. See
+ _\bt_\be_\br_\bm_\bc_\ba_\bp(3X). The T\bTE\bER\bRM\bMC\bCA\bAP\bP environment variable is usually
+ set to the _\bt_\be_\br_\bm_\bc_\ba_\bp entry itself to avoid reading files when
+ starting up a program.
+
+ To get the padding for insert-line right (if the terminal
+ manufacturer did not document it), a severe test is to use
+ _\bv_\bi to edit /_\be_\bt_\bc/_\bp_\ba_\bs_\bs_\bw_\bd at 9600 baud, delete roughly 16 lines
+ from the middle of the screen, then hit the `u' key several
+ times quickly. If the display messes up, more padding is
+ usually needed. A similar test can be used for insert-
+ character.
+
+ B\bBa\bas\bsi\bic\bc C\bCa\bap\bpa\bab\bbi\bil\bli\bit\bti\bie\bes\bs
+
+ The number of columns on each line of the display is given
+ by the c\bco\bo numeric capability. If the display is a CRT, then
+ the number of lines on the screen is given by the l\bli\bi capa-
+ bility. If the display wraps around to the beginning of the
+ next line when the cursor reaches the right margin, then it
+ should have the a\bam\bm capability. If the terminal can clear
+ its screen, the code to do this is given by the c\bcl\bl string
+ capability. If the terminal overstrikes (rather than clear-
+ ing the position when a character is overwritten), it should
+ have the o\bos\bs capability. If the terminal is a printing ter-
+ minal, with no soft copy unit, give it both h\bhc\bc and o\bos\bs. (o\bos\bs
+ applies to storage scope terminals, such as the Tektronix
+ 4010 series, as well as to hard copy and APL terminals.) If
+ there is a code to move the cursor to the left edge of the
+
+
+
+Printed 7/9/88 1 November 1985 7
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ current row, give this as c\bcr\br. (Normally this will be
+ carriage-return, ^\b^M\bM.) If there is a code to produce an audi-
+ ble signal (bell, beep, _\be_\bt_\bc.), give this as b\bbl\bl.
+
+ If there is a code (such as backspace) to move the cursor
+ one position to the left, that capability should be given as
+ l\ble\be. Similarly, codes to move to the right, up, and down
+ should be given as n\bnd\bd, u\bup\bp, and d\bdo\bo, respectively. These
+ _\bl_\bo_\bc_\ba_\bl _\bc_\bu_\br_\bs_\bo_\br _\bm_\bo_\bt_\bi_\bo_\bn_\bs should not alter the text they pass
+ over; for example, you would not normally use "nd= " unless
+ the terminal has the o\bos\bs capability, because the space would
+ erase the character moved over.
+
+ A very important point here is that the local cursor motions
+ encoded in _\bt_\be_\br_\bm_\bc_\ba_\bp have undefined behavior at the left and
+ top edges of a CRT display. Programs should never attempt
+ to backspace around the left edge, unless b\bbw\bw is given, and
+ never attempt to go up off the top using local cursor
+ motions.
+
+ In order to scroll text up, a program goes to the bottom
+ left corner of the screen and sends the s\bsf\bf (index) string.
+ To scroll text down, a program goes to the top left corner
+ of the screen and sends the s\bsr\br (reverse index) string. The
+ strings s\bsf\bf and s\bsr\br have undefined behavior when not on their
+ respective corners of the screen. Parameterized versions of
+ the scrolling sequences are S\bSF\bF and S\bSR\bR, which have the same
+ semantics as s\bsf\bf and s\bsr\br except that they take one parameter
+ and scroll that many lines. They also have undefined
+ behavior except at the appropriate corner of the screen.
+
+ The a\bam\bm capability tells whether the cursor sticks at the
+ right edge of the screen when text is output there, but this
+ does not necessarily apply to n\bnd\bd from the last column.
+ Leftward local motion is defined from the left edge only
+ when b\bbw\bw is given; then an l\ble\be from the left edge will move to
+ the right edge of the previous row. This is useful for
+ drawing a box around the edge of the screen, for example.
+ If the terminal has switch-selectable automatic margins, the
+ _\bt_\be_\br_\bm_\bc_\ba_\bp description usually assumes that this feature is on,
+ _\bi._\be., a\bam\bm. If the terminal has a command that moves to the
+ first column of the next line, that command can be given as
+ n\bnw\bw (newline). It is permissible for this to clear the
+ remainder of the current line, so if the terminal has no
+ correctly-working CR and LF it may still be possible to
+ craft a working n\bnw\bw out of one or both of them.
+
+ These capabilities suffice to describe hardcopy and "glass-
+ tty" terminals. Thus the Teletype model 33 is described as
+
+ T3|tty33|33|tty|Teletype model 33:\
+ :bl=^G:co#72:cr=^M:do=^J:hc:os:
+
+
+
+Printed 7/9/88 1 November 1985 8
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ and the Lear Siegler ADM-3 is described as
+
+ l3|adm3|3|LSI ADM-3:\
+ :am:bl=^G:cl=^Z:co#80:cr=^M:do=^J:le=^H:li#24:sf=^J:
+
+ P\bPa\bar\bra\bam\bme\bet\bte\ber\bri\biz\bze\bed\bd S\bSt\btr\bri\bin\bng\bgs\bs
+
+ Cursor addressing and other strings requiring parameters are
+ described by a parameterized string capability, with
+ _\bp_\br_\bi_\bn_\bt_\bf(3S)-like escapes %\b%x\bx in it, while other characters are
+ passed through unchanged. For example, to address the cur-
+ sor the c\bcm\bm capability is given, using two parameters: the
+ row and column to move to. (Rows and columns are numbered
+ from zero and refer to the physical screen visible to the
+ user, not to any unseen memory. If the terminal has
+ memory-relative cursor addressing, that can be indicated by
+ an analogous C\bCM\bM capability.)
+
+ The %\b% encodings have the following meanings:
+
+ %% output `%'
+ %d output value as in _\bp_\br_\bi_\bn_\bt_\bf %d
+ %2 output value as in _\bp_\br_\bi_\bn_\bt_\bf %2d
+ %3 output value as in _\bp_\br_\bi_\bn_\bt_\bf %3d
+ %. output value as in _\bp_\br_\bi_\bn_\bt_\bf %c
+ %+_\bx add _\bx to value, then do %.
+ %>_\bx_\by if value > _\bx then add _\by, no output
+ %r reverse order of two parameters, no output
+ %i increment by one, no output
+ %n exclusive-or all parameters with 0140 (Datamedia 2500)
+ %B BCD (16*(value/10)) + (value%10), no output
+ %D Reverse coding (value - 2*(value%16)), no output (Delta Data)
+
+ Consider the Hewlett-Packard 2645, which, to get to row 3
+ and column 12, needs to be sent "\E&a12c03Y" padded for 6
+ milliseconds. Note that the order of the row and column
+ coordinates is reversed here and that the row and column are
+ sent as two-digit integers. Thus its c\bcm\bm capability is
+ "cm=6\E&%r%2c%2Y".
+
+ The Microterm ACT-IV needs the current row and column sent
+ simply encoded in binary preceded by a ^\b^T\bT, "cm=^T%.%.".
+ Terminals that use "%." need to be able to backspace the
+ cursor (l\ble\be) and to move the cursor up one line on the screen
+ (u\bup\bp). This is necessary because it is not always safe to
+ transmit \\b\n\bn, ^\b^D\bD, and \\b\r\br, as the system may change or discard
+ them. (Programs using _\bt_\be_\br_\bm_\bc_\ba_\bp must set terminal modes so
+ that tabs are not expanded, so \\b\t\bt is safe to send. This
+ turns out to be essential for the Ann Arbor 4080.)
+
+ A final example is the Lear Siegler ADM-3a, which offsets
+ row and column by a blank character, thus "cm=\E=%+ %+ ".
+
+
+
+Printed 7/9/88 1 November 1985 9
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ Row or column absolute cursor addressing can be given as
+ single parameter capabilities c\bch\bh (horizontal position abso-
+ lute) and c\bcv\bv (vertical position absolute). Sometimes these
+ are shorter than the more general two-parameter sequence (as
+ with the Hewlett-Packard 2645) and can be used in preference
+ to c\bcm\bm. If there are parameterized local motions (_\be._\bg., move
+ _\bn positions to the right) these can be given as D\bDO\bO, L\bLE\bE, R\bRI\bI,
+ and U\bUP\bP with a single parameter indicating how many positions
+ to move. These are primarily useful if the terminal does
+ not have c\bcm\bm, such as the Tektronix 4025.
+
+ C\bCu\bur\brs\bso\bor\br M\bMo\bot\bti\bio\bon\bns\bs
+
+ If the terminal has a fast way to home the cursor (to the
+ very upper left corner of the screen), this can be given as
+ h\bho\bo. Similarly, a fast way of getting to the lower left-hand
+ corner can be given as l\bll\bl; this may involve going up with u\bup\bp
+ from the home position, but a program should never do this
+ itself (unless l\bll\bl does), because it can make no assumption
+ about the effect of moving up from the home position. Note
+ that the home position is the same as cursor address (0,0):
+ to the top left corner of the screen, not of memory.
+ (Therefore, the "\EH" sequence on Hewlett-Packard terminals
+ cannot be used for h\bho\bo.)
+
+ A\bAr\bre\bea\ba C\bCl\ble\bea\bar\brs\bs
+
+ If the terminal can clear from the current position to the
+ end of the line, leaving the cursor where it is, this should
+ be given as c\bce\be. If the terminal can clear from the current
+ position to the end of the display, this should be given as
+ c\bcd\bd. c\bcd\bd must only be invoked from the first column of a
+ line. (Therefore, it can be simulated by a request to
+ delete a large number of lines, if a true c\bcd\bd is not avail-
+ able.)
+
+ I\bIn\bns\bse\ber\brt\bt/\b/D\bDe\bel\ble\bet\bte\be L\bLi\bin\bne\be
+
+ If the terminal can open a new blank line before the line
+ containing the cursor, this should be given as a\bal\bl; this must
+ be invoked only from the first position of a line. The cur-
+ sor must then appear at the left of the newly blank line.
+ If the terminal can delete the line that the cursor is on,
+ this should be given as d\bdl\bl; this must only be used from the
+ first position on the line to be deleted. Versions of a\bal\bl
+ and d\bdl\bl which take a single parameter and insert or delete
+ that many lines can be given as A\bAL\bL and D\bDL\bL. If the terminal
+ has a settable scrolling region (like the VT100), the com-
+ mand to set this can be described with the c\bcs\bs capability,
+ which takes two parameters: the top and bottom lines of the
+ scrolling region. The cursor position is, alas, undefined
+ after using this command. It is possible to get the effect
+
+
+
+Printed 7/9/88 1 November 1985 10
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ of insert or delete line using this command - the s\bsc\bc and r\brc\bc
+ (save and restore cursor) commands are also useful. Insert-
+ ing lines at the top or bottom of the screen can also be
+ done using s\bsr\br or s\bsf\bf on many terminals without a true
+ insert/delete line, and is often faster even on terminals
+ with those features.
+
+ If the terminal has the ability to define a window as part
+ of memory which all commands affect, it should be given as
+ the parameterized string w\bwi\bi. The four parameters are the
+ starting and ending lines in memory and the starting and
+ ending columns in memory, in that order. (This _\bt_\be_\br_\bm_\bi_\bn_\bf_\bo
+ capability is described for completeness. It is unlikely
+ that any _\bt_\be_\br_\bm_\bc_\ba_\bp-using program will support it.)
+
+ If the terminal can retain display memory above the screen,
+ then the d\bda\ba capability should be given; if display memory
+ can be retained below, then d\bdb\bb should be given. These indi-
+ cate that deleting a line or scrolling may bring non-blank
+ lines up from below or that scrolling back with s\bsr\br may bring
+ down non-blank lines.
+
+ I\bIn\bns\bse\ber\brt\bt/\b/D\bDe\bel\ble\bet\bte\be C\bCh\bha\bar\bra\bac\bct\bte\ber\br
+
+ There are two basic kinds of intelligent terminals with
+ respect to insert/delete character that can be described
+ using _\bt_\be_\br_\bm_\bc_\ba_\bp. The most common insert/delete character
+ operations affect only the characters on the current line
+ and shift characters off the end of the line rigidly. Other
+ terminals, such as the Concept-100 and the Perkin Elmer Owl,
+ make a distinction between typed and untyped blanks on the
+ screen, shifting upon an insert or delete only to an untyped
+ blank on the screen which is either eliminated or expanded
+ to two untyped blanks. You can determine the kind of termi-
+ nal you have by clearing the screen then typing text
+ separated by cursor motions. Type "abc def" using local
+ cursor motions (not spaces) between the "abc" and the "def".
+ Then position the cursor before the "abc" and put the termi-
+ nal in insert mode. If typing characters causes the rest of
+ the line to shift rigidly and characters to fall off the
+ end, then your terminal does not distinguish between blanks
+ and untyped positions. If the "abc" shifts over to the
+ "def" which then move together around the end of the current
+ line and onto the next as you insert, then you have the
+ second type of terminal and should give the capability i\bin\bn,
+ which stands for "insert null". While these are two logi-
+ cally separate attributes (one line _\bv_\bs. multi-line insert
+ mode, and special treatment of untyped spaces), we have seen
+ no terminals whose insert mode cannot be described with the
+ single attribute.
+
+
+
+
+
+Printed 7/9/88 1 November 1985 11
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ _\bT_\be_\br_\bm_\bc_\ba_\bp can describe both terminals that have an insert mode
+ and terminals that send a simple sequence to open a blank
+ position on the current line. Give as i\bim\bm the sequence to
+ get into insert mode. Give as e\bei\bi the sequence to leave
+ insert mode. Now give as i\bic\bc any sequence that needs to be
+ sent just before each character to be inserted. Most termi-
+ nals with a true insert mode will not give i\bic\bc; terminals
+ that use a sequence to open a screen position should give it
+ here. (If your terminal has both, insert mode is usually
+ preferable to i\bic\bc. Do not give both unless the terminal
+ actually requires both to be used in combination.) If post-
+ insert padding is needed, give this as a number of mil-
+ liseconds in i\bip\bp (a string option). Any other sequence that
+ may need to be sent after insertion of a single character
+ can also be given in i\bip\bp. If your terminal needs to be
+ placed into an `insert mode' and needs a special code
+ preceding each inserted character, then both i\bim\bm/e\bei\bi and i\bic\bc
+ can be given, and both will be used. The I\bIC\bC capability,
+ with one parameter _\bn, will repeat the effects of i\bic\bc _\bn times.
+
+ It is occasionally necessary to move around while in insert
+ mode to delete characters on the same line (_\be._\bg., if there
+ is a tab after the insertion position). If your terminal
+ allows motion while in insert mode, you can give the capa-
+ bility m\bmi\bi to speed up inserting in this case. Omitting m\bmi\bi
+ will affect only speed. Some terminals (notably
+ Datamedia's) must not have m\bmi\bi because of the way their
+ insert mode works.
+
+ Finally, you can specify d\bdc\bc to delete a single character, D\bDC\bC
+ with one parameter _\bn to delete _\bn characters, and delete mode
+ by giving d\bdm\bm and e\bed\bd to enter and exit delete mode (which is
+ any mode the terminal needs to be placed in for d\bdc\bc to work).
+
+ H\bHi\big\bgh\bhl\bli\big\bgh\bht\bti\bin\bng\bg,\b, U\bUn\bnd\bde\ber\brl\bli\bin\bni\bin\bng\bg,\b, a\ban\bnd\bd V\bVi\bis\bsi\bib\bbl\ble\be B\bBe\bel\bll\bls\bs
+
+ If your terminal has one or more kinds of display attri-
+ butes, these can be represented in a number of different
+ ways. You should choose one display form as _\bs_\bt_\ba_\bn_\bd_\bo_\bu_\bt _\bm_\bo_\bd_\be,
+ representing a good high-contrast, easy-on-the-eyes format
+ for highlighting error messages and other attention getters.
+ (If you have a choice, reverse video plus half-bright is
+ good, or reverse video alone.) The sequences to enter and
+ exit standout mode are given as s\bso\bo and s\bse\be, respectively. If
+ the code to change into or out of standout mode leaves one
+ or even two blank spaces or garbage characters on the
+ screen, as the TVI 912 and Teleray 1061 do, then s\bsg\bg should
+ be given to tell how many characters are left.
+
+ Codes to begin underlining and end underlining can be given
+ as u\bus\bs and u\bue\be, respectively. Underline mode change garbage
+ is specified by u\bug\bg, similar to s\bsg\bg. If the terminal has a
+
+
+
+Printed 7/9/88 1 November 1985 12
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ code to underline the current character and move the cursor
+ one position to the right, such as the Microterm Mime, this
+ can be given as u\buc\bc.
+
+ Other capabilities to enter various highlighting modes
+ include m\bmb\bb (blinking), m\bmd\bd (bold or extra bright), m\bmh\bh (dim or
+ half-bright), m\bmk\bk (blanking or invisible text), m\bmp\bp (pro-
+ tected), m\bmr\br (reverse video), m\bme\be (turn off _\ba_\bl_\bl attribute
+ modes), a\bas\bs (enter alternate character set mode), and a\bae\be
+ (exit alternate character set mode). Turning on any of
+ these modes singly may or may not turn off other modes.
+
+ If there is a sequence to set arbitrary combinations of
+ mode, this should be given as s\bsa\ba (set attributes), taking 9
+ parameters. Each parameter is either 0 or 1, as the
+ corresponding attributes is on or off. The 9 parameters
+ are, in order: standout, underline, reverse, blink, dim,
+ bold, blank, protect, and alternate character set. Not all
+ modes need be supported by s\bsa\ba, only those for which
+ corresponding attribute commands exist. (It is unlikely
+ that a _\bt_\be_\br_\bm_\bc_\ba_\bp-using program will support this capability,
+ which is defined for compatibility with _\bt_\be_\br_\bm_\bi_\bn_\bf_\bo.)
+
+ Terminals with the "magic cookie" glitches (s\bsg\bg and u\bug\bg),
+ rather than maintaining extra attribute bits for each char-
+ acter cell, instead deposit special "cookies", or "garbage
+ characters", when they receive mode-setting sequences, which
+ affect the display algorithm.
+
+ Some terminals, such as the Hewlett-Packard 2621, automati-
+ cally leave standout mode when they move to a new line or
+ when the cursor is addressed. Programs using standout mode
+ should exit standout mode on such terminals before moving
+ the cursor or sending a newline. On terminals where this is
+ not a problem, the m\bms\bs capability should be present to say
+ that this overhead is unnecessary.
+
+ If the terminal has a way of flashing the screen to indicate
+ an error quietly (a bell replacement), this can be given as
+ v\bvb\bb; it must not move the cursor.
+
+ If the cursor needs to be made more visible than normal when
+ it is not on the bottom line (to change, for example, a
+ non-blinking underline into an easier-to-find block or
+ blinking underline), give this sequence as v\bvs\bs. If there is
+ a way to make the cursor completely invisible, give that as
+ v\bvi\bi. The capability v\bve\be, which undoes the effects of both of
+ these modes, should also be given.
+
+ If your terminal correctly displays underlined characters
+ (with no special codes needed) even though it does not over-
+ strike, then you should give the capability u\bul\bl. If
+
+
+
+Printed 7/9/88 1 November 1985 13
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ overstrikes are erasable with a blank, this should be indi-
+ cated by giving e\beo\bo.
+
+ K\bKe\bey\byp\bpa\bad\bd
+
+ If the terminal has a keypad that transmits codes when the
+ keys are pressed, this information can be given. Note that
+ it is not possible to handle terminals where the keypad only
+ works in local mode (this applies, for example, to the
+ unshifted Hewlett-Packard 2621 keys). If the keypad can be
+ set to transmit or not transmit, give these codes as k\bks\bs and
+ k\bke\be. Otherwise the keypad is assumed to always transmit.
+ The codes sent by the left-arrow, right-arrow, up-arrow,
+ down-arrow, and home keys can be given as k\bkl\bl, k\bkr\br, k\bku\bu, k\bkd\bd,
+ and k\bkh\bh, respectively. If there are function keys such as
+ f0, f1, ..., f9, the codes they send can be given as k\bk0\b0, k\bk1\b1,
+ k\bk9\b9. If these keys have labels other than the default f0
+ through f9, the labels can be given as l\bl0\b0, l\bl1\b1, l\bl9\b9. The
+ codes transmitted by certain other special keys can be
+ given: k\bkH\bH (home down), k\bkb\bb (backspace), k\bka\ba (clear all tabs),
+ k\bkt\bt (clear the tab stop in this column), k\bkC\bC (clear screen or
+ erase), k\bkD\bD (delete character), k\bkL\bL (delete line), k\bkM\bM (exit
+ insert mode), k\bkE\bE (clear to end of line), k\bkS\bS (clear to end of
+ screen), k\bkI\bI (insert character or enter insert mode), k\bkA\bA
+ (insert line), k\bkN\bN (next page), k\bkP\bP (previous page), k\bkF\bF
+ (scroll forward/down), k\bkR\bR (scroll backward/up), and k\bkT\bT (set
+ a tab stop in this column). In addition, if the keypad has
+ a 3 by 3 array of keys including the four arrow keys, then
+ the other five keys can be given as K\bK1\b1, K\bK2\b2, K\bK3\b3, K\bK4\b4, and K\bK5\b5.
+ These keys are useful when the effects of a 3 by 3 direc-
+ tional pad are needed. The obsolete k\bko\bo capability formerly
+ used to describe "other" function keys has been completely
+ supplanted by the above capabilities.
+
+ The m\bma\ba entry is also used to indicate arrow keys on termi-
+ nals that have single-character arrow keys. It is obsolete
+ but still in use in version 2 of _\bv_\bi which must be run on
+ some minicomputers due to memory limitations. This field is
+ redundant with k\bkl\bl, k\bkr\br, k\bku\bu, k\bkd\bd, and k\bkh\bh. It consists of
+ groups of two characters. In each group, the first charac-
+ ter is what an arrow key sends, and the second character is
+ the corresponding _\bv_\bi command. These commands are h\bh for k\bkl\bl,
+ j\bj for k\bkd\bd, k\bk for k\bku\bu, l\bl for k\bkr\br, and H\bH for k\bkh\bh. For example,
+ the Mime would have "ma=^Hh^Kj^Zk^Xl" indicating arrow keys
+ left (^H), down (^K), up (^Z), and right (^X). (There is no
+ home key on the Mime.)
+
+ T\bTa\bab\bbs\bs a\ban\bnd\bd I\bIn\bni\bit\bti\bia\bal\bli\biz\bza\bat\bti\bio\bon\bn
+
+ If the terminal needs to be in a special mode when running a
+ program that uses these capabilities, the codes to enter and
+ exit this mode can be given as t\bti\bi and t\bte\be. This arises, for
+
+
+
+Printed 7/9/88 1 November 1985 14
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ example, from terminals like the Concept with more than one
+ page of memory. If the terminal has only memory-relative
+ cursor addressing and not screen-relative cursor addressing,
+ a screen-sized window must be fixed into the display for
+ cursor addressing to work properly. This is also used for
+ the Tektronix 4025, where t\bti\bi sets the command character to
+ be the one used by _\bt_\be_\br_\bm_\bc_\ba_\bp.
+
+ Other capabilities include i\bis\bs, an initialization string for
+ the terminal, and i\bif\bf, the name of a file containing long
+ initialization strings. These strings are expected to set
+ the terminal into modes consistent with the rest of the
+ _\bt_\be_\br_\bm_\bc_\ba_\bp description. They are normally sent to the terminal
+ by the _\bt_\bs_\be_\bt program each time the user logs in. They will
+ be printed in the following order: i\bis\bs; setting tabs using c\bct\bt
+ and s\bst\bt; and finally i\bif\bf. (_\bT_\be_\br_\bm_\bi_\bn_\bf_\bo uses i\bi1\b1-\b-i\bi2\b2 instead of i\bis\bs
+ and runs the program i\biP\bP and prints i\bi3\b3 after the other ini-
+ tializations.) A pair of sequences that does a harder reset
+ from a totally unknown state can be analogously given as r\brs\bs
+ and i\bif\bf. These strings are output by the _\br_\be_\bs_\be_\bt program,
+ which is used when the terminal gets into a wedged state.
+ (_\bT_\be_\br_\bm_\bi_\bn_\bf_\bo uses r\br1\b1-\b-r\br3\b3 instead of r\brs\bs.) Commands are normally
+ placed in r\brs\bs and r\brf\bf only if they produce annoying effects on
+ the screen and are not necessary when logging in. For exam-
+ ple, the command to set the VT100 into 80-column mode would
+ normally be part of i\bis\bs, but it causes an annoying glitch of
+ the screen and is not normally needed since the terminal is
+ usually already in 80-column mode.
+
+ If the terminal has hardware tabs, the command to advance to
+ the next tab stop can be given as t\bta\ba (usually ^\b^I\bI). A "back-
+ tab" command which moves leftward to the previous tab stop
+ can be given as b\bbt\bt. By convention, if the terminal driver
+ modes indicate that tab stops are being expanded by the com-
+ puter rather than being sent to the terminal, programs
+ should not use t\bta\ba or b\bbt\bt even if they are present, since the
+ user may not have the tab stops properly set. If the termi-
+ nal has hardware tabs that are initially set every _\bn posi-
+ tions when the terminal is powered up, then the numeric
+ parameter i\bit\bt is given, showing the number of positions
+ between tab stops. This is normally used by the _\bt_\bs_\be_\bt com-
+ mand to determine whether to set the driver mode for
+ hardware tab expansion, and whether to set the tab stops.
+ If the terminal has tab stops that can be saved in nonvola-
+ tile memory, the _\bt_\be_\br_\bm_\bc_\ba_\bp description can assume that they
+ are properly set.
+
+ If there are commands to set and clear tab stops, they can
+ be given as c\bct\bt (clear all tab stops) and s\bst\bt (set a tab stop
+ in the current column of every row). If a more complex
+ sequence is needed to set the tabs than can be described by
+ this, the sequence can be placed in i\bis\bs or i\bif\bf.
+
+
+
+Printed 7/9/88 1 November 1985 15
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ D\bDe\bel\bla\bay\bys\bs
+
+ Certain capabilities control padding in the terminal driver.
+ These are primarily needed by hardcopy terminals and are
+ used by the _\bt_\bs_\be_\bt program to set terminal driver modes
+ appropriately. Delays embedded in the capabilities c\bcr\br, s\bsf\bf,
+ l\ble\be, f\bff\bf, and t\bta\ba will cause the appropriate delay bits to be
+ set in the terminal driver. If p\bpb\bb (padding baud rate) is
+ given, these values can be ignored at baud rates below the
+ value of p\bpb\bb. For 4.2BSD _\bt_\bs_\be_\bt, the delays are given as
+ numeric capabilities d\bdC\bC, d\bdN\bN, d\bdB\bB, d\bdF\bF, and d\bdT\bT instead.
+
+ M\bMi\bis\bsc\bce\bel\bll\bla\ban\bne\beo\bou\bus\bs
+
+ If the terminal requires other than a NUL (zero) character
+ as a pad, this can be given as p\bpc\bc. Only the first character
+ of the p\bpc\bc string is used.
+
+ If the terminal has commands to save and restore the posi-
+ tion of the cursor, give them as s\bsc\bc and r\brc\bc.
+
+ If the terminal has an extra "status line" that is not nor-
+ mally used by software, this fact can be indicated. If the
+ status line is viewed as an extra line below the bottom
+ line, then the capability h\bhs\bs should be given. Special
+ strings to go to a position in the status line and to return
+ from the status line can be given as t\bts\bs and f\bfs\bs. (f\bfs\bs must
+ leave the cursor position in the same place that it was
+ before t\bts\bs. If necessary, the s\bsc\bc and r\brc\bc strings can be
+ included in t\bts\bs and f\bfs\bs to get this effect.) The capability t\bts\bs
+ takes one parameter, which is the column number of the
+ status line to which the cursor is to be moved. If escape
+ sequences and other special commands such as tab work while
+ in the status line, the flag e\bes\bs can be given. A string that
+ turns off the status line (or otherwise erases its contents)
+ should be given as d\bds\bs. The status line is normally assumed
+ to be the same width as the rest of the screen, _\bi._\be., c\bco\bo.
+ If the status line is a different width (possibly because
+ the terminal does not allow an entire line to be loaded),
+ then its width in columns can be indicated with the numeric
+ parameter w\bws\bs.
+
+ If the terminal can move up or down half a line, this can be
+ indicated with h\bhu\bu (half-line up) and h\bhd\bd (half-line down).
+ This is primarily useful for superscripts and subscripts on
+ hardcopy terminals. If a hardcopy terminal can eject to the
+ next page (form feed), give this as f\bff\bf (usually ^\b^L\bL).
+
+ If there is a command to repeat a given character a given
+ number of times (to save time transmitting a large number of
+ identical characters), this can be indicated with the
+ parameterized string r\brp\bp. The first parameter is the
+
+
+
+Printed 7/9/88 1 November 1985 16
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ character to be repeated and the second is the number of
+ times to repeat it. (This is a _\bt_\be_\br_\bm_\bi_\bn_\bf_\bo feature that is
+ unlikely to be supported by a program that uses _\bt_\be_\br_\bm_\bc_\ba_\bp.)
+
+ If the terminal has a settable command character, such as
+ the Tektronix 4025, this can be indicated with C\bCC\bC. A proto-
+ type command character is chosen which is used in all capa-
+ bilities. This character is given in the C\bCC\bC capability to
+ identify it. The following convention is supported on some
+ UNIX systems: The environment is to be searched for a C\bCC\bC
+ variable, and if found, all occurrences of the prototype
+ character are replaced by the character in the environment
+ variable. This use of the C\bCC\bC environment variable is a very
+ bad idea, as it conflicts with _\bm_\ba_\bk_\be(1).
+
+ Terminal descriptions that do not represent a specific kind
+ of known terminal, such as _\bs_\bw_\bi_\bt_\bc_\bh, _\bd_\bi_\ba_\bl_\bu_\bp, _\bp_\ba_\bt_\bc_\bh, and _\bn_\be_\bt_\b-
+ _\bw_\bo_\br_\bk, should include the g\bgn\bn (generic) capability so that
+ programs can complain that they do not know how to talk to
+ the terminal. (This capability does not apply to _\bv_\bi_\br_\bt_\bu_\ba_\bl
+ terminal descriptions for which the escape sequences are
+ known.)
+
+ If the terminal uses xoff/xon (DC3/DC1) handshaking for flow
+ control, give x\bxo\bo. Padding information should still be
+ included so that routines can make better decisions about
+ costs, but actual pad characters will not be transmitted.
+
+ If the terminal has a "meta key" which acts as a shift key,
+ setting the 8th bit of any character transmitted, then this
+ fact can be indicated with k\bkm\bm. Otherwise, software will
+ assume that the 8th bit is parity and it will usually be
+ cleared. If strings exist to turn this "meta mode" on and
+ off, they can be given as m\bmm\bm and m\bmo\bo.
+
+ If the terminal has more lines of memory than will fit on
+ the screen at once, the number of lines of memory can be
+ indicated with l\blm\bm. An explicit value of 0 indicates that
+ the number of lines is not fixed, but that there is still
+ more memory than fits on the screen.
+
+ If the terminal is one of those supported by the UNIX system
+ virtual terminal protocol, the terminal number can be given
+ as v\bvt\bt.
+
+ Media copy strings which control an auxiliary printer con-
+ nected to the terminal can be given as p\bps\bs: print the con-
+ tents of the screen; p\bpf\bf: turn off the printer; and p\bpo\bo: turn
+ on the printer. When the printer is on, all text sent to
+ the terminal will be sent to the printer. It is undefined
+ whether the text is also displayed on the terminal screen
+ when the printer is on. A variation p\bpO\bO takes one parameter
+
+
+
+Printed 7/9/88 1 November 1985 17
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ and leaves the printer on for as many characters as the
+ value of the parameter, then turns the printer off. The
+ parameter should not exceed 255. All text, including p\bpf\bf, is
+ transparently passed to the printer while p\bpO\bO is in effect.
+
+ Strings to program function keys can be given as p\bpk\bk, p\bpl\bl, and
+ p\bpx\bx. Each of these strings takes two parameters: the func-
+ tion key number to program (from 0 to 9) and the string to
+ program it with. Function key numbers out of this range may
+ program undefined keys in a terminal-dependent manner. The
+ differences among the capabilities are that p\bpk\bk causes press-
+ ing the given key to be the same as the user typing the
+ given string; p\bpl\bl causes the string to be executed by the
+ terminal in local mode; and p\bpx\bx causes the string to be
+ transmitted to the computer. Unfortunately, due to lack of
+ a definition for string parameters in _\bt_\be_\br_\bm_\bc_\ba_\bp, only _\bt_\be_\br_\bm_\bi_\bn_\bf_\bo
+ supports these capabilities.
+
+ G\bGl\bli\bit\btc\bch\bhe\bes\bs a\ban\bnd\bd B\bBr\bra\bai\bin\bnd\bda\bam\bma\bag\bge\be
+
+ Hazeltine terminals, which do not allow `~' characters to be
+ displayed, should indicate h\bhz\bz.
+
+ The n\bnc\bc capability, now obsolete, formerly indicated
+ Datamedia terminals, which echo \\b\r\br \\b\n\bn for carriage return
+ then ignore a following linefeed.
+
+ Terminals that ignore a linefeed immediately after an a\bam\bm
+ wrap, such as the Concept, should indicate x\bxn\bn.
+
+ If c\bce\be is required to get rid of standout (instead of merely
+ writing normal text on top of it), x\bxs\bs should be given.
+
+ Teleray terminals, where tabs turn all characters moved over
+ to blanks, should indicate x\bxt\bt (destructive tabs). This
+ glitch is also taken to mean that it is not possible to
+ position the cursor on top of a "magic cookie", and that to
+ erase standout mode it is necessary to use delete and insert
+ line.
+
+ The Beehive Superbee, which is unable to correctly transmit
+ the ESC or ^C characters, has x\bxb\bb, indicating that the "f1"
+ key is used for ESC and "f2" for ^C. (Only certain Super-
+ bees have this problem, depending on the ROM.)
+
+ Other specific terminal problems may be corrected by adding
+ more capabilities of the form x\bx_\bx.\b.
+
+ S\bSi\bim\bmi\bil\bla\bar\br T\bTe\ber\brm\bmi\bin\bna\bal\bls\bs
+
+ If there are two very similar terminals, one can be defined
+ as being just like the other with certain exceptions. The
+
+
+
+Printed 7/9/88 1 November 1985 18
+
+
+
+
+
+
+TERMCAP(5) UNIX Programmer's Manual TERMCAP(5)
+
+
+
+ string capability t\btc\bc can be given with the name of the simi-
+ lar terminal. This capability must be _\bl_\ba_\bs_\bt, and the com-
+ bined length of the entries must not exceed 1024. The capa-
+ bilities given before t\btc\bc override those in the terminal type
+ invoked by t\btc\bc. A capability can be canceled by placing x\bxx\bx@\b@
+ to the left of the t\btc\bc invocation, where _\bx_\bx is the capabil-
+ ity. For example, the entry
+
+ hn|2621-nl:ks@:ke@:tc=2621:
+
+ defines a "2621-nl" that does not have the k\bks\bs or k\bke\be capabil-
+ ities, hence does not turn on the function key labels when
+ in visual mode. This is useful for different modes for a
+ terminal, or for different user preferences.
+
+A\bAU\bUT\bTH\bHO\bOR\bR
+ William Joy
+ Mark Horton added underlining and keypad support
+
+F\bFI\bIL\bLE\bES\bS
+ /etc/termcap file containing terminal descriptions
+
+S\bSE\bEE\bE A\bAL\bLS\bSO\bO
+ ex(1), more(1), tset(1), ul(1), vi(1), curses(3X),
+ printf(3S), termcap(3X), term(7)
+
+C\bCA\bAV\bVE\bEA\bAT\bTS\bS A\bAN\bND\bD B\bBU\bUG\bGS\bS
+ N\bNo\bot\bte\be:\b: _\bt_\be_\br_\bm_\bc_\ba_\bp was replaced by _\bt_\be_\br_\bm_\bi_\bn_\bf_\bo in UNIX System V
+ Release 2.0. The transition will be relatively painless if
+ capabilities flagged as "obsolete" are avoided.
+
+ Lines and columns are now stored by the kernel as well as in
+ the termcap entry. Most programs now use the kernel infor-
+ mation primarily; the information in this file is used only
+ if the kernel does not have any information.
+
+ _\bV_\bi allows only 256 characters for string capabilities, and
+ the routines in _\bt_\be_\br_\bm_\bl_\bi_\bb(3) do not check for overflow of this
+ buffer. The total length of a single entry (excluding only
+ escaped newlines) may not exceed 1024.
+
+ Not all programs support all entries.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Printed 7/9/88 1 November 1985 19
+
+
+
projects / unix-history / commitdiff