<!--
* t
* DO NOT EDIT THIS FILE BY HAND!
- * It is generated from terminfo.head, Caps, and terminfo.tail.
+ * It is generated from terminfo.head, ./../include/Caps ./../include/Caps-ncurses, and terminfo.tail.
* Note: this must be run through tbl before nroff.
* The magic cookie on the first line triggers this under some man programs.
****************************************************************************
- * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2018,2019 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: terminfo.head,v 1.32 2017/04/22 13:52:49 tom Exp @
+ * @Id: terminfo.head,v 1.38 2019/07/27 11:51:04 tom Exp @
* Head of terminfo man page ends here
- * @Id: terminfo.tail,v 1.88 2017/08/12 22:26:02 tom Exp @
- * Beginning of terminfo.tail file
- * This file is part of ncurses.
- * See "terminfo.head" for copyright.
+ ****************************************************************************
+ * Copyright (c) 1998-2018,2019 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 *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: terminfo.tail,v 1.97 2019/07/20 10:20:57 tom Exp @
*.in -2
*.in +2
*.in -2
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>terminfo 5 File Formats</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
<EM>Terminfo</EM> is a data base describing terminals, used by screen-oriented
- programs such as <STRONG>nvi(1)</STRONG>, <STRONG>rogue(1)</STRONG> and libraries such as <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
+ programs such as <STRONG>nvi(1)</STRONG>, <STRONG>lynx(1)</STRONG>, <STRONG>mutt(1)</STRONG>, and other curses applica-
+ tions, using high-level calls to libraries such as <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. It is
+ also used via low-level calls by non-curses applications which may be
+ screen-oriented (such as <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>) or non-screen (such as <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>).
+
<EM>Terminfo</EM> 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
- <STRONG>ncurses</STRONG> version 6.1 (patch 20180331).
+ padding requirements and initialization sequences.
+
+ This manual describes <STRONG>ncurses</STRONG> version 6.1 (patch 20191026).
</PRE><H3><a name="h3-Terminfo-Entry-Syntax">Terminfo Entry Syntax</a></H3><PRE>
Entries in <EM>terminfo</EM> consist of a sequence of fields:
- <STRONG>o</STRONG> Each field ends with a comma "," (embedded commas may be escaped
+ <STRONG>o</STRONG> Each field ends with a comma "," (embedded commas may be escaped
with a backslash or written as "\054").
<STRONG>o</STRONG> White space between fields is ignored.
<STRONG>o</STRONG> The first field in a <EM>terminfo</EM> entry begins in the first column.
- <STRONG>o</STRONG> Newlines and leading whitespace (spaces or tabs) may be used for
- formatting entries for readability. These are removed from parsed
+ <STRONG>o</STRONG> Newlines and leading whitespace (spaces or tabs) may be used for
+ formatting entries for readability. These are removed from parsed
entries.
- The <STRONG>infocmp</STRONG> <STRONG>-f</STRONG> and <STRONG>-W</STRONG> options rely on this to format if-then-else
- expressions, or to enforce maximum line-width. The resulting for-
+ The <STRONG>infocmp</STRONG> <STRONG>-f</STRONG> and <STRONG>-W</STRONG> options rely on this to format if-then-else
+ expressions, or to enforce maximum line-width. The resulting for-
matted terminal description can be read by <STRONG>tic</STRONG>.
- <STRONG>o</STRONG> The first field for each terminal gives the names which are known
+ <STRONG>o</STRONG> The first field for each terminal gives the names which are known
for the terminal, separated by "|" characters.
The first name given is the most common abbreviation for the termi-
- nal (its primary name), the last name given should be a long name
- fully identifying the terminal (see <STRONG><A HREF="curs_termattrs.3x.html">longname(3x)</A></STRONG>), and all others
+ nal (its primary name), the last name given should be a long name
+ fully identifying the terminal (see <STRONG><A HREF="curs_termattrs.3x.html">longname(3x)</A></STRONG>), and all others
are treated as synonyms (aliases) for the primary terminal name.
- X/Open Curses advises that all names but the last should be in
- lower case and contain no blanks; the last name may well contain
+ X/Open Curses advises that 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.
- This implementation is not so strict; it allows mixed case in the
+ This implementation is not so strict; it allows mixed case in the
primary name and aliases. If the last name has no embedded blanks,
- it allows that to be both an alias and a verbose name (but will
+ it allows that to be both an alias and a verbose name (but will
warn about this ambiguity).
- <STRONG>o</STRONG> Lines beginning with a "#" in the first column are treated as com-
+ <STRONG>o</STRONG> Lines beginning with a "#" in the first column are treated as com-
ments.
While comment lines are legal at any point, the output of <STRONG>captoinfo</STRONG>
- and <STRONG>infotocap</STRONG> (aliases for <STRONG>tic</STRONG>) will move comments so they occur
+ and <STRONG>infotocap</STRONG> (aliases for <STRONG>tic</STRONG>) will move comments so they occur
only between entries.
- Terminal names (except for the last, verbose entry) should be chosen
+ Terminal names (except for the last, verbose entry) should be chosen
using the following conventions. The particular piece of hardware mak-
- ing up the terminal should have a root name, thus "hp2621". This name
+ ing up the terminal should 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 suf-
- fix. Thus, a vt100 in 132 column mode would be vt100-w. The following
+ preferences, should be indicated by appending a hyphen and a mode suf-
+ fix. Thus, a vt100 in 132-column mode would be vt100-w. The following
suffixes should be used where possible:
<STRONG>Suffix</STRONG> <STRONG>Meaning</STRONG> <STRONG>Example</STRONG>
-vb Use visible bell instead of beep wy370-vb
-w Wide mode (> 80 columns, usually 132) vt100-w
- For more on terminal naming conventions, see the <STRONG>term(7)</STRONG> manual page.
+ For more on terminal naming conventions, see the <STRONG><A HREF="term.7.html">term(7)</A></STRONG> manual page.
</PRE><H3><a name="h3-Terminfo-Capabilities-Syntax">Terminfo Capabilities Syntax</a></H3><PRE>
- The terminfo entry consists of several <EM>capabilities</EM>, i.e., features
- that the terminal has, or methods for exercising the terminal's fea-
+ The terminfo entry consists of several <EM>capabilities</EM>, i.e., features
+ that the terminal has, or methods for exercising the terminal's fea-
tures.
After the first field (giving the name(s) of the terminal entry), there
should be one or more <EM>capability</EM> fields. These are boolean, numeric or
string names with corresponding values:
- <STRONG>o</STRONG> Boolean capabilities are true when present, false when absent.
+ <STRONG>o</STRONG> Boolean capabilities are true when present, false when absent.
There is no explicit value for boolean capabilities.
- <STRONG>o</STRONG> Numeric capabilities have a "#" following the name, then an
+ <STRONG>o</STRONG> Numeric capabilities have a "#" following the name, then an
unsigned decimal integer value.
- <STRONG>o</STRONG> String capabilities have a "=" following the name, then an string
+ <STRONG>o</STRONG> String capabilities have a "=" following the name, then an string
of characters making up the capability value.
- String capabilities can be split into multiple lines, just as the
- fields comprising a terminal entry can be split into multiple
- lines. While blanks between fields are ignored, blanks embedded
- within a string value are retained, except for leading blanks on a
+ String capabilities can be split into multiple lines, just as the
+ fields comprising a terminal entry can be split into multiple
+ lines. While blanks between fields are ignored, blanks embedded
+ within a string value are retained, except for leading blanks on a
line.
- Any capability can be <EM>canceled</EM>, i.e., suppressed from the terminal
+ Any capability can be <EM>canceled</EM>, i.e., suppressed from the terminal
entry, by following its name with "@" rather than a capability value.
</PRE><H3><a name="h3-Similar-Terminals">Similar Terminals</a></H3><PRE>
- If there are two very similar terminals, one (the variant) can be
- defined as being just like the other (the base) with certain excep-
+ If there are two very similar terminals, one (the variant) can be
+ defined as being just like the other (the base) with certain excep-
tions. In the definition of the variant, the string capability <STRONG>use</STRONG> can
be given with the name of the base terminal:
- <STRONG>o</STRONG> The capabilities given before <STRONG>use</STRONG> override those in the base type
+ <STRONG>o</STRONG> The capabilities given before <STRONG>use</STRONG> override those in the base type
named by <STRONG>use</STRONG>.
- <STRONG>o</STRONG> If there are multiple <STRONG>use</STRONG> capabilities, they are merged in reverse
- order. That is, the rightmost <STRONG>use</STRONG> reference is processed first,
+ <STRONG>o</STRONG> If there are multiple <STRONG>use</STRONG> capabilities, they are merged in reverse
+ order. That is, the rightmost <STRONG>use</STRONG> reference is processed first,
then the one to its left, and so forth.
- <STRONG>o</STRONG> Capabilities given explicitly in the entry override those brought
+ <STRONG>o</STRONG> Capabilities given explicitly in the entry override those brought
in by <STRONG>use</STRONG> references.
A capability can be canceled by placing <STRONG>xx@</STRONG> to the left of the use ref-
- erence that imports it, where <EM>xx</EM> is the capability. For example, the
+ erence that imports it, where <EM>xx</EM> is the capability. For example, the
entry
2621-nl, smkx@, rmkx@, use=2621,
defines a 2621-nl that does not have the <STRONG>smkx</STRONG> or <STRONG>rmkx</STRONG> capabilities, and
- 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
+ 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.
An entry included via <STRONG>use</STRONG> can contain canceled capabilities, which have
- the same effect as if those cancels were inline in the using terminal
+ the same effect as if those cancels were inline in the using terminal
entry.
</PRE><H3><a name="h3-Predefined-Capabilities">Predefined Capabilities</a></H3><PRE>
- The following is a complete table of the capabilities included in a
- terminfo description block and available to terminfo-using code. In
+ The following is a complete table of the capabilities included in a
+ terminfo description block and available to terminfo-using code. In
each line of the table,
- The <STRONG>variable</STRONG> is the name by which the programmer (at the terminfo
+ The <STRONG>variable</STRONG> is the name by which the programmer (at the terminfo
level) accesses the capability.
- The <STRONG>capname</STRONG> is the short name used in the text of the database, and is
- used by a person updating the database. Whenever possible, capnames
+ The <STRONG>capname</STRONG> is the short name used in the text of the database, and is
+ used by a person updating the database. Whenever possible, capnames
are chosen to be the same as or similar to the ANSI X3.64-1979 standard
- (now superseded by ECMA-48, which uses identical or very similar
- names). Semantics are also intended to match those of the specifica-
+ (now superseded by ECMA-48, which uses identical or very similar
+ names). Semantics are also intended to match those of the specifica-
tion.
- The termcap code is the old <STRONG>termcap</STRONG> capability name (some capabilities
+ The termcap code is the old <STRONG>termcap</STRONG> capability name (some capabilities
are new, and have names which termcap did not originate).
- Capability names have no hard length limit, but an informal limit of 5
+ Capability names have no hard length limit, but an informal limit of 5
characters has been adopted to keep them short and to allow the tabs in
the source file <STRONG>Caps</STRONG> to line up nicely.
- Finally, the description field attempts to convey the semantics of the
+ Finally, the description field attempts to convey the semantics of the
capability. You may find some codes in the description field:
(P) indicates that padding may be specified
- #[1-9] in the description field indicates that the string is passed
+ #[1-9] in the description field indicates that the string is passed
through tparm with parms as given (#<EM>i</EM>).
- (P*) indicates that padding may vary in proportion to the number of
+ (P*) indicates that padding may vary in proportion to the number of
lines affected
(#<EM>i</EM>) indicates the <EM>i</EM>th parameter.
matic margins
back_color_erase bce ut screen erased with
background color
+
+
+
can_change ccc cc terminal can re-
define existing col-
ors
by overwriting (hp)
col_addr_glitch xhpa YA only positive motion
for hpa/mhpa caps
-
cpi_changes_res cpix YF changing character
pitch changes reso-
lution
echo on screen
row_addr_glitch xvpa YD only positive motion
for vpa/mvpa caps
+
semi_auto_right_margin sam YE printing in last
column causes cr
status_line_esc_ok eslok es escape can be used
on the status line
tilde_glitch hz hz cannot print ~'s
(Hazeltine)
-
-
transparent_underline ul ul underline character
overstrikes
xon_xoff xon xo terminal uses
width_status_line wsl ws number of columns in
status line
- The following numeric capabilities are present in the SVr4.0 term
- structure, but are not yet documented in the man page. They came in
+ The following numeric capabilities are present in the SVr4.0 term
+ structure, but are not yet documented in the man page. They came in
with SVr4's printer support.
each bit-image row
bit_image_type bitype Yp type of bit-image
device
+
+
+
buffer_capacity bufsz Ya numbers of bytes
buffered before
printing
dot_horz_spacing spinh Yc spacing of dots hor-
izontally in dots
per inch
-
dot_vert_spacing spinv Yb spacing of pins ver-
tically in pins per
inch
(P)
char_padding rmp rP like ip but when in
insert mode
+
+
clear_all_tabs tbc ct clear all tab stops
(P)
clear_margins mgc MC clear right and left
home cursor (P*)
clr_bol el1 cb Clear to beginning
of line
-
-
clr_eol el ce clear to end of line
(P)
clr_eos ed cd clear to end of
enter_delete_mode smdc dm enter delete mode
enter_dim_mode dim mh turn on half-bright
mode
+
enter_doublewide_mode swidm ZF Enter double-wide
mode
enter_draft_quality sdrfq ZG Enter draft-quality
enter_italics_mode sitm ZH Enter italic mode
enter_leftward_mode slm ZI Start leftward car-
riage motion
-
enter_micro_mode smicm ZJ Start micro-motion
mode
enter_near_letter_quality snlq ZK Enter NLQ mode
not move cursor)
form_feed ff ff hardcopy terminal
page eject (P*)
+
from_status_line fsl fs return from status
line
goto_window wingo WG go to window #1
string
init_2string is2 is initialization
string
-
init_3string is3 i3 initialization
string
init_file if if name of initializa-
key_f15 kf15 F5 F15 function key
key_f16 kf16 F6 F16 function key
key_f17 kf17 F7 F17 function key
+
key_f18 kf18 F8 F18 function key
key_f19 kf19 F9 F19 function key
key_f2 kf2 k2 F2 function key
key_f22 kf22 FC F22 function key
key_f23 kf23 FD F23 function key
key_f24 kf24 FE F24 function key
-
key_f25 kf25 FF F25 function key
key_f26 kf26 FG F26 function key
key_f27 kf27 FH F27 function key
key_mark kmrk %2 mark key
key_message kmsg %3 message key
key_move kmov %4 move key
+
key_next knxt %5 next key
key_npage knp kN next-page key
key_open kopn %6 open key
key_previous kprv %8 previous key
key_print kprt %9 print key
key_redo krdo %0 redo key
-
key_reference kref &1 reference key
key_refresh krfr &2 refresh key
key_replace krpl &3 replace key
key f0 if not f0
lab_f1 lf1 l1 label on function
key f1 if not f1
+
+
lab_f10 lf10 la label on function
key f10 if not f10
lab_f2 lf2 l2 label on function
key f3 if not f3
lab_f4 lf4 l4 label on function
key f4 if not f4
-
-
lab_f5 lf5 l5 label on function
key f5 if not f5
lab_f6 lf6 l6 label on function
to the right (P*)
parm_right_micro mcuf Zh Like parm_right_cur-
sor in micro mode
+
parm_rindex rin SR scroll back #1 lines
(P)
parm_up_cursor cuu UP up #1 lines (P*)
in micro mode
pkey_key pfkey pk program function key
#1 to type string #2
-
-
pkey_local pfloc pl program function key
#1 to execute string
#2
pair to #1
set_foreground setf Sf Set foreground color
#1
+
+
+
+
+
set_left_margin smgl ML set left soft margin
at current col-
umn. See smgl.
set_right_margin smgr MR set right soft mar-
gin at current col-
umn
-
-
set_right_margin_parm smgrp Zn Set right margin at
column #1
set_tab hts st set a tab in every
lation
bit_image_carriage_return bicr Yv Move to beginning
of same row
-
-
bit_image_newline binel Zz Move to next row
of the bit image
bit_image_repeat birep Xy Repeat bit image
set_a_foreground setaf AF Set foreground
color to #1, using
ANSI escape
+
set_color_band setcolor Yz Change to ribbon
color #1
set_lr_margin smglr ML Set both left and
#1, #2. (ML is
not in BSD term-
cap).
-
-
set_page_length slines YZ Set page length to
#1 lines
set_tb_margin smgtb MT Sets both top and
bottom margins to
#1, #2
- The XSI Curses standard added these hardcopy capabilities. They were
- used in some post-4.1 versions of System V curses, e.g., Solaris 2.5
- and IRIX 6.x. Except for <STRONG>YI</STRONG>, the <STRONG>ncurses</STRONG> termcap names for them are
- invented. According to the XSI Curses standard, they have no termcap
- names. If your compiled terminfo entries use these, they may not be
+ The XSI Curses standard added these hardcopy capabilities. They were
+ used in some post-4.1 versions of System V curses, e.g., Solaris 2.5
+ and IRIX 6.x. Except for <STRONG>YI</STRONG>, the <STRONG>ncurses</STRONG> termcap names for them are
+ invented. According to the XSI Curses standard, they have no termcap
+ names. If your compiled terminfo entries use these, they may not be
binary-compatible with System V terminfo entries after SVr4.1; beware!
</PRE><H3><a name="h3-User-Defined-Capabilities">User-Defined Capabilities</a></H3><PRE>
- The preceding section listed the <EM>predefined</EM> capabilities. They deal
- with some special features for terminals no longer (or possibly never)
- produced. Occasionally there are special features of newer terminals
- which are awkward or impossible to represent by reusing the predefined
+ The preceding section listed the <EM>predefined</EM> capabilities. They deal
+ with some special features for terminals no longer (or possibly never)
+ produced. Occasionally there are special features of newer terminals
+ which are awkward or impossible to represent by reusing the predefined
capabilities.
- <STRONG>ncurses</STRONG> addresses this limitation by allowing user-defined capabili-
+ <STRONG>ncurses</STRONG> addresses this limitation by allowing user-defined capabili-
ties. The <STRONG>tic</STRONG> and <STRONG>infocmp</STRONG> programs provide the <STRONG>-x</STRONG> option for this pur-
pose. When <STRONG>-x</STRONG> is set, <STRONG>tic</STRONG> treats unknown capabilities as user-defined.
- That is, if <STRONG>tic</STRONG> encounters a capability name which it does not recog-
- nize, it infers its type (boolean, number or string) from the syntax
- and makes an extended table entry for that capability. The
- <STRONG><A HREF="curs_extend.3x.html">use_extended_names(3x)</A></STRONG> function makes this information conditionally
+ That is, if <STRONG>tic</STRONG> encounters a capability name which it does not recog-
+ nize, it infers its type (boolean, number or string) from the syntax
+ and makes an extended table entry for that capability. The
+ <STRONG><A HREF="curs_extend.3x.html">use_extended_names(3x)</A></STRONG> function makes this information conditionally
available to applications. The ncurses library provides the data leav-
ing most of the behavior to applications:
- <STRONG>o</STRONG> User-defined capability strings whose name begins with "k" are
+ <STRONG>o</STRONG> User-defined capability strings whose name begins with "k" are
treated as function keys.
- <STRONG>o</STRONG> The types (boolean, number, string) determined by <STRONG>tic</STRONG> can be
+ <STRONG>o</STRONG> The types (boolean, number, string) determined by <STRONG>tic</STRONG> can be
inferred by successful calls on <STRONG>tigetflag</STRONG>, etc.
<STRONG>o</STRONG> If the capability name happens to be two characters, the capability
While termcap is said to be extensible because it does not use a prede-
fined set of capabilities, in practice it has been limited to the capa-
- bilities defined by terminfo implementations. As a rule, user-defined
+ bilities defined by terminfo implementations. As a rule, user-defined
capabilities intended for use by termcap applications should be limited
- to booleans and numbers to avoid running past the 1023 byte limit
+ to booleans and numbers to avoid running past the 1023 byte limit
assumed by termcap implementations and their applications. In particu-
- lar, providing extended sets of function keys (past the 60 numbered
- keys and the handful of special named keys) is best done using the
+ lar, providing extended sets of function keys (past the 60 numbered
+ keys and the handful of special named keys) is best done using the
longer names available using terminfo.
</PRE><H3><a name="h3-A-Sample-Entry">A Sample Entry</a></H3><PRE>
The following entry, describing an ANSI-standard terminal, is represen-
- tative of what a <STRONG>terminfo</STRONG> entry for a modern terminal typically looks
+ tative of what a <STRONG>terminfo</STRONG> entry for a modern terminal typically looks
like.
ansi|ansi/pc-term compatible with color,
smul=\E[4m, tbc=\E[3g, u6=\E[%i%d;%dR, u7=\E[6n,
u8=\E[?%[;0123456789]c, u9=\E[c, vpa=\E[%i%p1%dd,
- Entries may continue onto multiple lines by placing white space at the
- beginning of each line except the first. Comments may be included on
+ Entries may continue onto multiple lines by placing white space at the
+ beginning of each line except the first. Comments may be included on
lines beginning with "#". Capabilities in <EM>terminfo</EM> are of three types:
<STRONG>o</STRONG> Boolean capabilities which indicate that the terminal has some par-
<STRONG>o</STRONG> numeric capabilities giving the size of the terminal or the size of
particular delays, and
- <STRONG>o</STRONG> string capabilities, which give a sequence which can be used to
+ <STRONG>o</STRONG> string capabilities, which give a sequence which can be used to
perform particular terminal operations.
</PRE><H3><a name="h3-Types-of-Capabilities">Types of Capabilities</a></H3><PRE>
All capabilities have names. For instance, the fact that ANSI-standard
- terminals have <EM>automatic</EM> <EM>margins</EM> (i.e., an automatic return and line-
- feed when the end of a line is reached) is indicated by the capability
- <STRONG>am</STRONG>. Hence the description of ansi includes <STRONG>am</STRONG>. Numeric capabilities
- are followed by the character "#" and then a positive value. Thus
+ terminals have <EM>automatic</EM> <EM>margins</EM> (i.e., an automatic return and line-
+ feed when the end of a line is reached) is indicated by the capability
+ <STRONG>am</STRONG>. Hence the description of ansi includes <STRONG>am</STRONG>. Numeric capabilities
+ are followed by the character "#" and then a positive value. Thus
<STRONG>cols</STRONG>, which indicates the number of columns the terminal has, gives the
- value "80" for ansi. Values for numeric capabilities may be specified
+ value "80" for ansi. Values for numeric capabilities may be specified
in decimal, octal or hexadecimal, using the C programming language con-
ventions (e.g., 255, 0377 and 0xff or 0xFF).
- Finally, string valued capabilities, such as <STRONG>el</STRONG> (clear to end of line
- sequence) are given by the two-character code, an "=", and then a
+ Finally, string valued capabilities, such as <STRONG>el</STRONG> (clear to end of line
+ sequence) are given by the two-character code, an "=", and then a
string ending at the next following ",".
A number of escape sequences are provided in the string valued capabil-
respectively.
X/Open Curses does not say what "appropriate <EM>x</EM>" might be. In practice,
- that is a printable ASCII graphic character. The special case "^?" is
- interpreted as DEL (127). In all other cases, the character value is
- AND'd with 0x1f, mapping to ASCII control codes in the range 0 through
+ that is a printable ASCII graphic character. The special case "^?" is
+ interpreted as DEL (127). In all other cases, the character value is
+ AND'd with 0x1f, mapping to ASCII control codes in the range 0 through
31.
Other escapes include
<STRONG>o</STRONG> and <STRONG>\0</STRONG> for null.
<STRONG>\0</STRONG> will produce \200, which does not terminate a string but behaves
- as a null character on most terminals, providing CS7 is specified.
+ as a null character on most terminals, providing CS7 is specified.
See <STRONG>stty(1)</STRONG>.
- The reason for this quirk is to maintain binary compatibility of
- the compiled terminfo files with other implementations, e.g., the
- SVr4 systems, which document this. Compiled terminfo files use
- null-terminated strings, with no lengths. Modifying this would
+ The reason for this quirk is to maintain binary compatibility of
+ the compiled terminfo files with other implementations, e.g., the
+ SVr4 systems, which document this. Compiled terminfo files use
+ null-terminated strings, with no lengths. Modifying this would
require a new binary format, which would not work with other imple-
mentations.
Finally, characters may be given as three octal digits after a <STRONG>\</STRONG>.
- A delay in milliseconds may appear anywhere in a string capability,
- enclosed in $<..> brackets, as in <STRONG>el</STRONG>=\EK$<5>, and padding characters
+ A delay in milliseconds may appear anywhere in a string capability,
+ enclosed in $<..> brackets, as in <STRONG>el</STRONG>=\EK$<5>, and padding characters
are supplied by <STRONG><A HREF="curs_terminfo.3x.html">tputs(3x)</A></STRONG> to provide this delay.
<STRONG>o</STRONG> The delay must be a number with at most one decimal place of preci-
sion; it may be followed by suffixes "*" or "/" or both.
- <STRONG>o</STRONG> A "*" indicates that the padding required is proportional to the
- number of lines affected by the operation, and the amount given is
- the per-affected-unit padding required. (In the case of insert
+ <STRONG>o</STRONG> A "*" indicates that the padding required is proportional to the
+ number of lines affected by the operation, and the amount given is
+ the per-affected-unit padding required. (In the case of insert
character, the factor is still the number of <EM>lines</EM> affected.)
Normally, padding is advisory if the device has the <STRONG>xon</STRONG> capability;
it is used for cost computation but does not trigger delays.
- <STRONG>o</STRONG> A "/" suffix indicates that the padding is mandatory and forces a
+ <STRONG>o</STRONG> A "/" suffix indicates that the padding is mandatory and forces a
delay of the given number of milliseconds even on devices for which
<STRONG>xon</STRONG> is present to indicate flow control.
- Sometimes individual capabilities must be commented out. To do this,
- put a period before the capability name. For example, see the second
+ Sometimes individual capabilities must be commented out. To do this,
+ put a period before the capability name. For example, see the second
<STRONG>ind</STRONG> in the example above.
</PRE><H3><a name="h3-Fetching-Compiled-Descriptions">Fetching Compiled Descriptions</a></H3><PRE>
- The <STRONG>ncurses</STRONG> library searches for terminal descriptions in several
- places. It uses only the first description found. The library has a
- compiled-in list of places to search which can be overridden by envi-
- ronment variables. Before starting to search, <STRONG>ncurses</STRONG> eliminates
+ The <STRONG>ncurses</STRONG> library searches for terminal descriptions in several
+ places. It uses only the first description found. The library has a
+ compiled-in list of places to search which can be overridden by envi-
+ ronment variables. Before starting to search, <STRONG>ncurses</STRONG> eliminates
duplicates in its search list.
- <STRONG>o</STRONG> If the environment variable TERMINFO is set, it is interpreted as
+ <STRONG>o</STRONG> If the environment variable TERMINFO is set, it is interpreted as
the pathname of a directory containing the compiled description you
are working on. Only that directory is searched.
- <STRONG>o</STRONG> If TERMINFO is not set, <STRONG>ncurses</STRONG> will instead look in the directory
+ <STRONG>o</STRONG> If TERMINFO is not set, <STRONG>ncurses</STRONG> will instead look in the directory
<STRONG>$HOME/.terminfo</STRONG> for a compiled description.
- <STRONG>o</STRONG> Next, if the environment variable TERMINFO_DIRS is set, <STRONG>ncurses</STRONG>
- will interpret the contents of that variable as a list of colon-
+ <STRONG>o</STRONG> Next, if the environment variable TERMINFO_DIRS is set, <STRONG>ncurses</STRONG>
+ will interpret the contents of that variable as a list of colon-
separated directories (or database files) to be searched.
- An empty directory name (i.e., if the variable begins or ends with
- a colon, or contains adjacent colons) is interpreted as the system
+ An empty directory name (i.e., if the variable begins or ends with
+ a colon, or contains adjacent colons) is interpreted as the system
location <EM>/usr/share/terminfo</EM>.
<STRONG>o</STRONG> Finally, <STRONG>ncurses</STRONG> searches these compiled-in locations:
- <STRONG>o</STRONG> a list of directories (/usr/local/ncurses/share/ter-
+ <STRONG>o</STRONG> a list of directories (/usr/local/ncurses/share/ter-
minfo:/usr/share/terminfo), and
- <STRONG>o</STRONG> the system terminfo directory, <EM>/usr/share/terminfo</EM> (the com-
+ <STRONG>o</STRONG> the system terminfo directory, <EM>/usr/share/terminfo</EM> (the com-
piled-in default).
</PRE><H3><a name="h3-Preparing-Descriptions">Preparing Descriptions</a></H3><PRE>
- 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 <EM>terminfo</EM> and to build up a
+ 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 <EM>terminfo</EM> and to build up a
description gradually, using partial descriptions with <EM>vi</EM> or some other
- screen-oriented program to check that they are correct. Be aware that
- a very unusual terminal may expose deficiencies in the ability of the
+ screen-oriented program to check that they are correct. Be aware that
+ a very unusual terminal may expose deficiencies in the ability of the
<EM>terminfo</EM> file to describe it or bugs in the screen-handling code of the
test program.
- To get the padding for insert line right (if the terminal manufacturer
- did not document it) a severe test is to edit a large file at 9600
+ To get the padding for insert line right (if the terminal manufacturer
+ did not document it) a severe test is to edit a large file at 9600
baud, delete 16 or so lines from the middle of the screen, then hit the
"u" key several times quickly. If the terminal messes up, more padding
is usually needed. A similar test can be used for insert character.
</PRE><H3><a name="h3-Basic-Capabilities">Basic Capabilities</a></H3><PRE>
- The number of columns on each line for the terminal is given by the
- <STRONG>cols</STRONG> numeric capability. If the terminal is a CRT, then the number of
- lines on the screen is given by the <STRONG>lines</STRONG> capability. If the terminal
- wraps around to the beginning of the next line when it reaches the
- right margin, then it should have the <STRONG>am</STRONG> capability. If the terminal
- can clear its screen, leaving the cursor in the home position, then
- this is given by the <STRONG>clear</STRONG> string capability. If the terminal over-
- strikes (rather than clearing a position when a character is struck
- over) then it should have the <STRONG>os</STRONG> capability. If the terminal is a
+ The number of columns on each line for the terminal is given by the
+ <STRONG>cols</STRONG> numeric capability. If the terminal is a CRT, then the number of
+ lines on the screen is given by the <STRONG>lines</STRONG> capability. If the terminal
+ wraps around to the beginning of the next line when it reaches the
+ right margin, then it should have the <STRONG>am</STRONG> capability. If the terminal
+ can clear its screen, leaving the cursor in the home position, then
+ this is given by the <STRONG>clear</STRONG> string capability. If the terminal over-
+ strikes (rather than clearing a position when a character is struck
+ over) then it should have the <STRONG>os</STRONG> capability. If the terminal is a
printing terminal, with no soft copy unit, give it both <STRONG>hc</STRONG> and <STRONG>os</STRONG>. (<STRONG>os</STRONG>
- applies to storage scope terminals, such as TEKTRONIX 4010 series, as
- well as hard copy and APL terminals.) If there is a code to move the
+ applies to storage scope terminals, such as TEKTRONIX 4010 series, as
+ well as hard copy and APL terminals.) If there is a code to move the
cursor to the left edge of the current row, give this as <STRONG>cr</STRONG>. (Normally
- this will be carriage return, control M.) If there is a code to pro-
+ this will be carriage return, control/M.) If there is a code to pro-
duce an audible signal (bell, beep, etc) give this as <STRONG>bel</STRONG>.
If there is a code to move the cursor one position to the left (such as
- backspace) that capability should be given as <STRONG>cub1</STRONG>. Similarly, codes
- to move to the right, up, and down should be given as <STRONG>cuf1</STRONG>, <STRONG>cuu1</STRONG>, and
- <STRONG>cud1</STRONG>. These local cursor motions should not alter the text they pass
- over, for example, you would not normally use "<STRONG>cuf1</STRONG>= " because the
+ backspace) that capability should be given as <STRONG>cub1</STRONG>. Similarly, codes
+ to move to the right, up, and down should be given as <STRONG>cuf1</STRONG>, <STRONG>cuu1</STRONG>, and
+ <STRONG>cud1</STRONG>. These local cursor motions should not alter the text they pass
+ over, for example, you would not normally use "<STRONG>cuf1</STRONG>= " because the
space would erase the character moved over.
A very important point here is that the local cursor motions encoded in
- <EM>terminfo</EM> are undefined at the left and top edges of a CRT terminal.
+ <EM>terminfo</EM> are undefined at the left and top edges of a CRT terminal.
Programs should never attempt to backspace around the left edge, unless
- <STRONG>bw</STRONG> is given, and never attempt to go up locally off the top. In order
- to scroll text up, a program will go to the bottom left corner of the
+ <STRONG>bw</STRONG> is given, and never attempt to go up locally off the top. In order
+ to scroll text up, a program will go to the bottom left corner of the
screen and send the <STRONG>ind</STRONG> (index) string.
- To scroll text down, a program goes to the top left corner of the
+ To scroll text down, a program goes to the top left corner of the
screen and sends the <STRONG>ri</STRONG> (reverse index) string. The strings <STRONG>ind</STRONG> and <STRONG>ri</STRONG>
are undefined when not on their respective corners of the screen.
- Parameterized versions of the scrolling sequences are <STRONG>indn</STRONG> and <STRONG>rin</STRONG>
- which have the same semantics as <STRONG>ind</STRONG> and <STRONG>ri</STRONG> except that they take one
- parameter, and scroll that many lines. They are also undefined except
+ Parameterized versions of the scrolling sequences are <STRONG>indn</STRONG> and <STRONG>rin</STRONG>
+ which have the same semantics as <STRONG>ind</STRONG> and <STRONG>ri</STRONG> except that they take one
+ parameter, and scroll that many lines. They are also undefined except
at the appropriate edge of the screen.
- The <STRONG>am</STRONG> capability tells whether the cursor sticks at the right edge of
- the screen when text is output, but this does not necessarily apply to
- a <STRONG>cuf1</STRONG> from the last column. The only local motion which is defined
- from the left edge is if <STRONG>bw</STRONG> is given, then a <STRONG>cub1</STRONG> from the left edge
- will move to the right edge of the previous row. If <STRONG>bw</STRONG> is not given,
- the effect is undefined. This is useful for drawing a box around the
+ The <STRONG>am</STRONG> capability tells whether the cursor sticks at the right edge of
+ the screen when text is output, but this does not necessarily apply to
+ a <STRONG>cuf1</STRONG> from the last column. The only local motion which is defined
+ from the left edge is if <STRONG>bw</STRONG> is given, then a <STRONG>cub1</STRONG> from the left edge
+ will move to the right edge of the previous row. If <STRONG>bw</STRONG> is not given,
+ the effect is undefined. This is useful for drawing a box around the
edge of the screen, for example. If the terminal has switch selectable
- automatic margins, the <EM>terminfo</EM> file usually assumes that this is on;
- i.e., <STRONG>am</STRONG>. If the terminal has a command which moves to the first col-
- umn of the next line, that command can be given as <STRONG>nel</STRONG> (newline). It
- does not matter if the command clears the remainder of the current
- line, so if the terminal has no <STRONG>cr</STRONG> and <STRONG>lf</STRONG> it may still be possible to
+ automatic margins, the <EM>terminfo</EM> file usually assumes that this is on;
+ i.e., <STRONG>am</STRONG>. If the terminal has a command which moves to the first col-
+ umn of the next line, that command can be given as <STRONG>nel</STRONG> (newline). It
+ does not matter if the command clears the remainder of the current
+ line, so if the terminal has no <STRONG>cr</STRONG> and <STRONG>lf</STRONG> it may still be possible to
craft a working <STRONG>nel</STRONG> out of one or both of them.
These capabilities suffice to describe hard-copy and "glass-tty" termi-
</PRE><H3><a name="h3-Parameterized-Strings">Parameterized Strings</a></H3><PRE>
- Cursor addressing and other strings requiring parameters in the termi-
- nal are described by a parameterized string capability, with <EM>printf</EM>-
+ Cursor addressing and other strings requiring parameters in the termi-
+ nal are described by a parameterized string capability, with <EM>printf</EM>-
like escapes such as <EM>%x</EM> in it. For example, to address the cursor, the
- <STRONG>cup</STRONG> capability is given, using two parameters: the row and column to
- address to. (Rows and columns are numbered from zero and refer to the
+ <STRONG>cup</STRONG> capability is given, using two parameters: the row and column to
+ address 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
+ terminal has memory relative cursor addressing, that can be indicated
by <STRONG>mrcup</STRONG>.
- The parameter mechanism uses a stack and special <STRONG>%</STRONG> codes to manipulate
- it. Typically a sequence will push one of the parameters onto the
- stack and then print it in some format. Print (e.g., "%d") is a spe-
+ The parameter mechanism uses a stack and special <STRONG>%</STRONG> codes to manipulate
+ it. Typically a sequence will push one of the parameters onto the
+ stack and then print it in some format. Print (e.g., "%d") is a spe-
cial case. Other operations, including "%t" pop their operand from the
- stack. It is noted that more complex operations are often necessary,
+ stack. It is noted that more complex operations are often necessary,
e.g., in the <STRONG>sgr</STRONG> string.
The <STRONG>%</STRONG> encodings have the following meanings:
<STRONG>%%</STRONG> outputs "%"
<STRONG>%</STRONG><EM>[[</EM>:<EM>]flags][width[.precision]][</EM><STRONG>doxXs</STRONG><EM>]</EM>
- as in <STRONG>printf</STRONG>, flags are <EM>[-+#]</EM> and <EM>space</EM>. Use a ":" to allow the
- next character to be a "-" flag, avoiding interpreting "%-" as an
- operator.
+ as in <STRONG>printf(3)</STRONG>, flags are <EM>[-+#]</EM> and <EM>space</EM>. Use a ":" to allow
+ the next character to be a "-" flag, avoiding interpreting "%-" as
+ an operator.
%c print <EM>pop()</EM> like %c in <STRONG>printf</STRONG>
<STRONG>%g</STRONG><EM>[A-Z]</EM>
get static variable <EM>[a-z]</EM> and push it
- The terms "static" and "dynamic" are misleading. Historically,
+ The terms "static" and "dynamic" are misleading. Historically,
these are simply two different sets of variables, whose values are
- not reset between calls to <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG>. However, that fact is not
+ not reset between calls to <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG>. However, that fact is not
documented in other implementations. Relying on it will adversely
impact portability to other implementations.
<STRONG>%?</STRONG> <EM>expr</EM> <STRONG>%t</STRONG> <EM>thenpart</EM> <STRONG>%e</STRONG> <EM>elsepart</EM> <STRONG>%;</STRONG>
This forms an if-then-else. The <STRONG>%e</STRONG> <EM>elsepart</EM> is optional. Usually
- the <STRONG>%?</STRONG> <EM>expr</EM> part pushes a value onto the stack, and <STRONG>%t</STRONG> pops it
- from the stack, testing if it is nonzero (true). If it is zero
+ the <STRONG>%?</STRONG> <EM>expr</EM> part pushes a value onto the stack, and <STRONG>%t</STRONG> pops it
+ from the stack, testing if it is nonzero (true). If it is zero
(false), control passes to the <STRONG>%e</STRONG> (else) part.
It is possible to form else-if's a la Algol 68:
where ci are conditions, bi are bodies.
- Use the <STRONG>-f</STRONG> option of <STRONG>tic</STRONG> or <STRONG>infocmp</STRONG> to see the structure of if-
+ Use the <STRONG>-f</STRONG> option of <STRONG>tic</STRONG> or <STRONG>infocmp</STRONG> to see the structure of if-
then-else's. Some strings, e.g., <STRONG>sgr</STRONG> can be very complicated when
- written on one line. The <STRONG>-f</STRONG> option splits the string into lines
+ written on one line. The <STRONG>-f</STRONG> option splits the string into lines
with the parts indented.
- Binary operations are in postfix form with the operands in the usual
+ Binary operations are in postfix form with the operands in the usual
order. That is, to get x-5 one would use "%gx%{5}%-". <STRONG>%P</STRONG> and <STRONG>%g</STRONG> vari-
ables are persistent across escape-string evaluations.
- Consider the HP2645, 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
- rows and columns is inverted here, and that the row and column are
- printed as two digits. Thus its <STRONG>cup</STRONG> capability is
+ Consider the HP2645, 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
+ rows and columns is inverted here, and that the row and column are
+ printed as two digits. Thus its <STRONG>cup</STRONG> capability is
"cup=6\E&%p2%2dc%p1%2dY".
- The Microterm ACT-IV needs the current row and column sent preceded by
- a <STRONG>^T</STRONG>, with the row and column simply encoded in binary,
- "cup=^T%p1%c%p2%c". Terminals which use "%c" need to be able to
- backspace the cursor (<STRONG>cub1</STRONG>), and to move the cursor up one line on the
- screen (<STRONG>cuu1</STRONG>). This is necessary because it is not always safe to
- transmit <STRONG>\n</STRONG> <STRONG>^D</STRONG> and <STRONG>\r</STRONG>, as the system may change or discard them. (The
- library routines dealing with terminfo set tty modes so that tabs are
- never expanded, so \t is safe to send. This turns out to be essential
+ The Microterm ACT-IV needs the current row and column sent preceded by
+ a <STRONG>^T</STRONG>, with the row and column simply encoded in binary,
+ "cup=^T%p1%c%p2%c". Terminals which use "%c" need to be able to
+ backspace the cursor (<STRONG>cub1</STRONG>), and to move the cursor up one line on the
+ screen (<STRONG>cuu1</STRONG>). This is necessary because it is not always safe to
+ transmit <STRONG>\n</STRONG> <STRONG>^D</STRONG> and <STRONG>\r</STRONG>, as the system may change or discard them. (The
+ library routines dealing with terminfo set tty modes so that tabs are
+ never expanded, so \t is safe to send. This turns out to be essential
for the Ann Arbor 4080.)
- A final example is the LSI ADM-3a, which uses row and column offset by
+ A final example is the LSI ADM-3a, which uses row and column offset by
a blank character, thus "cup=\E=%p1%' '%+%c%p2%' '%+%c". After sending
- "\E=", this pushes the first parameter, pushes the ASCII value for a
+ "\E=", this pushes the first parameter, pushes the ASCII value for a
space (32), adds them (pushing the sum on the stack in place of the two
- previous values) and outputs that value as a character. Then the same
- is done for the second parameter. More complex arithmetic is possible
+ previous values) and outputs that value as a character. Then the same
+ is done for the second parameter. More complex arithmetic is possible
using the stack.
</PRE><H3><a name="h3-Cursor-Motions">Cursor Motions</a></H3><PRE>
- If the terminal has a fast way to home the cursor (to very upper left
- corner of screen) then this can be given as <STRONG>home</STRONG>; similarly a fast way
- of getting to the lower left-hand corner can be given as <STRONG>ll</STRONG>; this may
+ If the terminal has a fast way to home the cursor (to very upper left
+ corner of screen) then this can be given as <STRONG>home</STRONG>; similarly a fast way
+ of getting to the lower left-hand corner can be given as <STRONG>ll</STRONG>; this may
involve going up with <STRONG>cuu1</STRONG> from the home position, but a program should
never do this itself (unless <STRONG>ll</STRONG> 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 addressing to (0,0): to the top left cor-
+ about the effect of moving up from the home position. Note that the
+ home position is the same as addressing to (0,0): to the top left cor-
ner of the screen, not of memory. (Thus, the \EH sequence on HP termi-
nals cannot be used for <STRONG>home</STRONG>.)
If the terminal has row or column absolute cursor addressing, these can
- be given as single parameter capabilities <STRONG>hpa</STRONG> (horizontal position
- absolute) and <STRONG>vpa</STRONG> (vertical position absolute). Sometimes these are
- shorter than the more general two parameter sequence (as with the
- hp2645) and can be used in preference to <STRONG>cup</STRONG>. If there are parameter-
- ized local motions (e.g., move <EM>n</EM> spaces to the right) these can be
- given as <STRONG>cud</STRONG>, <STRONG>cub</STRONG>, <STRONG>cuf</STRONG>, and <STRONG>cuu</STRONG> with a single parameter indicating how
- many spaces to move. These are primarily useful if the terminal does
+ be given as single parameter capabilities <STRONG>hpa</STRONG> (horizontal position
+ absolute) and <STRONG>vpa</STRONG> (vertical position absolute). Sometimes these are
+ shorter than the more general two parameter sequence (as with the
+ hp2645) and can be used in preference to <STRONG>cup</STRONG>. If there are parameter-
+ ized local motions (e.g., move <EM>n</EM> spaces to the right) these can be
+ given as <STRONG>cud</STRONG>, <STRONG>cub</STRONG>, <STRONG>cuf</STRONG>, and <STRONG>cuu</STRONG> with a single parameter indicating how
+ many spaces to move. These are primarily useful if the terminal does
not have <STRONG>cup</STRONG>, such as the TEKTRONIX 4025.
- If the terminal needs to be in a special mode when running a program
+ 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 <STRONG>smcup</STRONG> and <STRONG>rmcup</STRONG>. This arises, for example, from terminals
- like the Concept with more than one page of memory. If the terminal
+ be given as <STRONG>smcup</STRONG> and <STRONG>rmcup</STRONG>. This arises, for 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 cur-
sor addressing, a one screen-sized window must be fixed into the termi-
- nal for cursor addressing to work properly. This is also used for the
- TEKTRONIX 4025, where <STRONG>smcup</STRONG> sets the command character to be the one
- used by terminfo. If the <STRONG>smcup</STRONG> sequence will not restore the screen
- after an <STRONG>rmcup</STRONG> sequence is output (to the state prior to outputting
+ nal for cursor addressing to work properly. This is also used for the
+ TEKTRONIX 4025, where <STRONG>smcup</STRONG> sets the command character to be the one
+ used by terminfo. If the <STRONG>smcup</STRONG> sequence will not restore the screen
+ after an <STRONG>rmcup</STRONG> sequence is output (to the state prior to outputting
<STRONG>rmcup</STRONG>), specify <STRONG>nrrmc</STRONG>.
</PRE><H3><a name="h3-Area-Clears">Area Clears</a></H3><PRE>
- 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 <STRONG>el</STRONG>. If
- the terminal can clear from the beginning of the line to the current
- position inclusive, leaving the cursor where it is, this should be
- given as <STRONG>el1</STRONG>. If the terminal can clear from the current position to
- the end of the display, then this should be given as <STRONG>ed</STRONG>. <STRONG>Ed</STRONG> is only
+ 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 <STRONG>el</STRONG>. If
+ the terminal can clear from the beginning of the line to the current
+ position inclusive, leaving the cursor where it is, this should be
+ given as <STRONG>el1</STRONG>. If the terminal can clear from the current position to
+ the end of the display, then this should be given as <STRONG>ed</STRONG>. <STRONG>Ed</STRONG> is only
defined from the first column of a line. (Thus, it can be simulated by
a request to delete a large number of lines, if a true <STRONG>ed</STRONG> is not avail-
able.)
</PRE><H3><a name="h3-Insert_delete-line-and-vertical-motions">Insert/delete line and vertical motions</a></H3><PRE>
- If the terminal can open a new blank line before the line where the
- cursor is, this should be given as <STRONG>il1</STRONG>; this is done only from the
- first position of a line. The cursor must then appear on the newly
- blank line. If the terminal can delete the line which the cursor is
- on, then this should be given as <STRONG>dl1</STRONG>; this is done only from the first
+ If the terminal can open a new blank line before the line where the
+ cursor is, this should be given as <STRONG>il1</STRONG>; this is done only from the
+ first position of a line. The cursor must then appear on the newly
+ blank line. If the terminal can delete the line which the cursor is
+ on, then this should be given as <STRONG>dl1</STRONG>; this is done only from the first
position on the line to be deleted. Versions of <STRONG>il1</STRONG> and <STRONG>dl1</STRONG> which take
a single parameter and insert or delete that many lines can be given as
<STRONG>il</STRONG> and <STRONG>dl</STRONG>.
- If the terminal has a settable scrolling region (like the vt100) the
- command to set this can be described with the <STRONG>csr</STRONG> capability, which
+ If the terminal has a settable scrolling region (like the vt100) the
+ command to set this can be described with the <STRONG>csr</STRONG> 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 of insert or delete line using <STRONG>csr</STRONG> on
- a properly chosen region; the <STRONG>sc</STRONG> and <STRONG>rc</STRONG> (save and restore cursor) com-
- mands may be useful for ensuring that your synthesized insert/delete
- string does not move the cursor. (Note that the <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> library
- does this synthesis automatically, so you need not compose
+ It is possible to get the effect of insert or delete line using <STRONG>csr</STRONG> on
+ a properly chosen region; the <STRONG>sc</STRONG> and <STRONG>rc</STRONG> (save and restore cursor) com-
+ mands may be useful for ensuring that your synthesized insert/delete
+ string does not move the cursor. (Note that the <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> library
+ does this synthesis automatically, so you need not compose
insert/delete strings for an entry with <STRONG>csr</STRONG>).
Yet another way to construct insert and delete might be to use a combi-
- nation of index with the memory-lock feature found on some terminals
+ nation of index with the memory-lock feature found on some terminals
(like the HP-700/90 series, which however also has insert/delete).
- Inserting lines at the top or bottom of the screen can also be done
- using <STRONG>ri</STRONG> or <STRONG>ind</STRONG> on many terminals without a true insert/delete line,
+ Inserting lines at the top or bottom of the screen can also be done
+ using <STRONG>ri</STRONG> or <STRONG>ind</STRONG> on many terminals without a true insert/delete line,
and is often faster even on terminals with those features.
The boolean <STRONG>non_dest_scroll_region</STRONG> should be set if each scrolling win-
- dow is effectively a view port on a screen-sized canvas. To test for
+ dow is effectively a view port on a screen-sized canvas. To test for
this capability, create a scrolling region in the middle of the screen,
- write something to the bottom line, move the cursor to the top of the
+ write something to the bottom line, move the cursor to the top of the
region, and do <STRONG>ri</STRONG> followed by <STRONG>dl1</STRONG> or <STRONG>ind</STRONG>. If the data scrolled off the
- bottom of the region by the <STRONG>ri</STRONG> re-appears, then scrolling is non-
- destructive. System V and XSI Curses expect that <STRONG>ind</STRONG>, <STRONG>ri</STRONG>, <STRONG>indn</STRONG>, and
- <STRONG>rin</STRONG> will simulate destructive scrolling; their documentation cautions
- you not to define <STRONG>csr</STRONG> unless this is true. This <STRONG>curses</STRONG> implementation
+ bottom of the region by the <STRONG>ri</STRONG> re-appears, then scrolling is non-
+ destructive. System V and XSI Curses expect that <STRONG>ind</STRONG>, <STRONG>ri</STRONG>, <STRONG>indn</STRONG>, and
+ <STRONG>rin</STRONG> will simulate destructive scrolling; their documentation cautions
+ you not to define <STRONG>csr</STRONG> unless this is true. This <STRONG>curses</STRONG> implementation
is more liberal and will do explicit erases after scrolling if <STRONG>ndsrc</STRONG> is
defined.
- 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 <STRONG>wind</STRONG>. The four parameters are the starting and ending lines in
+ 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 <STRONG>wind</STRONG>. The four parameters are the starting and ending lines in
memory and the starting and ending columns in memory, in that order.
If the terminal can retain display memory above, then the <STRONG>da</STRONG> capability
- should be given; if display memory can be retained below, then <STRONG>db</STRONG>
- should be given. These indicate that deleting a line or scrolling may
- bring non-blank lines up from below or that scrolling back with <STRONG>ri</STRONG> may
+ should be given; if display memory can be retained below, then <STRONG>db</STRONG>
+ should be given. These indicate that deleting a line or scrolling may
+ bring non-blank lines up from below or that scrolling back with <STRONG>ri</STRONG> may
bring down non-blank lines.
</PRE><H3><a name="h3-Insert_Delete-Character">Insert/Delete Character</a></H3><PRE>
- There are two basic kinds of intelligent terminals with respect to
- insert/delete character which can be described using <EM>terminfo.</EM> The
- most common insert/delete character operations affect only the charac-
- ters on the current line and shift characters off the end of the line
+ There are two basic kinds of intelligent terminals with respect to
+ insert/delete character which can be described using <EM>terminfo.</EM> The
+ most common insert/delete character operations affect only the charac-
+ ters 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
+ 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 terminal you have by clearing the screen
- and 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 terminal
- 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, you have the sec-
- ond type of terminal, and should give the capability <STRONG>in</STRONG>, which stands
+ You can determine the kind of terminal you have by clearing the screen
+ and 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 terminal
+ 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, you have the sec-
+ ond type of terminal, and should give the capability <STRONG>in</STRONG>, which stands
for "insert null".
- While these are two logically separate attributes (one line versus
- multi-line insert mode, and special treatment of untyped spaces) we
- have seen no terminals whose insert mode cannot be described with the
+ While these are two logically separate attributes (one line versus
+ 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.
- Terminfo can describe both terminals which have an insert mode, and
- terminals which send a simple sequence to open a blank position on the
+ Terminfo can describe both terminals which have an insert mode, and
+ terminals which send a simple sequence to open a blank position on the
current line. Give as <STRONG>smir</STRONG> the sequence to get into insert mode. Give
- as <STRONG>rmir</STRONG> the sequence to leave insert mode. Now give as <STRONG>ich1</STRONG> any
- sequence needed to be sent just before sending the character to be
- inserted. Most terminals with a true insert mode will not give <STRONG>ich1</STRONG>;
- terminals which send a sequence to open a screen position should give
+ as <STRONG>rmir</STRONG> the sequence to leave insert mode. Now give as <STRONG>ich1</STRONG> any
+ sequence needed to be sent just before sending the character to be
+ inserted. Most terminals with a true insert mode will not give <STRONG>ich1</STRONG>;
+ terminals which send a sequence to open a screen position should give
it here.
- If your terminal has both, insert mode is usually preferable to <STRONG>ich1</STRONG>.
- Technically, you should not give both unless the terminal actually
- requires both to be used in combination. Accordingly, some non-curses
- applications get confused if both are present; the symptom is doubled
- characters in an update using insert. This requirement is now rare;
- most <STRONG>ich</STRONG> sequences do not require previous smir, and most smir insert
- modes do not require <STRONG>ich1</STRONG> before each character. Therefore, the new
- <STRONG>curses</STRONG> actually assumes this is the case and uses either <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> or
- <STRONG>ich</STRONG>/<STRONG>ich1</STRONG> as appropriate (but not both). If you have to write an entry
- to be used under new curses for a terminal old enough to need both,
+ If your terminal has both, insert mode is usually preferable to <STRONG>ich1</STRONG>.
+ Technically, you should not give both unless the terminal actually
+ requires both to be used in combination. Accordingly, some non-curses
+ applications get confused if both are present; the symptom is doubled
+ characters in an update using insert. This requirement is now rare;
+ most <STRONG>ich</STRONG> sequences do not require previous smir, and most smir insert
+ modes do not require <STRONG>ich1</STRONG> before each character. Therefore, the new
+ <STRONG>curses</STRONG> actually assumes this is the case and uses either <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> or
+ <STRONG>ich</STRONG>/<STRONG>ich1</STRONG> as appropriate (but not both). If you have to write an entry
+ to be used under new curses for a terminal old enough to need both,
include the <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> sequences in <STRONG>ich1</STRONG>.
If post insert padding is needed, give this as a number of milliseconds
- in <STRONG>ip</STRONG> (a string option). Any other sequence which may need to be sent
+ in <STRONG>ip</STRONG> (a string option). Any other sequence which may need to be sent
after an insert of a single character may also be given in <STRONG>ip</STRONG>. If your
- terminal needs both to be placed into an "insert mode" and a special
- code to precede each inserted character, then both <STRONG>smir</STRONG>/<STRONG>rmir</STRONG> and <STRONG>ich1</STRONG>
- can be given, and both will be used. The <STRONG>ich</STRONG> capability, with one
+ terminal needs both to be placed into an "insert mode" and a special
+ code to precede each inserted character, then both <STRONG>smir</STRONG>/<STRONG>rmir</STRONG> and <STRONG>ich1</STRONG>
+ can be given, and both will be used. The <STRONG>ich</STRONG> capability, with one
parameter, <EM>n</EM>, will repeat the effects of <STRONG>ich1</STRONG> <EM>n</EM> times.
- If padding is necessary between characters typed while not in insert
+ If padding is necessary between characters typed while not in insert
mode, give this as a number of milliseconds padding in <STRONG>rmp</STRONG>.
- It is occasionally necessary to move around while in insert mode to
- delete characters on the same line (e.g., if there is a tab after the
- insertion position). If your terminal allows motion while in insert
- mode you can give the capability <STRONG>mir</STRONG> to speed up inserting in this
- case. Omitting <STRONG>mir</STRONG> will affect only speed. Some terminals (notably
- Datamedia's) must not have <STRONG>mir</STRONG> because of the way their insert mode
+ It is occasionally necessary to move around while in insert mode to
+ delete characters on the same line (e.g., if there is a tab after the
+ insertion position). If your terminal allows motion while in insert
+ mode you can give the capability <STRONG>mir</STRONG> to speed up inserting in this
+ case. Omitting <STRONG>mir</STRONG> will affect only speed. Some terminals (notably
+ Datamedia's) must not have <STRONG>mir</STRONG> because of the way their insert mode
works.
- Finally, you can specify <STRONG>dch1</STRONG> to delete a single character, <STRONG>dch</STRONG> with
- one parameter, <EM>n</EM>, to delete <EM>n</EM> <EM>characters,</EM> and delete mode by giving
- <STRONG>smdc</STRONG> and <STRONG>rmdc</STRONG> to enter and exit delete mode (any mode the terminal
+ Finally, you can specify <STRONG>dch1</STRONG> to delete a single character, <STRONG>dch</STRONG> with
+ one parameter, <EM>n</EM>, to delete <EM>n</EM> <EM>characters,</EM> and delete mode by giving
+ <STRONG>smdc</STRONG> and <STRONG>rmdc</STRONG> to enter and exit delete mode (any mode the terminal
needs to be placed in for <STRONG>dch1</STRONG> to work).
- A command to erase <EM>n</EM> characters (equivalent to outputting <EM>n</EM> blanks
+ A command to erase <EM>n</EM> characters (equivalent to outputting <EM>n</EM> blanks
without moving the cursor) can be given as <STRONG>ech</STRONG> with one parameter.
</PRE><H3><a name="h3-Highlighting_-Underlining_-and-Visible-Bells">Highlighting, Underlining, and Visible Bells</a></H3><PRE>
If your terminal has one or more kinds of display attributes, these can
- be represented in a number of different ways. You should choose one
- display form as <EM>standout</EM> <EM>mode</EM>, 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 <STRONG>smso</STRONG> and <STRONG>rmso</STRONG>, respectively. If the
- code to change into or out of standout mode leaves one or even two
- blank spaces on the screen, as the TVI 912 and Teleray 1061 do, then
+ be represented in a number of different ways. You should choose one
+ display form as <EM>standout</EM> <EM>mode</EM>, 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 <STRONG>smso</STRONG> and <STRONG>rmso</STRONG>, respectively. If the
+ code to change into or out of standout mode leaves one or even two
+ blank spaces on the screen, as the TVI 912 and Teleray 1061 do, then
<STRONG>xmc</STRONG> should be given to tell how many spaces are left.
Codes to begin underlining and end underlining can be given as <STRONG>smul</STRONG> and
<STRONG>rmul</STRONG> respectively. If the terminal has a code to underline the current
- character and move the cursor one space to the right, such as the
+ character and move the cursor one space to the right, such as the
Microterm Mime, this can be given as <STRONG>uc</STRONG>.
- Other capabilities to enter various highlighting modes include <STRONG>blink</STRONG>
- (blinking) <STRONG>bold</STRONG> (bold or extra bright) <STRONG>dim</STRONG> (dim or half-bright) <STRONG>invis</STRONG>
- (blanking or invisible text) <STRONG>prot</STRONG> (protected) <STRONG>rev</STRONG> (reverse video) <STRONG>sgr0</STRONG>
- (turn off <EM>all</EM> attribute modes) <STRONG>smacs</STRONG> (enter alternate character set
+ Other capabilities to enter various highlighting modes include <STRONG>blink</STRONG>
+ (blinking) <STRONG>bold</STRONG> (bold or extra bright) <STRONG>dim</STRONG> (dim or half-bright) <STRONG>invis</STRONG>
+ (blanking or invisible text) <STRONG>prot</STRONG> (protected) <STRONG>rev</STRONG> (reverse video) <STRONG>sgr0</STRONG>
+ (turn off <EM>all</EM> attribute modes) <STRONG>smacs</STRONG> (enter alternate character set
mode) and <STRONG>rmacs</STRONG> (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 modes, this
- should be given as <STRONG>sgr</STRONG> (set attributes), taking 9 parameters. Each
- parameter is either 0 or nonzero, as the corresponding attribute is on
- or off. The 9 parameters are, in order: standout, underline, reverse,
- blink, dim, bold, blank, protect, alternate character set. Not all
+ If there is a sequence to set arbitrary combinations of modes, this
+ should be given as <STRONG>sgr</STRONG> (set attributes), taking 9 parameters. Each
+ parameter is either 0 or nonzero, as the corresponding attribute is on
+ or off. The 9 parameters are, in order: standout, underline, reverse,
+ blink, dim, bold, blank, protect, alternate character set. Not all
modes need be supported by <STRONG>sgr</STRONG>, only those for which corresponding sep-
arate attribute commands exist.
p8 protect not used
p9 altcharset ^O (off) ^N (on)
- We begin each escape sequence by turning off any existing modes, since
- there is no quick way to determine whether they are active. Standout
- is set up to be the combination of reverse and bold. The vt220 termi-
- nal has a protect mode, though it is not commonly used in sgr because
- it protects characters on the screen from the host's erasures. The
- altcharset mode also is different in that it is either ^O or ^N,
- depending on whether it is off or on. If all modes are turned on, the
+ We begin each escape sequence by turning off any existing modes, since
+ there is no quick way to determine whether they are active. Standout
+ is set up to be the combination of reverse and bold. The vt220 termi-
+ nal has a protect mode, though it is not commonly used in sgr because
+ it protects characters on the screen from the host's erasures. The
+ altcharset mode also is different in that it is either ^O or ^N,
+ depending on whether it is off or on. If all modes are turned on, the
resulting sequence is \E[0;1;4;5;7;8m^N.
- Some sequences are common to different modes. For example, ;7 is out-
- put when either p1 or p3 is true, that is, if either standout or
+ Some sequences are common to different modes. For example, ;7 is out-
+ put when either p1 or p3 is true, that is, if either standout or
reverse modes are turned on.
Writing out the above sequences, along with their dependencies yields
sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p4%t;5%;
%?%p1%p3%|%t;7%;%?%p7%t;8%;m%?%p9%t\016%e\017%;,
- Remember that if you specify sgr, you must also specify sgr0. Also,
- some implementations rely on sgr being given if sgr0 is, Not all ter-
- minfo entries necessarily have an sgr string, however. Many terminfo
+ Remember that if you specify sgr, you must also specify sgr0. Also,
+ some implementations rely on sgr being given if sgr0 is, Not all ter-
+ minfo entries necessarily have an sgr string, however. Many terminfo
entries are derived from termcap entries which have no sgr string. The
only drawback to adding an sgr string is that termcap also assumes that
sgr0 does not exit alternate character set mode.
- Terminals with the "magic cookie" glitch (<STRONG>xmc</STRONG>) deposit special "cook-
+ Terminals with the "magic cookie" glitch (<STRONG>xmc</STRONG>) deposit special "cook-
ies" when they receive mode-setting sequences, which affect the display
- algorithm rather than having extra bits for each character. Some ter-
- minals, such as the HP 2621, automatically leave standout mode when
- they move to a new line or the cursor is addressed. Programs using
- standout mode should exit standout mode before moving the cursor or
- sending a newline, unless the <STRONG>msgr</STRONG> capability, asserting that it is
+ algorithm rather than having extra bits for each character. Some ter-
+ minals, such as the HP 2621, automatically leave standout mode when
+ they move to a new line or the cursor is addressed. Programs using
+ standout mode should exit standout mode before moving the cursor or
+ sending a newline, unless the <STRONG>msgr</STRONG> capability, asserting that it is
safe to move in standout mode, is present.
- If the terminal has a way of flashing the screen to indicate an error
- quietly (a bell replacement) then this can be given as <STRONG>flash</STRONG>; it must
+ If the terminal has a way of flashing the screen to indicate an error
+ quietly (a bell replacement) then this can be given as <STRONG>flash</STRONG>; it must
not move the cursor.
- If the cursor needs to be made more visible than normal when it is not
+ If the cursor needs to be made more visible than normal when it is not
on the bottom line (to make, for example, a non-blinking underline into
- an easier to find block or blinking underline) give this sequence as
+ an easier to find block or blinking underline) give this sequence as
<STRONG>cvvis</STRONG>. If there is a way to make the cursor completely invisible, give
- that as <STRONG>civis</STRONG>. The capability <STRONG>cnorm</STRONG> should be given which undoes the
+ that as <STRONG>civis</STRONG>. The capability <STRONG>cnorm</STRONG> should be given which undoes the
effects of both of these modes.
- If your terminal correctly generates underlined characters (with no
- special codes needed) even though it does not overstrike, then you
- should give the capability <STRONG>ul</STRONG>. If a character overstriking another
- leaves both characters on the screen, specify the capability <STRONG>os</STRONG>. If
+ If your terminal correctly generates underlined characters (with no
+ special codes needed) even though it does not overstrike, then you
+ should give the capability <STRONG>ul</STRONG>. If a character overstriking another
+ leaves both characters on the screen, specify the capability <STRONG>os</STRONG>. If
overstrikes are erasable with a blank, then this should be indicated by
giving <STRONG>eo</STRONG>.
</PRE><H3><a name="h3-Keypad-and-Function-Keys">Keypad and Function Keys</a></H3><PRE>
- 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
+ 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 (this applies,
- for example, to the unshifted HP 2621 keys). If the keypad can be set
+ for example, to the unshifted HP 2621 keys). If the keypad can be set
to transmit or not transmit, give these codes as <STRONG>smkx</STRONG> and <STRONG>rmkx</STRONG>. Other-
wise 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 <STRONG>kcub1,</STRONG> <STRONG>kcuf1,</STRONG> <STRONG>kcuu1,</STRONG> <STRONG>kcud1,</STRONG> and <STRONG>khome</STRONG>
+ The codes sent by the left arrow, right arrow, up arrow, down arrow,
+ and home keys can be given as <STRONG>kcub1,</STRONG> <STRONG>kcuf1,</STRONG> <STRONG>kcuu1,</STRONG> <STRONG>kcud1,</STRONG> and <STRONG>khome</STRONG>
respectively. If there are function keys such as f0, f1, ..., f10, the
- codes they send can be given as <STRONG>kf0,</STRONG> <STRONG>kf1,</STRONG> <STRONG>...,</STRONG> <STRONG>kf10</STRONG>. If these keys
- have labels other than the default f0 through f10, the labels can be
+ codes they send can be given as <STRONG>kf0,</STRONG> <STRONG>kf1,</STRONG> <STRONG>...,</STRONG> <STRONG>kf10</STRONG>. If these keys
+ have labels other than the default f0 through f10, the labels can be
given as <STRONG>lf0,</STRONG> <STRONG>lf1,</STRONG> <STRONG>...,</STRONG> <STRONG>lf10</STRONG>.
The codes transmitted by certain other special keys can be given:
<STRONG>o</STRONG> <STRONG>khts</STRONG> (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, the other five keys can be given as <STRONG>ka1</STRONG>, <STRONG>ka3</STRONG>, <STRONG>kb2</STRONG>,
- <STRONG>kc1</STRONG>, and <STRONG>kc3</STRONG>. These keys are useful when the effects of a 3 by 3
+ In addition, if the keypad has a 3 by 3 array of keys including the
+ four arrow keys, the other five keys can be given as <STRONG>ka1</STRONG>, <STRONG>ka3</STRONG>, <STRONG>kb2</STRONG>,
+ <STRONG>kc1</STRONG>, and <STRONG>kc3</STRONG>. These keys are useful when the effects of a 3 by 3
directional pad are needed.
Strings to program function keys can be given as <STRONG>pfkey</STRONG>, <STRONG>pfloc</STRONG>, and <STRONG>pfx</STRONG>.
- A string to program screen labels should be specified as <STRONG>pln</STRONG>. Each of
- these strings takes two parameters: the function key number to program
+ A string to program screen labels should be specified as <STRONG>pln</STRONG>. Each of
+ these strings takes two parameters: the function key number to program
(from 0 to 10) and the string to program it with. Function key numbers
- out of this range may program undefined keys in a terminal dependent
- manner. The difference between the capabilities is that <STRONG>pfkey</STRONG> causes
- pressing the given key to be the same as the user typing the given
- string; <STRONG>pfloc</STRONG> causes the string to be executed by the terminal in
+ out of this range may program undefined keys in a terminal dependent
+ manner. The difference between the capabilities is that <STRONG>pfkey</STRONG> causes
+ pressing the given key to be the same as the user typing the given
+ string; <STRONG>pfloc</STRONG> causes the string to be executed by the terminal in
local; and <STRONG>pfx</STRONG> causes the string to be transmitted to the computer.
- The capabilities <STRONG>nlab</STRONG>, <STRONG>lw</STRONG> and <STRONG>lh</STRONG> define the number of programmable
- screen labels and their width and height. If there are commands to
- turn the labels on and off, give them in <STRONG>smln</STRONG> and <STRONG>rmln</STRONG>. <STRONG>smln</STRONG> is nor-
- mally output after one or more pln sequences to make sure that the
+ The capabilities <STRONG>nlab</STRONG>, <STRONG>lw</STRONG> and <STRONG>lh</STRONG> define the number of programmable
+ screen labels and their width and height. If there are commands to
+ turn the labels on and off, give them in <STRONG>smln</STRONG> and <STRONG>rmln</STRONG>. <STRONG>smln</STRONG> is nor-
+ mally output after one or more pln sequences to make sure that the
change becomes visible.
</PRE><H3><a name="h3-Tabs-and-Initialization">Tabs and Initialization</a></H3><PRE>
- If the terminal has hardware tabs, the command to advance to the next
- tab stop can be given as <STRONG>ht</STRONG> (usually control I). A "back-tab" command
- which moves leftward to the preceding tab stop can be given as <STRONG>cbt</STRONG>. By
- convention, if the teletype modes indicate that tabs are being expanded
- by the computer rather than being sent to the terminal, programs should
- not use <STRONG>ht</STRONG> or <STRONG>cbt</STRONG> even if they are present, since the user may not have
- the tab stops properly set. If the terminal has hardware tabs which
- are initially set every <EM>n</EM> spaces when the terminal is powered up, the
- numeric parameter <STRONG>it</STRONG> is given, showing the number of spaces the tabs
- are set to. This is normally used by the <STRONG>tset</STRONG> command to determine
- whether to set the mode for hardware tab expansion, and whether to set
- the tab stops. If the terminal has tab stops that can be saved in non-
- volatile memory, the terminfo description can assume that they are
- properly set.
-
- Other capabilities include <STRONG>is1</STRONG>, <STRONG>is2</STRONG>, and <STRONG>is3</STRONG>, initialization strings
- for the terminal, <STRONG>iprog</STRONG>, the path name of a program to be run to ini-
- tialize the terminal, and <STRONG>if</STRONG>, the name of a file containing long ini-
- tialization strings. These strings are expected to set the terminal
- into modes consistent with the rest of the terminfo description. They
- are normally sent to the terminal, by the <EM>init</EM> option of the <STRONG>tput</STRONG> pro-
- gram, each time the user logs in. They will be printed in the follow-
- ing order:
+ A few capabilities are used only for tabs:
+
+ <STRONG>o</STRONG> If the terminal has hardware tabs, the command to advance to the
+ next tab stop can be given as <STRONG>ht</STRONG> (usually control/I).
+
+ <STRONG>o</STRONG> A "back-tab" command which moves leftward to the preceding tab stop
+ can be given as <STRONG>cbt</STRONG>.
+
+ By convention, if the teletype modes indicate that tabs are being
+ expanded by the computer rather than being sent to the terminal,
+ programs should not use <STRONG>ht</STRONG> or <STRONG>cbt</STRONG> even if they are present, since
+ the user may not have the tab stops properly set.
+
+ <STRONG>o</STRONG> If the terminal has hardware tabs which are initially set every <EM>n</EM>
+ spaces when the terminal is powered up, the numeric parameter <STRONG>it</STRONG> is
+ given, showing the number of spaces the tabs are set to.
+
+ The <STRONG>it</STRONG> capability is normally used by the <STRONG>tset</STRONG> command to determine
+ whether to set the mode for hardware tab expansion, and whether to
+ set the tab stops. If the terminal has tab stops that can be saved
+ in non-volatile memory, the terminfo description can assume that
+ they are properly set.
+
+ Other capabilities include
+
+ <STRONG>o</STRONG> <STRONG>is1</STRONG>, <STRONG>is2</STRONG>, and <STRONG>is3</STRONG>, initialization strings for the terminal,
+
+ <STRONG>o</STRONG> <STRONG>iprog</STRONG>, the path name of a program to be run to initialize the ter-
+ minal,
+
+ <STRONG>o</STRONG> and <STRONG>if</STRONG>, 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 terminfo description. They are normally sent to
+ the terminal, by the <EM>init</EM> option of the <STRONG>tput</STRONG> program, each time the
+ user logs in. They will be printed in the following order:
run the program
<STRONG>iprog</STRONG>
- output <STRONG>is1</STRONG> <STRONG>is2</STRONG>
+ output
+ <STRONG>is1</STRONG> and
+ <STRONG>is2</STRONG>
set the margins using
- <STRONG>mgc</STRONG>, <STRONG>smgl</STRONG> and <STRONG>smgr</STRONG>
+ <STRONG>mgc</STRONG> or
+ <STRONG>smglp</STRONG> and <STRONG>smgrp</STRONG> or
+ <STRONG>smgl</STRONG> and <STRONG>smgr</STRONG>
set tabs using
<STRONG>tbc</STRONG> and <STRONG>hts</STRONG>
print the file
<STRONG>if</STRONG>
- and finally
- output <STRONG>is3</STRONG>.
+ and finally output
+ <STRONG>is3</STRONG>.
Most initialization is done with <STRONG>is2</STRONG>. Special terminal modes can be
set up without duplicating strings by putting the common sequences in
A set of sequences that does a harder reset from a totally unknown
state can be given as <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rf</STRONG> and <STRONG>rs3</STRONG>, analogous to <STRONG>is1</STRONG> <STRONG>,</STRONG> <STRONG>is2</STRONG> <STRONG>,</STRONG> <STRONG>if</STRONG>
- and <STRONG>is3</STRONG> respectively. These strings are output by the <STRONG>reset</STRONG> program,
- which is used when the terminal gets into a wedged state. Commands are
- normally placed in <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG> <STRONG>rs3</STRONG> and <STRONG>rf</STRONG> 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 <STRONG>is2</STRONG>, but it causes an annoying glitch of the screen and is not
- normally needed since the terminal is usually already in 80 column
- mode.
+ and <STRONG>is3</STRONG> respectively. These strings are output by <EM>reset</EM> option of
+ <STRONG>tput</STRONG>, or by the <STRONG>reset</STRONG> program (an alias of <STRONG>tset</STRONG>), which is used when
+ the terminal gets into a wedged state. Commands are normally placed in
+ <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG> <STRONG>rs3</STRONG> and <STRONG>rf</STRONG> only if they produce annoying effects on the screen
+ and are not necessary when logging in. For example, the command to set
+ the vt100 into 80-column mode would normally be part of <STRONG>is2</STRONG>, but it
+ causes an annoying glitch of the screen and is not normally needed
+ since the terminal is usually already in 80-column mode.
The <STRONG>reset</STRONG> program writes strings including <STRONG>iprog</STRONG>, etc., in the same
order as the <EM>init</EM> program, using <STRONG>rs1</STRONG>, etc., instead of <STRONG>is1</STRONG>, etc. If
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 <STRONG>is2</STRONG> or <STRONG>if</STRONG>.
+ The <STRONG>tput</STRONG> <STRONG>reset</STRONG> command uses the same capability strings as the <STRONG>reset</STRONG>
+ command, although the two programs (<STRONG>tput</STRONG> and <STRONG>reset</STRONG>) provide different
+ command-line options.
+
+ In practice, these terminfo capabilities are not often used in initial-
+ ization of tabs (though they are required for the <STRONG>tabs</STRONG> program):
+
+ <STRONG>o</STRONG> Almost all hardware terminals (at least those which supported tabs)
+ initialized those to every <EM>eight</EM> columns:
+
+ The only exception was the AT&T 2300 series, which set tabs to
+ every <EM>five</EM> columns.
+
+ <STRONG>o</STRONG> In particular, developers of the hardware terminals which are com-
+ monly used as models for modern terminal emulators provided docu-
+ mentation demonstrating that <EM>eight</EM> columns were the standard.
+
+ <STRONG>o</STRONG> Because of this, the terminal initialization programs <STRONG>tput</STRONG> and <STRONG>tset</STRONG>
+ use the <STRONG>tbc</STRONG> (<STRONG>clear_all_tabs</STRONG>) and <STRONG>hts</STRONG> (<STRONG>set_tab</STRONG>) capabilities
+ directly only when the <STRONG>it</STRONG> (<STRONG>init_tabs</STRONG>) capability is set to a value
+ other than <EM>eight</EM>.
+
</PRE><H3><a name="h3-Delays-and-Padding">Delays and Padding</a></H3><PRE>
Many older and slower terminals do not support either XON/XOFF or DTR
degree symbol ACS_DEGREE \ f 0x66
plus/minus ACS_PLMINUS # g 0x67
board of squares ACS_BOARD # h 0x68
-
lantern symbol ACS_LANTERN # i 0x69
lower right corner ACS_LRCORNER + j 0x6a
upper right corner ACS_URCORNER + k 0x6b
A_BOLD 5 32 sgr
A_INVIS 6 64 sgr
A_PROTECT 7 128 sgr
+
A_ALTCHARSET 8 256 sgr
A_HORIZONTAL 9 512 sgr1
A_LEFT 10 1024 sgr1
with <STRONG>hu</STRONG> (half-line up) and <STRONG>hd</STRONG> (half-line down). This is primarily use-
ful for superscripts and subscripts on hard-copy terminals. If a hard-
copy terminal can eject to the next page (form feed), give this as <STRONG>ff</STRONG>
- (usually control L).
+ (usually control/L).
If there is a command to repeat a given character a given number of
times (to save time transmitting a large number of identical charac-
ncurses implementation ignores this glitch.
The Beehive Superbee, which is unable to correctly transmit the escape
- or control C characters, has <STRONG>xsb</STRONG>, indicating that the f1 key is used
- for escape and f2 for control C. (Only certain Superbees have this
+ or control/C characters, has <STRONG>xsb</STRONG>, indicating that the f1 key is used
+ for escape and f2 for control/C. (Only certain Superbees have this
problem, depending on the ROM.) Note that in older terminfo versions,
this capability was called "beehive_glitch"; it is now "no_esc_ctl_c".
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG>printf(3)</STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>.
- <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>. <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>.
+ <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
+ <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>, <STRONG>printf(3)</STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>. <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>. <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG>.
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>