* 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-2000,2002 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2009,2010 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.10 2002/08/17 23:37:10 tom Exp @
+ * @Id: terminfo.head,v 1.18 2010/07/31 16:08:48 tom Exp @
* Head of terminfo man page ends here
- * @Id: terminfo.tail,v 1.38 2003/01/05 22:47:05 tom Exp @
+ * @Id: terminfo.tail,v 1.51 2010/07/31 16:02:40 tom Exp @
* Beginning of terminfo.tail file
+ * This file is part of ncurses.
+ * See "terminfo.head" for copyright.
+ *.in -2
+ *.in +2
+ *.in -2
+ *.in +2
*.TH
-->
<HTML>
<HEAD>
-<TITLE>TERMINFO 5 File Formats</TITLE>
+<TITLE>terminfo 5 File Formats</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1>TERMINFO 5 File Formats</H1>
+<H1>terminfo 5 File Formats</H1>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="TERMINFO.5.html">TERMINFO(5)</A></STRONG> File Formats <STRONG><A HREF="TERMINFO.5.html">TERMINFO(5)</A></STRONG>
+<STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> File Formats <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
libraries such as <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. <EM>Terminfo</EM> describes termi-
nals by giving a set of capabilities which they have, by
specifying how to perform screen operations, and by speci-
- fying padding requirements and initialization sequences.
+ fying padding requirements and initialization sequences.
+ This describes <STRONG>ncurses</STRONG> version 5.7 (patch 20100731).
Entries in <EM>terminfo</EM> consist of a sequence of `,' separated
fields (embedded commas may be escaped with a backslash or
- notated as \054). White space after the `,' separator is
- ignored. The first entry 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 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.
+ notated as \054). White space after the `,' separator is
+ ignored. The first entry 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 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 last should be in lower case and contain
- no blanks; the last name may well contain upper case and
+ no blanks; the last name may well contain upper case and
blanks for readability.
+ Lines beginning with a `#' in the first column are treated
+ as comments. 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 only between entries.
+
+ Newlines and leading tabs may be used for formatting
+ entries for readability. These are removed from parsed
+ entries. The <STRONG>infocmp</STRONG> <STRONG>-f</STRONG> option relies on this to format
+ if-then-else expressions: the result can be read by <STRONG>tic</STRONG>.
+
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, thus ``hp2621''. This name should not contain
+ piece of hardware making 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 pref-
- erences, should be indicated by appending a hyphen and a
- mode suffix. Thus, a vt100 in 132 column mode would be
+ erences, should be indicated by appending a hyphen and a
+ mode suffix. Thus, a vt100 in 132 column mode would be
vt100-w. The following suffixes should be used where pos-
sible:
-rv Reverse video c100-rv
-s Enable status line vt100-s
-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>
+ For more on terminal naming conventions, see the <STRONG>term(7)</STRONG>
manual page.
<STRONG>Capabilities</STRONG>
- The following is a complete table of the capabilities
- included in a terminfo description block and available to
+ 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
+ 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 are chosen to be the same as
+ 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).
+ by ECMA-48, which uses identical or very similar names).
Semantics are also intended to match those of the specifi-
cation.
- The termcap code is the old <STRONG>termcap</STRONG> capability name (some
+ 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 infor-
- mal limit of 5 characters has been adopted to keep them
- short and to allow the tabs in the source file <STRONG>Caps</STRONG> to
+ Capability names have no hard length limit, but an infor-
+ mal 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 capability. You may find some codes in
+ 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
+ #[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
+ (P*) indicates that padding may vary in proportion to
the number of lines affected
(#<EM>i</EM>) indicates the <EM>i</EM>th parameter.
These are the boolean capabilities:
- <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
- <STRONG>Booleans</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
- auto_left_margin bw bw cub1 wraps from col-
+
+ <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
+ <STRONG>Booleans</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
+ auto_left_margin bw bw cub1 wraps from col-
umn 0 to last column
- auto_right_margin am am terminal has auto-
+ auto_right_margin am am terminal has auto-
matic margins
- back_color_erase bce ut screen erased with
+ back_color_erase bce ut screen erased with
background color
- can_change ccc cc terminal can re-
+ can_change ccc cc terminal can re-
define existing col-
ors
- ceol_standout_glitch xhp xs standout not erased
+ ceol_standout_glitch xhp xs standout not erased
by overwriting (hp)
- col_addr_glitch xhpa YA only positive motion
+ col_addr_glitch xhpa YA only positive motion
for hpa/mhpa caps
- cpi_changes_res cpix YF changing character
+
+
+
+ cpi_changes_res cpix YF changing character
pitch changes reso-
lution
- cr_cancels_micro_mode crxm YB using cr turns off
+ cr_cancels_micro_mode crxm YB using cr turns off
micro mode
- dest_tabs_magic_smso xt xt tabs destructive,
+ dest_tabs_magic_smso xt xt tabs destructive,
magic so char
(t1061)
- eat_newline_glitch xenl xn newline ignored
+ eat_newline_glitch xenl xn newline ignored
after 80 cols (con-
cept)
- erase_overstrike eo eo can erase over-
+ erase_overstrike eo eo can erase over-
strikes with a blank
- generic_type gn gn generic line type
- hard_copy hc hc hardcopy terminal
-
- hard_cursor chts HC cursor is hard to
+ generic_type gn gn generic line type
+ hard_copy hc hc hardcopy terminal
+ hard_cursor chts HC cursor is hard to
see
- has_meta_key km km Has a meta key
+ has_meta_key km km Has a meta key
(i.e., sets 8th-bit)
- has_print_wheel daisy YC printer needs opera-
+ has_print_wheel daisy YC printer needs opera-
tor to change char-
acter set
- has_status_line hs hs has extra status
+ has_status_line hs hs has extra status
line
- hue_lightness_saturation hls hl terminal uses only
+ hue_lightness_saturation hls hl terminal uses only
HLS color notation
(Tektronix)
- insert_null_glitch in in insert mode distin-
+ insert_null_glitch in in insert mode distin-
guishes nulls
- lpi_changes_res lpix YG changing line pitch
+ lpi_changes_res lpix YG changing line pitch
changes resolution
- memory_above da da display may be
+ memory_above da da display may be
retained above the
screen
- memory_below db db display may be
+ memory_below db db display may be
retained below the
screen
- move_insert_mode mir mi safe to move while
+ move_insert_mode mir mi safe to move while
in insert mode
- move_standout_mode msgr ms safe to move while
+ move_standout_mode msgr ms safe to move while
in standout mode
- needs_xon_xoff nxon nx padding will not
+ needs_xon_xoff nxon nx padding will not
work, xon/xoff
required
- no_esc_ctlc xsb xb beehive (f1=escape,
+ no_esc_ctlc xsb xb beehive (f1=escape,
f2=ctrl C)
- no_pad_char npc NP pad character does
+ no_pad_char npc NP pad character does
not exist
- non_dest_scroll_region ndscr ND scrolling region is
+ non_dest_scroll_region ndscr ND scrolling region is
non-destructive
- non_rev_rmcup nrrmc NR smcup does not
+ non_rev_rmcup nrrmc NR smcup does not
reverse rmcup
- over_strike os os terminal can over-
+ over_strike os os terminal can over-
strike
- prtr_silent mc5i 5i printer will not
+ prtr_silent mc5i 5i printer will not
echo on screen
- row_addr_glitch xvpa YD only positive motion
+ row_addr_glitch xvpa YD only positive motion
for vpa/mvpa caps
- semi_auto_right_margin sam YE printing in last
+ semi_auto_right_margin sam YE printing in last
column causes cr
- status_line_esc_ok eslok es escape can be used
+ status_line_esc_ok eslok es escape can be used
on the status line
- tilde_glitch hz hz cannot print ~'s
+ tilde_glitch hz hz cannot print ~'s
(hazeltine)
- transparent_underline ul ul underline character
+
+
+ transparent_underline ul ul underline character
overstrikes
- xon_xoff xon xo terminal uses
+ xon_xoff xon xo terminal uses
xon/xoff handshaking
These are the numeric capabilities:
- <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
- <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
- columns cols co number of columns in
+
+ <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
+ <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
+ columns cols co number of columns in
a line
- init_tabs it it tabs initially every
+ init_tabs it it tabs initially every
# spaces
- label_height lh lh rows in each label
- label_width lw lw columns in each
+ label_height lh lh rows in each label
+ label_width lw lw columns in each
label
-
- lines lines li number of lines on
+ lines lines li number of lines on
screen or page
- lines_of_memory lm lm lines of memory if >
+ lines_of_memory lm lm lines of memory if >
line. 0 means varies
- magic_cookie_glitch xmc sg number of blank
+ magic_cookie_glitch xmc sg number of blank
characters left by
smso or rmso
- max_attributes ma ma maximum combined
+ max_attributes ma ma maximum combined
attributes terminal
can handle
- max_colors colors Co maximum number of
+ max_colors colors Co maximum number of
colors on screen
- max_pairs pairs pa maximum number of
+ max_pairs pairs pa maximum number of
color-pairs on the
screen
- maximum_windows wnum MW maximum number of
+ maximum_windows wnum MW maximum number of
defineable windows
- no_color_video ncv NC video attributes
+ no_color_video ncv NC video attributes
that cannot be used
with colors
- num_labels nlab Nl number of labels on
+ num_labels nlab Nl number of labels on
screen
- padding_baud_rate pb pb lowest baud rate
+ padding_baud_rate pb pb lowest baud rate
where padding needed
- virtual_terminal vt vt virtual terminal
+ virtual_terminal vt vt virtual terminal
number (CB/unix)
- width_status_line wsl ws number of columns in
+ 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
+ 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.
- <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
- <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
- bit_image_entwining bitwin Yo number of passes for
+
+ <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
+ <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
+ bit_image_entwining bitwin Yo number of passes for
each bit-image row
- bit_image_type bitype Yp type of bit-image
+ bit_image_type bitype Yp type of bit-image
device
- buffer_capacity bufsz Ya numbers of bytes
+ buffer_capacity bufsz Ya numbers of bytes
buffered before
printing
- buttons btns BT number of buttons on
+ buttons btns BT number of buttons on
mouse
- dot_horz_spacing spinh Yc spacing of dots hor-
+ dot_horz_spacing spinh Yc spacing of dots hor-
izontally in dots
per inch
- dot_vert_spacing spinv Yb spacing of pins ver-
+
+ dot_vert_spacing spinv Yb spacing of pins ver-
tically in pins per
inch
- max_micro_address maddr Yd maximum value in
+ max_micro_address maddr Yd maximum value in
micro_..._address
- max_micro_jump mjump Ye maximum value in
+ max_micro_jump mjump Ye maximum value in
parm_..._micro
- micro_col_size mcs Yf character step size
+ micro_col_size mcs Yf character step size
when in micro mode
- micro_line_size mls Yg line step size when
+ micro_line_size mls Yg line step size when
in micro mode
- number_of_pins npins Yh numbers of pins in
+ number_of_pins npins Yh numbers of pins in
print-head
- output_res_char orc Yi horizontal resolu-
+ output_res_char orc Yi horizontal resolu-
tion in units per
line
-
-
-
- output_res_horz_inch orhi Yk horizontal resolu-
+ output_res_horz_inch orhi Yk horizontal resolu-
tion in units per
inch
- output_res_line orl Yj vertical resolution
+ output_res_line orl Yj vertical resolution
in units per line
- output_res_vert_inch orvi Yl vertical resolution
+ output_res_vert_inch orvi Yl vertical resolution
in units per inch
- print_rate cps Ym print rate in char-
+ print_rate cps Ym print rate in char-
acters per second
- wide_char_size widcs Yn character step size
+ wide_char_size widcs Yn character step size
when in double wide
mode
These are the string capabilities:
+
<STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
<STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
acs_chars acsc ac graphics charset
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
prototype !?
create_window cwin CW define a window #1
from #2,#3 to #4,#5
- cursor_address cup cm move to row #1
- columns #2
+ cursor_address cup cm move to row #1 col-
+ umns #2
cursor_down cud1 do down one line
cursor_home home ho home cursor (if no
cup)
cursor_invisible civis vi make cursor invisi-
ble
-
cursor_left cub1 le move left one space
cursor_mem_address mrcup CM memory relative cur-
sor addressing, move
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
enter_subscript_mode ssubm ZN Enter subscript mode
enter_superscript_mode ssupm ZO Enter superscript
mode
-
enter_underline_mode smul us begin underline mode
enter_upward_mode sum ZP Start upward car-
riage motion
string
init_2string is2 is initialization
string
+
init_3string is3 i3 initialization
string
init_file if if name of initializa-
insert_padding ip ip insert padding after
inserted character
key_a1 ka1 K1 upper left of keypad
-
-
key_a3 ka3 K3 upper right of key-
pad
key_b2 kb2 K2 center of keypad
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_f38 kf38 FS F38 function key
key_f39 kf39 FT F39 function key
key_f4 kf4 k4 F4 function key
-
key_f40 kf40 FU F40 function key
key_f41 kf41 FV F41 function key
key_f42 kf42 FW F42 function 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_sdl kDL *5 shifted delete-line
key
key_select kslt *6 select key
-
key_send kEND *7 shifted end key
key_seol kEOL *8 shifted clear-to-
end-of-line key
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
(8th-bit on)
micro_column_address mhpa ZY Like column_address
in micro mode
-
micro_down mcud1 ZZ Like cursor_down in
micro mode
micro_left mcub1 Za Like cursor_left in
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
quick_dial qdial QD dial number #1 with-
out checking
remove_clock rmclk RC remove clock
-
-
repeat_char rep rp repeat char #1 #2
times (P*)
req_for_input rfi RF send next input char
umn
set_right_margin_parm smgrp Zn Set right margin at
column #1
+
set_tab hts st set a tab in every
row, current columns
set_top_margin smgt Zo Set top margin at
set
stop_bit_image rbim Zs Stop printing bit
image graphics
-
-
stop_char_set_def rcsd Zt End definition of
character set #1
subscript_characters subcs Zu List of subscript-
SVr4.0 term structure, but were originally not documented
in the man page.
+
<STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
<STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
alt_scancode_esc scesa S8 Alternate escape
of same row
bit_image_newline binel Zz Move to next row
of the bit image
+
bit_image_repeat birep Xy Repeat bit image
cell #1 #2 times
char_set_names csnm Zy Produce #1'th item
port
display_pc_char dispc S1 Display PC charac-
ter #1
-
-
end_bit_image_region endbi Yy End a bit-image
region
enter_pc_charset_mode smpch S2 Enter PC character
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
these, they may not be binary-compatible with System V
terminfo entries after SVr4.1; beware!
+
<STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG>
<STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG>
enter_horizontal_hl_mode ehhlm Xh Enter horizontal
highlight mode
-
-
enter_left_hl_mode elhlm Xl Enter left highlight
mode
enter_low_hl_mode elohlm Xo Enter low highlight
to #1 hundredth of
an inch
-
<STRONG>A</STRONG> <STRONG>Sample</STRONG> <STRONG>Entry</STRONG>
The following entry, describing an ANSI-standard terminal,
is representative of what a <STRONG>terminfo</STRONG> entry for a modern
capabilities, which give a sequence which can be used to
perform particular terminal operations.
-
<STRONG>Types</STRONG> <STRONG>of</STRONG> <STRONG>Capabilities</STRONG>
All capabilities have names. For instance, the fact that
ANSI-standard terminals have <EM>automatic</EM> <EM>margins</EM> (i.e., an
To do this, put a period before the capability name. For
example, see the second <STRONG>ind</STRONG> in the example above.
-
<STRONG>Fetching</STRONG> <STRONG>Compiled</STRONG> <STRONG>Descriptions</STRONG>
If the environment variable TERMINFO is set, it is inter-
preted as the pathname of a directory containing the com-
variable as a list of colon- separated directories to be
searched (an empty entry is interpreted as a command to
search <EM>/usr/share/terminfo</EM>). If no description is found
- in any of the TERMINFO_DIRS directories, the fetch fails.
+ in any of the TERMINFO_DIRS directories, the fetch fails.
- If neither TERMINFO nor TERMINFO_DIRS is set, the last
- place tried will be the system terminfo directory,
+ If neither TERMINFO nor TERMINFO_DIRS is set, the last
+ place tried will be the system terminfo directory,
<EM>/usr/share/terminfo</EM>.
- (Neither the <STRONG>$HOME/.terminfo</STRONG> lookups nor TERMINFO_DIRS
- extensions are supported under stock System V ter-
+ (Neither the <STRONG>$HOME/.terminfo</STRONG> lookups nor TERMINFO_DIRS
+ extensions are supported under stock System V ter-
minfo/curses.)
-
<STRONG>Preparing</STRONG> <STRONG>Descriptions</STRONG>
- 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
+ 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
+ program to check that they are correct. Be aware that a
very unusual terminal may expose deficiencies in the abil-
- ity of the <EM>terminfo</EM> file to describe it or bugs in the
+ ity 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
+ 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 usu-
- ally needed. A similar test can be used for insert char-
+ 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 usu-
+ ally needed. A similar test can be used for insert char-
acter.
-
<STRONG>Basic</STRONG> <STRONG>Capabilities</STRONG>
- 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 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 mar-
+ beginning of the next line when it reaches the right mar-
gin, then it should have the <STRONG>am</STRONG> capability. If the termi-
- nal can clear its screen, leaving the cursor in the home
- position, then this is given by the <STRONG>clear</STRONG> string capabil-
- ity. If the terminal overstrikes (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
+ nal can clear its screen, leaving the cursor in the home
+ position, then this is given by the <STRONG>clear</STRONG> string capabil-
+ ity. If the terminal overstrikes (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 cursor to the left edge of the
current row, give this as <STRONG>cr</STRONG>. (Normally this will be car-
- riage return, control M.) If there is a code to produce
+ riage return, control M.) If there is a code to produce
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
+ 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
+ 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. Programs should never
- attempt to backspace around the left edge, unless <STRONG>bw</STRONG> is
+ 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. 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
+ 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
"glass-tty" terminals. Thus the model 33 teletype is
described as
- 33|tty33|tty|model 33 teletype,
- bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os,
+ 33|tty33|tty|model 33 teletype,
+ bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os,
while the Lear Siegler ADM-3 is described as
- adm3|3|lsi adm3,
- am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J,
- ind=^J, lines#24,
-
+ adm3|3|lsi adm3,
+ am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J,
+ ind=^J, lines#24,
<STRONG>Parameterized</STRONG> <STRONG>Strings</STRONG>
Cursor addressing and other strings requiring parameters
in the terminal are described by a parameterized string
- capability, with <STRONG><A HREF="printf.3S.html">printf(3S)</A></STRONG> like escapes <STRONG>%x</STRONG> in it. For
+ capability, with <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG> like escapes <STRONG>%x</STRONG> 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>%</STRONG> encodings have the following meanings:
-
%% outputs `%'
%<EM>[[</EM>:<EM>]flags][width[.precision]][</EM>doxXs<EM>]</EM>
- as in <STRONG>printf</STRONG>, flags are [-+#] and space
+ as in <STRONG>printf</STRONG>, flags are [-+#] and space. Use a `:'
+ to allow the next character to be a `-' flag, avoid-
+ ing interpreting "%-" as an operator.
%c print pop() like %c in <STRONG>printf</STRONG>
arithmetic (%m is mod): push(pop() op pop())
%& %| %^
- bit operations: push(pop() op pop())
+ bit operations (AND, OR and exclusive-OR): push(pop()
+ op pop())
%= %> %<
logical operations: push(pop() op pop())
%A, %O
- logical and & or operations (for conditionals)
+ logical AND and OR operations (for conditionals)
%! %~
- unary operations push(op pop())
+ unary operations (logical and bit complement):
+ push(op pop())
%i add 1 to first two parameters (for ANSI terminals)
%? <EM>expr</EM> %t <EM>thenpart</EM> %e <EM>elsepart</EM> %;
- if-then-else, %e <EM>elsepart</EM> is optional. else-if's are
- possible a la Algol 68:
+ This forms an if-then-else. The %e <EM>elsepart</EM> is
+ optional. Usually the %? <EM>expr</EM> part pushes a value
+ onto the stack, and %t pops it from the stack, test-
+ ing if it is nonzero (true). If it is zero (false),
+ control passes to the %e (else) part.
+
+ It is possible to form else-if's a la Algol 68:
%? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %;
- ci are conditions, bi are bodies.
+
+ where ci are conditions, bi are bodies.
+
+ Use the <STRONG>-f</STRONG> option of <STRONG>tic</STRONG> or <STRONG>infocmp</STRONG> to see the struc-
+ ture 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 with the parts
+ indented.
Binary operations are in postfix form with the operands in
the usual order. That is, to get x-5 one would use
its. 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
+ 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
+ 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 col-
umn 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 space (32),
- adds them (pushing the sum on the stack in place of the
- two previous values) and outputs that value as a charac-
- ter. Then the same is done for the second parameter.
+ '%+%c%p2%' '%+%c". After sending `\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 charac-
+ ter. Then the same is done for the second parameter.
More complex arithmetic is possible using the stack.
-
<STRONG>Cursor</STRONG> <STRONG>Motions</STRONG>
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
+ 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 corner of the screen,
- not of memory. (Thus, the \EH sequence on HP terminals
+ not of memory. (Thus, the \EH sequence on HP terminals
cannot be used for <STRONG>home</STRONG>.)
If the terminal has row or column absolute cursor address-
- ing, these can be given as single parameter capabilities
+ ing, these can be given as single parameter capabilities
<STRONG>hpa</STRONG> (horizontal position absolute) and <STRONG>vpa</STRONG> (vertical posi-
tion absolute). Sometimes these are shorter than the more
- general two parameter sequence (as with the hp2645) and
+ 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)
+ 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
+ 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 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 has only
- memory relative cursor addressing and not screen relative
+ 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 has only
+ memory relative cursor addressing and not screen relative
cursor addressing, a one screen-sized window must be fixed
- into the terminal for cursor addressing to work properly.
+ into the terminal 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
+ 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>.
-
<STRONG>Area</STRONG> <STRONG>Clears</STRONG>
If the terminal can clear from the current position to the
- end of the line, leaving the cursor where it is, this
+ 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
+ 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 available.)
-
<STRONG>Insert/delete</STRONG> <STRONG>line</STRONG> <STRONG>and</STRONG> <STRONG>vertical</STRONG> <STRONG>motions</STRONG>
- 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
+ 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
+ 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 takes two parameters: the top and
+ 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
+ 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) commands 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
+ and restore cursor) commands 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 combination of index with the memory-lock feature
- found on some terminals (like the HP-700/90 series, which
+ use a combination 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, and is often faster even on ter-
+ 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 ter-
minals with those features.
- The boolean <STRONG>non_dest_scroll_region</STRONG> should be set if each
- scrolling window 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 some-
- thing to the bottom line, move the cursor to the top of
+ The boolean <STRONG>non_dest_scroll_region</STRONG> should be set if each
+ scrolling window 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 some-
+ thing 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 simu-
- late destructive scrolling; their documentation cautions
- you not to define <STRONG>csr</STRONG> unless this is true. This <STRONG>curses</STRONG>
+ 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 simu-
+ late 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>ndstr</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
+ 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
+ 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
+ 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
bring down non-blank lines.
-
<STRONG>Insert/Delete</STRONG> <STRONG>Character</STRONG>
- 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 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 terminal you have by clearing the
- screen and then typing text separated by cursor motions.
- Type "abc def" using local cursor motions (not spaces)
+ 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 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 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
+ 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 ter-
- minal 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 second type of
- terminal, and should give the capability <STRONG>in</STRONG>, which stands
+ minal 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 second 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 ter-
+ attributes (one line versus multi-line insert mode, and
+ special treatment of untyped spaces) we have seen no ter-
minals whose insert mode cannot be described with the sin-
gle attribute.
- Terminfo can describe both terminals which have an insert
+ 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
+ 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 charac-
- ter to be inserted. Most terminals with a true insert
- mode will not give <STRONG>ich1</STRONG>; terminals which send a sequence
+ ter 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 prefer-
- able 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
+ If your terminal has both, insert mode is usually prefer-
+ able 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
+ 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
+ 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 after an insert of a single
+ milliseconds 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>
+ 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 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
+ in insert mode, give this as a number of milliseconds pad-
+ ding 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 works.
- Finally, you can specify <STRONG>dch1</STRONG> to delete a single charac-
- ter, <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
+ Finally, you can specify <STRONG>dch1</STRONG> to delete a single charac-
+ ter, <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 without moving the cursor) can be given as <STRONG>ech</STRONG>
+ 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.
-
<STRONG>Highlighting,</STRONG> <STRONG>Underlining,</STRONG> <STRONG>and</STRONG> <STRONG>Visible</STRONG> <STRONG>Bells</STRONG>
If your terminal has one or more kinds of display
- attributes, these can be represented in a number of dif-
+ attributes, these can be represented in a number of dif-
ferent ways. You should choose one display form as <EM>stand-</EM>
<EM>out</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,
+ 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 spa-
+ ces 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
For example, the DEC vt220 supports most of the modes:
- <STRONG>tparm</STRONG> <STRONG>parameter</STRONG> <STRONG>attribute</STRONG> <STRONG>escape</STRONG> <STRONG>sequence</STRONG>
+ <STRONG>tparm</STRONG> <STRONG>parameter</STRONG> <STRONG>attribute</STRONG> <STRONG>escape</STRONG> <STRONG>sequence</STRONG>
- none none \E[0m
- p1 standout \E[0;1;7m
- p2 underline \E[0;4m
-
- p3 reverse \E[0;7m
- p4 blink \E[0;5m
- p5 dim not available
- p6 bold \E[0;1m
- p7 invis \E[0;8m
- p8 protect not used
- p9 altcharset ^O (off) ^N (on)
+ none none \E[0m
+ p1 standout \E[0;1;7m
+ p2 underline \E[0;4m
+ p3 reverse \E[0;7m
+ p4 blink \E[0;5m
+ p5 dim not available
+ p6 bold \E[0;1m
+ p7 invis \E[0;8m
+ 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
Writing out the above sequences, along with their depen-
dencies yields
- <STRONG>sequence</STRONG> <STRONG>when</STRONG> <STRONG>to</STRONG> <STRONG>output</STRONG> <STRONG>terminfo</STRONG> <STRONG>translation</STRONG>
+ <STRONG>sequence</STRONG> <STRONG>when</STRONG> <STRONG>to</STRONG> <STRONG>output</STRONG> <STRONG>terminfo</STRONG> <STRONG>translation</STRONG>
- \E[0 always \E[0
- ;1 if p1 or p6 %?%p1%p6%|%t;1%;
- ;4 if p2 %?%p2%|%t;4%;
- ;5 if p4 %?%p4%|%t;5%;
- ;7 if p1 or p3 %?%p1%p3%|%t;7%;
- ;8 if p7 %?%p7%|%t;8%;
- m always m
- ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%;
+ \E[0 always \E[0
+ ;1 if p1 or p6 %?%p1%p6%|%t;1%;
+ ;4 if p2 %?%p2%|%t;4%;
+ ;5 if p4 %?%p4%|%t;5%;
+ ;7 if p1 or p3 %?%p1%p3%|%t;7%;
+ ;8 if p7 %?%p7%|%t;8%;
+ m always m
+ ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%;
Putting this all together into the sgr sequence gives:
%?%p4%t;5%;%?%p7%t;8%;m%?%p9%t\016%e\017%;,
Remember that if you specify sgr, you must also specify
- sgr0.
+ sgr0. Also, some implementations rely on sgr being given
+ if sgr0 is, Not all terminfo 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 ``cookies'' when they receive mode-setting
erasable with a blank, then this should be indicated by
giving <STRONG>eo</STRONG>.
-
<STRONG>Keypad</STRONG> <STRONG>and</STRONG> <STRONG>Function</STRONG> <STRONG>Keys</STRONG>
If the terminal has a keypad that transmits codes when the
keys are pressed, this information can be given. Note
or more pln sequences to make sure that the change becomes
visible.
-
<STRONG>Tabs</STRONG> <STRONG>and</STRONG> <STRONG>Initialization</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
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 pre-
- sent, since the user may not have the tab stops properly
- set. If the terminal has hardware tabs which are ini-
- tially 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
- <EM>tset</EM> command to determine whether to set the mode for
+ 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 prop-
+ erly 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 <EM>tset</EM> 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
consistent with the rest of the terminfo description.
They are normally sent to the terminal, by the <EM>init</EM> option
of the <EM>tput</EM> 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>; set the margins using <STRONG>mgc</STRONG>, <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>.
+ will be printed in the following order:
+
+ run the program
+ <STRONG>iprog</STRONG>
+
+ output <STRONG>is1</STRONG> <STRONG>is2</STRONG>
+
+ set the margins using
+ <STRONG>mgc</STRONG>, <STRONG>smgl</STRONG> and <STRONG>smgr</STRONG>
+
+ set tabs using
+ <STRONG>tbc</STRONG> and <STRONG>hts</STRONG>
+
+ print the file
+ <STRONG>if</STRONG>
- Most initialization is done with <STRONG>is2</STRONG>. Special terminal
+ 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 <STRONG>is2</STRONG> and special cases in <STRONG>is1</STRONG> and
- <STRONG>is3</STRONG>. A pair of sequences that does a harder reset from a
- totally unknown state can be analogously given as <STRONG>rs1</STRONG>,
- <STRONG>rs2</STRONG>, <STRONG>rf</STRONG>, and <STRONG>rs3</STRONG>, analogous to <STRONG>is2</STRONG> and <STRONG>if</STRONG>. These strings
- are output by the <EM>reset</EM> 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 annoy-
- ing effects on the screen and are not necessary when log-
- ging 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 nor-
- mally needed since the terminal is usually already in 80
- column mode.
+ the common sequences in <STRONG>is2</STRONG> and special cases in <STRONG>is1</STRONG> and
+ <STRONG>is3</STRONG>.
+
+ 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>, analo-
+ gous 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 <EM>reset</EM> 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 pro-
+ duce 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 <EM>reset</EM> 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 any of <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, or <STRONG>rf</STRONG> reset
+ capability strings are missing, the <EM>reset</EM> program falls
+ back upon the corresponding initialization capability
+ string.
If there are commands to set and clear tab stops, they can
be given as <STRONG>tbc</STRONG> (clear all tab stops) and <STRONG>hts</STRONG> (set a tab
<STRONG>if</STRONG>.
<STRONG>Delays</STRONG> <STRONG>and</STRONG> <STRONG>Padding</STRONG>
- Many older and slower terminals don't support either
+ Many older and slower terminals do not support either
XON/XOFF or DTR handshaking, including hard copy terminals
and some very archaic CRTs (including, for example, DEC
VT100s). These may require padding characters after cer-
its input buffers are close to full), set <STRONG>xon</STRONG>. This capa-
bility suppresses the emission of padding. You can also
set it for memory-mapped console devices effectively that
- don't have a speed limit. Padding information should
+ do not have a speed limit. Padding information should
still be included so that routines can make better deci-
sions about relative costs, but actual pad characters will
not be transmitted.
ter as a pad, then this can be given as <STRONG>pad</STRONG>. Only the
first character of the <STRONG>pad</STRONG> string is used.
-
<STRONG>Status</STRONG> <STRONG>Lines</STRONG>
Some terminals have an extra `status line' which is not
normally used by software (and thus not counted in the
The boolean capability <STRONG>eslok</STRONG> specifies that escape
sequences, tabs, etc., work ordinarily in the status line.
- The <STRONG>ncurses</STRONG> implementation does not yet use any of these
- capabilities. They are documented here in case they ever
+ The <STRONG>ncurses</STRONG> implementation does not yet use any of these
+ capabilities. They are documented here in case they ever
become important.
-
<STRONG>Line</STRONG> <STRONG>Graphics</STRONG>
- Many terminals have alternate character sets useful for
- forms-drawing. Terminfo and <STRONG>curses</STRONG> build in support for
- the drawing characters supported by the VT100, with some
- characters from the AT&T 4410v1 added. This alternate
+ Many terminals have alternate character sets useful for
+ forms-drawing. Terminfo and <STRONG>curses</STRONG> build in support for
+ the drawing characters supported by the VT100, with some
+ characters from the AT&T 4410v1 added. This alternate
character set may be specified by the <STRONG>acsc</STRONG> capability.
- <STRONG>Glyph</STRONG> <STRONG>ACS</STRONG> <STRONG>Ascii</STRONG> <STRONG>VT100</STRONG>
- <STRONG>Name</STRONG> <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Name</STRONG>
- UK pound sign ACS_STERLING f }
- arrow pointing down ACS_DARROW v .
- arrow pointing left ACS_LARROW < ,
- arrow pointing right ACS_RARROW > +
- arrow pointing up ACS_UARROW ^ -
- board of squares ACS_BOARD # h
- bullet ACS_BULLET o ~
- checker board (stipple) ACS_CKBOARD : a
- degree symbol ACS_DEGREE \ f
-
- diamond ACS_DIAMOND + `
- greater-than-or-equal-to ACS_GEQUAL > z
- greek pi ACS_PI * {
- horizontal line ACS_HLINE - q
- lantern symbol ACS_LANTERN # i
- large plus or crossover ACS_PLUS + n
- less-than-or-equal-to ACS_LEQUAL < y
- lower left corner ACS_LLCORNER + m
- lower right corner ACS_LRCORNER + j
- not-equal ACS_NEQUAL ! |
- plus/minus ACS_PLMINUS # g
- scan line 1 ACS_S1 ~ o
- scan line 3 ACS_S3 - p
- scan line 7 ACS_S7 - r
- scan line 9 ACS_S9 _ s
- solid square block ACS_BLOCK # 0
- tee pointing down ACS_TTEE + w
- tee pointing left ACS_RTEE + u
- tee pointing right ACS_LTEE + t
- tee pointing up ACS_BTEE + v
- upper left corner ACS_ULCORNER + l
- upper right corner ACS_URCORNER + k
- vertical line ACS_VLINE | x
-
- The best way to define a new device's graphics set is to
- add a column to a copy of this table for your terminal,
- giving the character which (when emitted between
- <STRONG>smacs</STRONG>/<STRONG>rmacs</STRONG> switches) will be rendered as the correspond-
- ing graphic. Then read off the VT100/your terminal char-
- acter pairs right to left in sequence; these become the
+ <STRONG>Glyph</STRONG> <STRONG>ACS</STRONG> <STRONG>Ascii</STRONG> <STRONG>VT100</STRONG>
+ <STRONG>Name</STRONG> <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Name</STRONG>
+ UK pound sign ACS_STERLING f }
+ arrow pointing down ACS_DARROW v .
+ arrow pointing left ACS_LARROW < ,
+ arrow pointing right ACS_RARROW > +
+ arrow pointing up ACS_UARROW ^ -
+ board of squares ACS_BOARD # h
+ bullet ACS_BULLET o ~
+ checker board (stipple) ACS_CKBOARD : a
+ degree symbol ACS_DEGREE \ f
+ diamond ACS_DIAMOND + `
+ greater-than-or-equal-to ACS_GEQUAL > z
+ greek pi ACS_PI * {
+ horizontal line ACS_HLINE - q
+ lantern symbol ACS_LANTERN # i
+ large plus or crossover ACS_PLUS + n
+ less-than-or-equal-to ACS_LEQUAL < y
+ lower left corner ACS_LLCORNER + m
+ lower right corner ACS_LRCORNER + j
+ not-equal ACS_NEQUAL ! |
+ plus/minus ACS_PLMINUS # g
+ scan line 1 ACS_S1 ~ o
+ scan line 3 ACS_S3 - p
+ scan line 7 ACS_S7 - r
+ scan line 9 ACS_S9 _ s
+ solid square block ACS_BLOCK # 0
+ tee pointing down ACS_TTEE + w
+ tee pointing left ACS_RTEE + u
+ tee pointing right ACS_LTEE + t
+ tee pointing up ACS_BTEE + v
+ upper left corner ACS_ULCORNER + l
+
+ upper right corner ACS_URCORNER + k
+ vertical line ACS_VLINE | x
+
+ The best way to define a new device's graphics set is to
+ add a column to a copy of this table for your terminal,
+ giving the character which (when emitted between
+ <STRONG>smacs</STRONG>/<STRONG>rmacs</STRONG> switches) will be rendered as the correspond-
+ ing graphic. Then read off the VT100/your terminal char-
+ acter pairs right to left in sequence; these become the
ACSC string.
-
<STRONG>Color</STRONG> <STRONG>Handling</STRONG>
- Most color terminals are either `Tektronix-like' or `HP-
- like'. Tektronix-like terminals have a predefined set of
- N colors (where N usually 8), and can set character-cell
+ Most color terminals are either `Tektronix-like' or `HP-
+ like'. Tektronix-like terminals have a predefined set of
+ N colors (where N usually 8), and can set character-cell
foreground and background characters independently, mixing
- them into N * N color-pairs. On HP-like terminals, the
+ them into N * N color-pairs. On HP-like terminals, the
use must set each color pair up separately (foreground and
- background are not independently settable). Up to M
- color-pairs may be set up from 2*M different colors.
+ background are not independently settable). Up to M
+ color-pairs may be set up from 2*M different colors.
ANSI-compatible terminals are Tektronix-like.
Some basic color capabilities are independent of the color
method. The numeric capabilities <STRONG>colors</STRONG> and <STRONG>pairs</STRONG> specify
- the maximum numbers of colors and color-pairs that can be
- displayed simultaneously. The <STRONG>op</STRONG> (original pair) string
- resets foreground and background colors to their default
- values for the terminal. The <STRONG>oc</STRONG> string resets all colors
- or color-pairs to their default values for the terminal.
- Some terminals (including many PC terminal emulators)
- erase screen areas with the current background color
- rather than the power-up default background; these should
+ the maximum numbers of colors and color-pairs that can be
+ displayed simultaneously. The <STRONG>op</STRONG> (original pair) string
+ resets foreground and background colors to their default
+ values for the terminal. The <STRONG>oc</STRONG> string resets all colors
+ or color-pairs to their default values for the terminal.
+ Some terminals (including many PC terminal emulators)
+ erase screen areas with the current background color
+ rather than the power-up default background; these should
have the boolean capability <STRONG>bce</STRONG>.
- To change the current foreground or background color on a
- Tektronix-type terminal, use <STRONG>setaf</STRONG> (set ANSI foreground)
- and <STRONG>setab</STRONG> (set ANSI background) or <STRONG>setf</STRONG> (set foreground)
- and <STRONG>setb</STRONG> (set background). These take one parameter, the
+ To change the current foreground or background color on a
+ Tektronix-type terminal, use <STRONG>setaf</STRONG> (set ANSI foreground)
+ and <STRONG>setab</STRONG> (set ANSI background) or <STRONG>setf</STRONG> (set foreground)
+ and <STRONG>setb</STRONG> (set background). These take one parameter, the
color number. The SVr4 documentation describes only
- <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>; the XPG4 draft says that "If the terminal
+ <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>; the XPG4 draft says that "If the terminal
supports ANSI escape sequences to set background and fore-
- ground, they should be coded as <STRONG>setaf</STRONG> and <STRONG>setab</STRONG>, respec-
- tively. If the terminal supports other escape sequences
- to set background and foreground, they should be coded as
- <STRONG>setf</STRONG> and <STRONG>setb</STRONG>, respectively. The <EM>vidputs()</EM> function and
- the refresh functions use <STRONG>setaf</STRONG> and <STRONG>setab</STRONG> if they are
+ ground, they should be coded as <STRONG>setaf</STRONG> and <STRONG>setab</STRONG>, respec-
+ tively. If the terminal supports other escape sequences
+ to set background and foreground, they should be coded as
+ <STRONG>setf</STRONG> and <STRONG>setb</STRONG>, respectively. The <EM>vidputs()</EM> function and
+ the refresh functions use <STRONG>setaf</STRONG> and <STRONG>setab</STRONG> if they are
defined."
- The <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> and <STRONG>setf</STRONG>/<STRONG>setb</STRONG> capabilities take a single
+ The <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> and <STRONG>setf</STRONG>/<STRONG>setb</STRONG> capabilities take a single
numeric argument each. Argument values 0-7 of <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>
- are portably defined as follows (the middle column is the
+ are portably defined as follows (the middle column is the
symbolic #define available in the header for the <STRONG>curses</STRONG> or
- <STRONG>ncurses</STRONG> libraries). The terminal hardware is free to map
- these as it likes, but the RGB values indicate normal
+ <STRONG>ncurses</STRONG> libraries). The terminal hardware is free to map
+ these as it likes, but the RGB values indicate normal
locations in color space.
<STRONG>Color</STRONG> <STRONG>#define</STRONG> <STRONG>Value</STRONG> <STRONG>RGB</STRONG>
cyan <STRONG>COLOR_CYAN</STRONG> 6 0,max,max
white <STRONG>COLOR_WHITE</STRONG> 7 max,max,max
- The argument values of <STRONG>setf</STRONG>/<STRONG>setb</STRONG> historically correspond
+ The argument values of <STRONG>setf</STRONG>/<STRONG>setb</STRONG> historically correspond
to a different mapping, i.e.,
+
<STRONG>Color</STRONG> <STRONG>#define</STRONG> <STRONG>Value</STRONG> <STRONG>RGB</STRONG>
black <STRONG>COLOR_BLACK</STRONG> 0 0, 0, 0
blue <STRONG>COLOR_BLUE</STRONG> 1 0,0,max
yellow <STRONG>COLOR_YELLOW</STRONG> 6 max,max,0
white <STRONG>COLOR_WHITE</STRONG> 7 max,max,max
It is important to not confuse the two sets of color capa-
- bilities; otherwise red/blue will be interchanged on the
+ bilities; otherwise red/blue will be interchanged on the
display.
- On an HP-like terminal, use <STRONG>scp</STRONG> with a color-pair number
+ On an HP-like terminal, use <STRONG>scp</STRONG> with a color-pair number
parameter to set which color pair is current.
- On a Tektronix-like terminal, the capability <STRONG>ccc</STRONG> may be
- present to indicate that colors can be modified. If so,
+ On a Tektronix-like terminal, the capability <STRONG>ccc</STRONG> may be
+ present to indicate that colors can be modified. If so,
the <STRONG>initc</STRONG> capability will take a color number (0 to <STRONG>colors</STRONG>
- - 1)and three more parameters which describe the color.
+ - 1)and three more parameters which describe the color.
These three parameters default to being interpreted as RGB
- (Red, Green, Blue) values. If the boolean capability <STRONG>hls</STRONG>
+ (Red, Green, Blue) values. If the boolean capability <STRONG>hls</STRONG>
is present, they are instead as HLS (Hue, Lightness, Satu-
ration) indices. The ranges are terminal-dependent.
- On an HP-like terminal, <STRONG>initp</STRONG> may give a capability for
- changing a color-pair value. It will take seven parame-
- ters; a color-pair number (0 to <STRONG>max_pairs</STRONG> - 1), and two
- triples describing first background and then foreground
- colors. These parameters must be (Red, Green, Blue) or
+ On an HP-like terminal, <STRONG>initp</STRONG> may give a capability for
+ changing a color-pair value. It will take seven parame-
+ ters; a color-pair number (0 to <STRONG>max_pairs</STRONG> - 1), and two
+ triples describing first background and then foreground
+ colors. These parameters must be (Red, Green, Blue) or
(Hue, Lightness, Saturation) depending on <STRONG>hls</STRONG>.
- On some color terminals, colors collide with highlights.
+ On some color terminals, colors collide with highlights.
You can register these collisions with the <STRONG>ncv</STRONG> capability.
- This is a bit-mask of attributes not to be used when col-
- ors are enabled. The correspondence with the attributes
+ This is a bit-mask of attributes not to be used when col-
+ ors are enabled. The correspondence with the attributes
understood by <STRONG>curses</STRONG> is as follows:
- <STRONG>Attribute</STRONG> <STRONG>Bit</STRONG> <STRONG>Decimal</STRONG>
- A_STANDOUT 0 1
- A_UNDERLINE 1 2
-
- A_REVERSE 2 4
- A_BLINK 3 8
- A_DIM 4 16
- A_BOLD 5 32
- A_INVIS 6 64
- A_PROTECT 7 128
- A_ALTCHARSET 8 256
-
- For example, on many IBM PC consoles, the underline
- attribute collides with the foreground color blue and is
- not available in color mode. These should have an <STRONG>ncv</STRONG>
+ <STRONG>Attribute</STRONG> <STRONG>Bit</STRONG> <STRONG>Decimal</STRONG>
+ A_STANDOUT 0 1
+ A_UNDERLINE 1 2
+ A_REVERSE 2 4
+ A_BLINK 3 8
+ A_DIM 4 16
+ A_BOLD 5 32
+ A_INVIS 6 64
+ A_PROTECT 7 128
+ A_ALTCHARSET 8 256
+
+ For example, on many IBM PC consoles, the underline
+ attribute collides with the foreground color blue and is
+ not available in color mode. These should have an <STRONG>ncv</STRONG>
capability of 2.
- SVr4 curses does nothing with <STRONG>ncv</STRONG>, ncurses recognizes it
+ SVr4 curses does nothing with <STRONG>ncv</STRONG>, ncurses recognizes it
and optimizes the output in favor of colors.
-
<STRONG>Miscellaneous</STRONG>
- If the terminal requires other than a null (zero) charac-
- ter as a pad, then this can be given as pad. Only the
- first character of the pad string is used. If the termi-
+ If the terminal requires other than a null (zero) charac-
+ ter as a pad, then this can be given as pad. Only the
+ first character of the pad string is used. If the termi-
nal does not have a pad character, specify npc. Note that
- ncurses implements the termcap-compatible <STRONG>PC</STRONG> variable;
- though the application may set this value to something
- other than a null, ncurses will test <STRONG>npc</STRONG> first and use
+ ncurses implements the termcap-compatible <STRONG>PC</STRONG> variable;
+ though the application may set this value to something
+ other than a null, ncurses will test <STRONG>npc</STRONG> first and use
napms if the terminal has no pad character.
- If the terminal can move up or down half a line, this can
- be indicated with <STRONG>hu</STRONG> (half-line up) and <STRONG>hd</STRONG> (half-line
+ If the terminal can move up or down half a line, this can
+ be indicated with <STRONG>hu</STRONG> (half-line up) and <STRONG>hd</STRONG> (half-line
down). This is primarily useful for superscripts and sub-
- scripts on hard-copy terminals. If a hard-copy terminal
- can eject to the next page (form feed), give this as <STRONG>ff</STRONG>
+ scripts 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).
- 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 <STRONG>rep</STRONG>. The first parameter is the
- character to be repeated and the second is the number of
- times to repeat it. Thus, tparm(repeat_char, 'x', 10) is
+ 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 <STRONG>rep</STRONG>. The first parameter is the
+ character to be repeated and the second is the number of
+ times to repeat it. Thus, tparm(repeat_char, 'x', 10) is
the same as `xxxxxxxxxx'.
- If the terminal has a settable command character, such as
- the TEKTRONIX 4025, this can be indicated with <STRONG>cmdch</STRONG>. A
+ If the terminal has a settable command character, such as
+ the TEKTRONIX 4025, this can be indicated with <STRONG>cmdch</STRONG>. A
prototype command character is chosen which is used in all
- capabilities. This character is given in the <STRONG>cmdch</STRONG> capa-
- bility to identify it. The following convention is sup-
- ported on some UNIX systems: The environment is to be
- searched for a <STRONG>CC</STRONG> variable, and if found, all occurrences
+ capabilities. This character is given in the <STRONG>cmdch</STRONG> capa-
+ bility to identify it. The following convention is sup-
+ ported on some UNIX systems: The environment is to be
+ searched for a <STRONG>CC</STRONG> variable, and if found, all occurrences
of the prototype character are replaced with the character
in the environment variable.
- Terminal descriptions that do not represent a specific
+ Terminal descriptions that do not represent a specific
kind of known terminal, such as <EM>switch</EM>, <EM>dialup</EM>, <EM>patch</EM>, and
- <EM>network</EM>, should include the <STRONG>gn</STRONG> (generic) capability so
- that programs can complain that they do not know how to
- talk to the terminal. (This capability does not apply to
- <EM>virtual</EM> terminal descriptions for which the escape
+ <EM>network</EM>, should include the <STRONG>gn</STRONG> (generic) capability so
+ that programs can complain that they do not know how to
+ talk to the terminal. (This capability does not apply to
+ <EM>virtual</EM> terminal descriptions for which the escape
sequences are known.)
- If the terminal has a ``meta key'' which acts as a shift
- key, setting the 8th bit of any character transmitted,
- this fact can be indicated with <STRONG>km</STRONG>. Otherwise, software
+ If the terminal has a ``meta key'' which acts as a shift
+ key, setting the 8th bit of any character transmitted,
+ this fact can be indicated with <STRONG>km</STRONG>. Otherwise, software
will assume that the 8th bit is parity and it will usually
- be cleared. If strings exist to turn this ``meta mode''
+ be cleared. If strings exist to turn this ``meta mode''
on and off, they can be given as <STRONG>smm</STRONG> and <STRONG>rmm</STRONG>.
- 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 <STRONG>lm</STRONG>. A value of <STRONG>lm</STRONG>#0 indicates that the
+ 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 <STRONG>lm</STRONG>. A value of <STRONG>lm</STRONG>#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 vir-
- tual terminal protocol, the terminal number can be given
+ tual terminal protocol, the terminal number can be given
as <STRONG>vt</STRONG>.
Media copy strings which control an auxiliary printer con-
nected to the terminal can be given as <STRONG>mc0</STRONG>: print the con-
- tents of the screen, <STRONG>mc4</STRONG>: turn off the printer, and <STRONG>mc5</STRONG>:
- turn on the printer. When the printer is on, all text
- sent to the terminal will be sent to the printer. It is
+ tents of the screen, <STRONG>mc4</STRONG>: turn off the printer, and <STRONG>mc5</STRONG>:
+ 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 termi-
nal screen when the printer is on. A variation <STRONG>mc5p</STRONG> takes
one parameter, and leaves the printer on for as many char-
- acters as the value of the parameter, then turns the
- printer off. The parameter should not exceed 255. All
+ acters as the value of the parameter, then turns the
+ printer off. The parameter should not exceed 255. All
text, including <STRONG>mc4</STRONG>, is transparently passed to the
printer while an <STRONG>mc5p</STRONG> is in effect.
-
<STRONG>Glitches</STRONG> <STRONG>and</STRONG> <STRONG>Braindamage</STRONG>
- Hazeltine terminals, which do not allow `~' characters to
+ Hazeltine terminals, which do not allow `~' characters to
be displayed should indicate <STRONG>hz</STRONG>.
Terminals which ignore a line-feed immediately after an <STRONG>am</STRONG>
Other specific terminal problems may be corrected by
adding more capabilities of the form <STRONG>x</STRONG><EM>x</EM>.
-
<STRONG>Similar</STRONG> <STRONG>Terminals</STRONG>
If there are two very similar terminals, one (the variant)
can be defined as being just like the other (the base)
the use reference that imports it, where <EM>xx</EM> is the capa-
bility. For example, the entry
- 2621-nl, smkx@, rmkx@, use=2621,
+ 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 user preferences.
-
<STRONG>Pitfalls</STRONG> <STRONG>of</STRONG> <STRONG>Long</STRONG> <STRONG>Entries</STRONG>
Long terminfo entries are unlikely to be a problem; to
- date, no entry has even approached terminfo's 4K string-
- table maximum. Unfortunately, the termcap translations
- are much more strictly limited (to 1K), thus termcap
- translations of long terminfo entries can cause problems.
-
- The man pages for 4.3BSD and older versions of tgetent()
- instruct the user to allocate a 1K buffer for the termcap
- entry. The entry gets null-terminated by the termcap
- library, so that makes the maximum safe length for a term-
- cap entry 1k-1 (1023) bytes. Depending on what the appli-
- cation and the termcap library being used does, and where
- in the termcap file the terminal type that tgetent() is
- searching for is, several bad things can happen.
+ date, no entry has even approached terminfo's 4096-byte
+ string-table maximum. Unfortunately, the termcap transla-
+ tions are much more strictly limited (to 1023 bytes), thus
+ termcap translations of long terminfo entries can cause
+ problems.
+
+ The man pages for 4.3BSD and older versions of <STRONG>tgetent()</STRONG>
+ instruct the user to allocate a 1024-byte buffer for the
+ termcap entry. The entry gets null-terminated by the
+ termcap library, so that makes the maximum safe length for
+ a termcap entry 1k-1 (1023) bytes. Depending on what the
+ application and the termcap library being used does, and
+ where in the termcap file the terminal type that <STRONG>tgetent()</STRONG>
+ is searching for is, several bad things can happen.
Some termcap libraries print a warning message or exit if
they find an entry that's longer than 1023 bytes; others
- don't; others truncate the entries to 1023 bytes. Some
+ do not; others truncate the entries to 1023 bytes. Some
application programs allocate more than the recommended 1K
- for the termcap entry; others don't.
+ for the termcap entry; others do not.
Each termcap entry has two important sizes associated with
it: before "tc" expansion, and after "tc" expansion. "tc"
is the capability that tacks on another termcap entry to
the end of the current one, to add on its capabilities.
- If a termcap entry doesn't use the "tc" capability, then
+ If a termcap entry does not use the "tc" capability, then
of course the two lengths are the same.
The "before tc expansion" length is the most important
one, because it affects more than just users of that par-
ticular terminal. This is the length of the entry as it
exists in /etc/termcap, minus the backslash-newline pairs,
- which tgetent() strips out while reading it. Some termcap
+ which <STRONG>tgetent()</STRONG> strips out while reading it. Some termcap
libraries strip off the final newline, too (GNU termcap
does not). Now suppose:
* and the termcap library (like the one in BSD/OS 1.1
and GNU) reads the whole entry into the buffer, no
- matter what its length, to see if it's the entry it
+ matter what its length, to see if it is the entry it
wants,
- * and tgetent() is searching for a terminal type that
+ * and <STRONG>tgetent()</STRONG> is searching for a terminal type that
either is the long entry, appears in the termcap file
- after the long entry, or doesn't appear in the file
- at all (so that tgetent() has to search the whole
+ after the long entry, or does not appear in the file
+ at all (so that <STRONG>tgetent()</STRONG> has to search the whole
termcap file).
- Then tgetent() will overwrite memory, perhaps its stack,
+ Then <STRONG>tgetent()</STRONG> will overwrite memory, perhaps its stack,
and probably core dump the program. Programs like telnet
are particularly vulnerable; modern telnets pass along
values like the terminal type automatically. The results
The "after tc expansion" length will have a similar effect
to the above, but only for people who actually set TERM to
- that terminal type, since tgetent() only does "tc" expan-
- sion once it's found the terminal type it was looking for,
- not while searching.
+ that terminal type, since <STRONG>tgetent()</STRONG> only does "tc" expan-
+ sion once it is found the terminal type it was looking
+ for, not while searching.
In summary, a termcap entry that is longer than 1023 bytes
can cause, on various combinations of termcap libraries
and applications, a core dump, warnings, or incorrect
- operation. If it's too long even before "tc" expansion,
+ operation. If it is too long even before "tc" expansion,
it will have this effect even for users of some other ter-
minal types and users whose TERM variable does not have a
termcap entry.
When in -C (translate to termcap) mode, the <STRONG>ncurses</STRONG> imple-
- mentation of <STRONG><A HREF="tic.1.html">tic(1)</A></STRONG> issues warning messages when the pre-
+ mentation of <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> issues warning messages when the pre-
tc length of a termcap translation is too long. The -c
(check) option also checks resolved (after tc expansion)
lengths.
</PRE>
<H2>EXTENSIONS</H2><PRE>
Some SVr4 <STRONG>curses</STRONG> implementations, and all previous to
- SVr4, don't interpret the %A and %O operators in parameter
- strings.
+ SVr4, do not interpret the %A and %O operators in parame-
+ ter strings.
SVr4/XPG4 do not specify whether <STRONG>msgr</STRONG> licenses movement
while in an alternate-character-set mode (such modes may,
- among other things, map CR and NL to characters that don't
- trigger local motions). The <STRONG>ncurses</STRONG> implementation
+ among other things, map CR and NL to characters that do
+ not trigger local motions). The <STRONG>ncurses</STRONG> implementation
ignores <STRONG>msgr</STRONG> in <STRONG>ALTCHARSET</STRONG> mode. This raises the possi-
bility that an XPG4 implementation making the opposite
interpretation may need terminfo entries made for <STRONG>ncurses</STRONG>
through 63, plus a number of incompatible string table
extensions.
- <STRONG>OSF</STRONG> -- Supports both the SVr4 set and the AIX extensions.
+ <STRONG>OSF</STRONG> -- Supports both the SVr4 set and the AIX extensions.
</PRE>
</PRE>
<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="printf.3S.html">printf(3S)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</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="printf.3.html">printf(3)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>.
</PRE>
<H2>AUTHORS</H2><PRE>
- Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey.
+ Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey.
Based on pcurses by Pavel Curtis.
- <STRONG><A HREF="TERMINFO.5.html">TERMINFO(5)</A></STRONG>
+ <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
</PRE>
<HR>
<ADDRESS>