X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fterminfo.5.html;h=51862238df8844d578507cb1f3554a2869a52793;hb=265e45e43e9917e8b9ecc2bf9d23867a3ede2ecd;hp=89ced5223f99e5791435f4147352f8b3993baa9e;hpb=0de8912c1c0746eb37b733e9e6fdf852aab9506a;p=ncurses.git diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index 89ced522..51862238 100644 --- a/doc/html/man/terminfo.5.html +++ b/doc/html/man/terminfo.5.html @@ -5,7 +5,8 @@ * 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-2017,2018 Free Software Foundation, Inc. * + * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 1998-2016,2017 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 * @@ -31,12 +32,37 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: terminfo.head,v 1.35 2018/07/28 22:29:09 tom Exp @ + * @Id: terminfo.head,v 1.39 2020/02/02 23:34:34 tom Exp @ * Head of terminfo man page ends here - * @Id: terminfo.tail,v 1.90 2019/01/20 20:21:46 tom Exp @ - * Beginning of terminfo.tail file - * This file is part of ncurses. - * See "terminfo.head" for copyright. + **************************************************************************** + * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 1998-2016,2017 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.100 2020/12/19 21:51:22 tom Exp @ *.in -2 *.in +2 *.in -2 @@ -70,11 +96,17 @@
Terminfo is a data base describing terminals, used by screen-oriented - programs such as nvi(1), rogue(1) and libraries such as curses(3x). + programs such as nvi(1), lynx(1), mutt(1), and other curses + applications, using high-level calls to libraries such as curses(3x). + It is also used via low-level calls by non-curses applications which + may be screen-oriented (such as clear(1)) or non-screen (such as + tabs(1)). + Terminfo 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 - ncurses version 6.1 (patch 20190323). + padding requirements and initialization sequences. + + This manual describes ncurses version 6.2 (patch 20210522).
@@ -92,40 +124,41 @@ entries. The infocmp -f and -W 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 tic. + expressions, or to enforce maximum line-width. The resulting + formatted terminal description can be read by tic. o 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 longname(3x)), and all others - are treated as synonyms (aliases) for the primary terminal name. + The first name given is the most common abbreviation for the + terminal (its primary name), the last name given should be a long + name fully identifying the terminal (see longname(3x)), 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). - o Lines beginning with a "#" in the first column are treated as com- - ments. + o Lines beginning with a "#" in the first column are treated as + comments. While comment lines are legal at any point, the output of captoinfo - and infotocap (aliases for tic) will move comments so they occur + and infotocap (aliases for tic) will move comments so they occur only between entries. - 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 - 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 - suffixes should be used where possible: + 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 hyphens. Modes that the hardware can be in, or + user preferences, 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 possible: Suffix Meaning Example -nn Number of lines on the screen aaa-60 @@ -146,96 +179,100 @@
- The terminfo entry consists of several capabilities, i.e., features - that the terminal has, or methods for exercising the terminal's fea- - tures. + The terminfo entry consists of several capabilities, i.e., features + that the terminal has, or methods for exercising the terminal's + features. After the first field (giving the name(s) of the terminal entry), there should be one or more capability fields. These are boolean, numeric or string names with corresponding values: - o Boolean capabilities are true when present, false when absent. + o Boolean capabilities are true when present, false when absent. There is no explicit value for boolean capabilities. - o Numeric capabilities have a "#" following the name, then an + o Numeric capabilities have a "#" following the name, then an unsigned decimal integer value. - o String capabilities have a "=" following the name, then an string + o 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 canceled, i.e., suppressed from the terminal + Any capability can be canceled, i.e., suppressed from the terminal entry, by following its name with "@" rather than a capability value.
- 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 use can - be given with the name of the base terminal: + If there are two very similar terminals, one (the variant) can be + defined as being just like the other (the base) with certain + exceptions. In the definition of the variant, the string capability + use can be given with the name of the base terminal: - o The capabilities given before use override those in the base type + o The capabilities given before use override those in the base type named by use. - o If there are multiple use capabilities, they are merged in reverse - order. That is, the rightmost use reference is processed first, + o If there are multiple use capabilities, they are merged in reverse + order. That is, the rightmost use reference is processed first, then the one to its left, and so forth. - o Capabilities given explicitly in the entry override those brought + o Capabilities given explicitly in the entry override those brought in by use references. - A capability can be canceled by placing xx@ to the left of the use ref- - erence that imports it, where xx is the capability. For example, the - entry + A capability can be canceled by placing xx@ to the left of the use + reference that imports it, where xx is the capability. For example, + the entry 2621-nl, smkx@, rmkx@, use=2621, defines a 2621-nl that does not have the smkx or rmkx 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 use 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.
- 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 variable is the name by which the programmer (at the terminfo + The variable is the name by which the programmer (at the terminfo level) accesses the capability. - The capname is the short name used in the text of the database, and is - used by a person updating the database. Whenever possible, capnames + The capname 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- - tion. + (now superseded by ECMA-48, which uses identical or very similar + names). Semantics are also intended to match those of the + specification. - The termcap code is the old termcap capability name (some capabilities + The termcap code is the old termcap 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 Caps 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 - through tparm with parms as given (#i). + #[1-9] in the description field indicates that the string is passed + through tparm(3x) with parameters as given (#i). + + If no parameters are listed in the description, passing the + string through tparm(3x) may give unexpected results, e.g., if + it contains percent (%%) signs. - (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 (#i) indicates the ith parameter. @@ -246,49 +283,53 @@ Variable Cap- TCap Description Booleans name Code - auto_left_margin bw bw cub1 wraps from col- - umn 0 to last column - auto_right_margin am am terminal has auto- - matic margins + + + + auto_left_margin bw bw cub1 wraps from + column 0 to last + column + auto_right_margin am am terminal has + automatic margins back_color_erase bce ut screen erased with background color can_change ccc cc terminal can re- - define existing col- - ors + define existing + colors ceol_standout_glitch xhp xs standout not erased 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 + pitch changes + resolution cr_cancels_micro_mode crxm YB using cr turns off micro mode dest_tabs_magic_smso xt xt tabs destructive, magic so char (t1061) eat_newline_glitch xenl xn newline ignored - after 80 cols (con- - cept) - erase_overstrike eo eo can erase over- - strikes with a blank + after 80 cols + (concept) + erase_overstrike eo eo can erase + overstrikes with a + blank 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 (i.e., sets 8th-bit) - has_print_wheel daisy YC printer needs opera- - tor to change char- - acter set + has_print_wheel daisy YC printer needs + operator to change + character set has_status_line hs hs has extra status line hue_lightness_saturation hls hl terminal uses only HLS color notation (Tektronix) - insert_null_glitch in in insert mode distin- - guishes nulls + insert_null_glitch in in insert mode + distinguishes nulls lpi_changes_res lpix YG changing line pitch changes resolution memory_above da da display may be @@ -310,10 +351,11 @@ not exist non_dest_scroll_region ndscr ND scrolling region is non-destructive + non_rev_rmcup nrrmc NR smcup does not reverse rmcup - over_strike os os terminal can over- - strike + over_strike os os terminal can + overstrike prtr_silent mc5i 5i printer will not echo on screen row_addr_glitch xvpa YD only positive motion @@ -324,8 +366,6 @@ 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 @@ -372,11 +412,12 @@ 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. + Variable Cap- TCap Description Numeric name Code bit_image_entwining bitwin Yo number of passes for @@ -388,13 +429,12 @@ printing buttons btns BT number of buttons on mouse - dot_horz_spacing spinh Yc spacing of dots hor- - izontally in dots + dot_horz_spacing spinh Yc spacing of dots + horizontally in dots + per inch + dot_vert_spacing spinv Yb spacing of pins + vertically in pins per inch - - dot_vert_spacing spinv Yb spacing of pins ver- - tically in pins per - inch max_micro_address maddr Yd maximum value in micro_..._address max_micro_jump mjump Ye maximum value in @@ -405,18 +445,19 @@ in micro mode number_of_pins npins Yh numbers of pins in print-head - output_res_char orc Yi horizontal resolu- - tion in units per - line - output_res_horz_inch orhi Yk horizontal resolu- - tion in units per - inch + output_res_char orc Yi horizontal + resolution in units + per line + output_res_horz_inch orhi Yk horizontal + resolution in units + per inch output_res_line orl Yj vertical resolution in units per line output_res_vert_inch orvi Yl vertical resolution in units per inch - print_rate cps Ym print rate in char- - acters per second + print_rate cps Ym print rate in + characters per + second wide_char_size widcs Yn character step size when in double wide mode @@ -441,8 +482,10 @@ lines per inch to #1 change_res_horz chr ZC Change horizontal resolution to #1 - change_res_vert cvr ZD Change vertical res- - olution to #1 + + + change_res_vert cvr ZD Change vertical + resolution to #1 change_scroll_region csr cs change region to line #1 to line #2 (P) @@ -456,8 +499,6 @@ 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 @@ -469,17 +510,18 @@ prototype !? create_window cwin CW define a window #1 from #2,#3 to #4,#5 - cursor_address cup cm move to row #1 col- - umns #2 + cursor_address cup cm move to row #1 + columns #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_invisible civis vi make cursor + invisible cursor_left cub1 le move left one space - cursor_mem_address mrcup CM memory relative cur- - sor addressing, move - to row #1 columns #2 + cursor_mem_address mrcup CM memory relative + cursor addressing, + move to row #1 + columns #2 cursor_normal cnorm ve make cursor appear normal (undo civis/cvvis) @@ -507,11 +549,12 @@ character set (P) enter_am_mode smam SA turn on automatic margins + enter_blink_mode blink mb turn on blinking enter_bold_mode bold md turn on bold (extra bright) mode - enter_ca_mode smcup ti string to start pro- - grams using cup + enter_ca_mode smcup ti string to start + programs using cup enter_delete_mode smdc dm enter delete mode enter_dim_mode dim mh turn on half-bright mode @@ -521,9 +564,8 @@ mode enter_insert_mode smir im enter insert mode enter_italics_mode sitm ZH Enter italic mode - enter_leftward_mode slm ZI Start leftward car- - riage motion - + enter_leftward_mode slm ZI Start leftward + carriage motion enter_micro_mode smicm ZJ Start micro-motion mode enter_near_letter_quality snlq ZK Enter NLQ mode @@ -534,8 +576,8 @@ enter_reverse_mode rev mr turn on reverse video mode enter_secure_mode invis mk turn on blank mode - (characters invisi- - ble) + (characters + invisible) enter_shadow_mode sshm ZM Enter shadow-print mode enter_standout_mode smso so begin standout mode @@ -543,20 +585,20 @@ 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 + enter_upward_mode sum ZP Start upward + carriage motion enter_xon_mode smxon SX turn on xon/xoff handshaking erase_chars ech ec erase #1 characters (P) - exit_alt_charset_mode rmacs ae end alternate char- - acter set (P) + exit_alt_charset_mode rmacs ae end alternate + character set (P) exit_am_mode rmam RA turn off automatic margins exit_attribute_mode sgr0 me turn off all attributes - exit_ca_mode rmcup te strings to end pro- - grams using cup + exit_ca_mode rmcup te strings to end + programs using cup exit_delete_mode rmdc ed end delete mode exit_doublewide_mode rwidm ZQ End double-wide mode exit_insert_mode rmir ei exit insert mode @@ -570,12 +612,14 @@ exit_subscript_mode rsubm ZV End subscript mode exit_superscript_mode rsupm ZW End superscript mode exit_underline_mode rmul ue exit underline mode - exit_upward_mode rum ZX End reverse charac- - ter motion + exit_upward_mode rum ZX End reverse + character motion + + exit_xon_mode rmxon RX turn off xon/xoff handshaking - fixed_pause pause PA pause for 2-3 sec- - onds + fixed_pause pause PA pause for 2-3 + seconds flash_hook hook fh flash switch hook flash_screen flash vb visible bell (may not move cursor) @@ -589,11 +633,10 @@ string init_2string is2 is initialization string - init_3string is3 i3 initialization string - init_file if if name of initializa- - tion file + init_file if if name of + initialization file init_prog iprog iP path name of program for initialization initialize_color initc Ic initialize color #1 @@ -607,15 +650,15 @@ 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_a3 ka3 K3 upper right of + keypad key_b2 kb2 K2 center of keypad key_backspace kbs kb backspace key key_beg kbeg @1 begin key key_btab kcbt kB back-tab key key_c1 kc1 K4 lower left of keypad - key_c3 kc3 K5 lower right of key- - pad + key_c3 kc3 K5 lower right of + keypad key_cancel kcan @2 cancel key key_catab ktbc ka clear-all-tabs key key_clear kclr kC clear-screen or @@ -638,6 +681,7 @@ screen key key_exit kext @9 exit key key_f0 kf0 k0 F0 function key + key_f1 kf1 k1 F1 function key key_f10 kf10 k; F10 function key key_f11 kf11 F1 F11 function key @@ -655,7 +699,6 @@ 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 @@ -704,6 +747,7 @@ key_f9 kf9 k9 F9 function key key_find kfnd @0 find key key_help khlp %1 help key + key_home khome kh home key key_ic kich1 kI insert-character key key_il kil1 kA insert-line key @@ -721,7 +765,6 @@ 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 @@ -734,8 +777,8 @@ key_scommand kCMD *1 shifted command key key_scopy kCPY *2 shifted copy key key_screate kCRT *3 shifted create key - key_sdc kDC *4 shifted delete-char- - acter key + key_sdc kDC *4 shifted delete- + character key key_sdl kDL *5 shifted delete-line key key_select kslt *6 select key @@ -747,8 +790,8 @@ key_sfind kFND *0 shifted find key key_shelp kHLP #1 shifted help key key_shome kHOM #2 shifted home key - key_sic kIC #3 shifted insert-char- - acter key + key_sic kIC #3 shifted insert- + character key key_sleft kLFT #4 shifted left-arrow key key_smessage kMSG %a shifted message key @@ -770,10 +813,13 @@ key_suspend kspd &7 suspend key key_undo kund &8 undo key key_up kcuu1 ku up-arrow key - keypad_local rmkx ke leave 'key- - board_transmit' mode - keypad_xmit smkx ks enter 'key- - board_transmit' mode + + keypad_local rmkx ke leave + 'keyboard_transmit' + mode + keypad_xmit smkx ks enter + 'keyboard_transmit' + mode lab_f0 lf0 l0 label on function key f0 if not f0 lab_f1 lf1 l1 label on function @@ -786,8 +832,6 @@ 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 @@ -830,21 +874,25 @@ (P*) parm_delete_line dl DL delete #1 lines (P*) parm_down_cursor cud DO down #1 lines (P*) - parm_down_micro mcud Zf Like parm_down_cur- - sor in micro mode + parm_down_micro mcud Zf Like + parm_down_cursor in + micro mode parm_ich ich IC insert #1 characters (P*) + parm_index indn SF scroll forward #1 lines (P) parm_insert_line il AL insert #1 lines (P*) parm_left_cursor cub LE move #1 characters to the left (P) - parm_left_micro mcub Zg Like parm_left_cur- - sor in micro mode + parm_left_micro mcub Zg Like + parm_left_cursor in + micro mode parm_right_cursor cuf RI move #1 characters to the right (P*) - parm_right_micro mcuf Zh Like parm_right_cur- - sor in micro mode + parm_right_micro mcuf Zh Like + parm_right_cursor in + micro mode parm_rindex rin SR scroll back #1 lines (P) parm_up_cursor cuu UP up #1 lines (P*) @@ -852,8 +900,6 @@ 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 @@ -869,8 +915,8 @@ prtr_off mc4 pf turn off printer prtr_on mc5 po turn on printer pulse pulse PU select pulse dialing - quick_dial qdial QD dial number #1 with- - out checking + quick_dial qdial QD dial number #1 + without checking remove_clock rmclk RC remove clock repeat_char rep rp repeat char #1 #2 times (P*) @@ -898,6 +944,8 @@ #1 set_bottom_margin smgb Zk Set bottom margin at current line + + set_bottom_margin_parm smgbp Zl Set bottom margin at line #1 or (if smgtp is not given) #2 @@ -909,17 +957,15 @@ set_foreground setf Sf Set foreground color #1 set_left_margin smgl ML set left soft margin - at current col- - umn. See smgl. - (ML is not in BSD - termcap). + at current + column. See + smgl. (ML is not in + BSD termcap). set_left_margin_parm smglp Zm Set left (right) margin at column #1 - set_right_margin smgr MR set right soft mar- - gin at current col- - umn - - + set_right_margin smgr MR set right soft + margin at current + column set_right_margin_parm smgrp Zn Set right margin at column #1 set_tab hts st set a tab in every @@ -941,10 +987,12 @@ image graphics stop_char_set_def rcsd Zt End definition of character set #1 - subscript_characters subcs Zu List of subscript- - able characters - superscript_characters supcs Zv List of superscript- - able characters + subscript_characters subcs Zu List of + subscriptable + characters + superscript_characters supcs Zv List of + superscriptable + characters tab ht ta tab to next 8-space hardware tab stop these_cause_cr docr Zw Printing any of @@ -963,6 +1011,7 @@ user3 u3 u3 User string #3 user4 u4 u4 User string #4 user5 u5 u5 User string #5 + user6 u6 u6 User string #6 user7 u7 u7 User string #7 user8 u8 u8 User string #8 @@ -970,40 +1019,39 @@ wait_tone wait WA wait for dial-tone xoff_character xoffc XF XOFF character xon_character xonc XN XON character - zero_motion zerom Zx No motion for subse- - quent character + zero_motion zerom Zx No motion for + subsequent character - The following string capabilities are present in the SVr4.0 term struc- - ture, but were originally not documented in the man page. + The following string capabilities are present in the SVr4.0 term + structure, but were originally not documented in the man page. Variable Cap- TCap Description String name Code alt_scancode_esc scesa S8 Alternate escape - for scancode emu- - lation + for scancode + emulation 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 cell #1 #2 times char_set_names csnm Zy Produce #1'th item - from list of char- - acter set names + from list of + character set + names code_set_init csin ci Init sequence for multiple codesets color_names colornm Yw Give name for color #1 define_bit_image_region defbi Yx Define rectangular bit image region - device_type devt dv Indicate lan- - guage/codeset sup- - port - display_pc_char dispc S1 Display PC charac- - ter #1 + device_type devt dv Indicate + language/codeset + support + display_pc_char dispc S1 Display PC + character #1 end_bit_image_region endbi Yy End a bit-image region enter_pc_charset_mode smpch S2 Enter PC character @@ -1028,10 +1076,12 @@ key #1 to type string #2 and show string #3 + + req_mouse_pos reqmp RQ Request mouse position - scancode_escape scesc S7 Escape for scan- - code emulation + scancode_escape scesc S7 Escape for + scancode emulation set0_des_seq s0ds s0 Shift to codeset 0 (EUC set 0, ASCII) set1_des_seq s1ds s1 Shift to codeset 1 @@ -1048,21 +1098,19 @@ set_lr_margin smglr ML Set both left and right margins to #1, #2. (ML is - not in BSD term- - cap). - - + not in BSD + termcap). 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 YI, the ncurses 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 YI, the ncurses 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! @@ -1074,63 +1122,63 @@ mode enter_low_hl_mode elohlm Xo Enter low highlight mode - enter_right_hl_mode erhlm Xr Enter right high- - light mode + enter_right_hl_mode erhlm Xr Enter right + highlight mode enter_top_hl_mode ethlm Xt Enter top highlight mode - enter_vertical_hl_mode evhlm Xv Enter vertical high- - light mode + enter_vertical_hl_mode evhlm Xv Enter vertical + highlight mode set_a_attributes sgr1 sA Define second set of video attributes #1-#6 set_pglen_inch slength YI Set page length to #1 hundredth of an - inch (some implemen- - tations use sL for - termcap). + inch (some + implementations use + sL for termcap).
- The preceding section listed the predefined 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 predefined 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. - ncurses addresses this limitation by allowing user-defined capabili- - ties. The tic and infocmp programs provide the -x option for this pur- - pose. When -x is set, tic treats unknown capabilities as user-defined. - That is, if tic 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 - use_extended_names(3x) function makes this information conditionally - available to applications. The ncurses library provides the data leav- - ing most of the behavior to applications: - - o User-defined capability strings whose name begins with "k" are + ncurses addresses this limitation by allowing user-defined + capabilities. The tic and infocmp programs provide the -x option for + this purpose. When -x is set, tic treats unknown capabilities as user- + defined. That is, if tic encounters a capability name which it does + not recognize, it infers its type (boolean, number or string) from the + syntax and makes an extended table entry for that capability. The + use_extended_names(3x) function makes this information conditionally + available to applications. The ncurses library provides the data + leaving most of the behavior to applications: + + o User-defined capability strings whose name begins with "k" are treated as function keys. - o The types (boolean, number, string) determined by tic can be + o The types (boolean, number, string) determined by tic can be inferred by successful calls on tigetflag, etc. o If the capability name happens to be two characters, the capability is also available through the termcap interface. - 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 - capabilities intended for use by termcap applications should be limited - 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 - longer names available using terminfo. + While termcap is said to be extensible because it does not use a + predefined set of capabilities, in practice it has been limited to the + capabilities 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 assumed by termcap implementations and their applications. In + particular, 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.
- The following entry, describing an ANSI-standard terminal, is represen- - tative of what a terminfo entry for a modern terminal typically looks - like. + The following entry, describing an ANSI-standard terminal, is + representative of what a terminfo entry for a modern terminal typically + looks like. ansi|ansi/pc-term compatible with color, am, mc5i, mir, msgr, @@ -1163,37 +1211,37 @@ 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 terminfo are of three types: - o Boolean capabilities which indicate that the terminal has some par- - ticular feature, + o Boolean capabilities which indicate that the terminal has some + particular feature, o numeric capabilities giving the size of the terminal or the size of particular delays, and - o string capabilities, which give a sequence which can be used to + o string capabilities, which give a sequence which can be used to perform particular terminal operations.
All capabilities have names. For instance, the fact that ANSI-standard - terminals have automatic margins (i.e., an automatic return and line- - feed when the end of a line is reached) is indicated by the capability - am. Hence the description of ansi includes am. Numeric capabilities - are followed by the character "#" and then a positive value. Thus + terminals have automatic margins (i.e., an automatic return and line- + feed when the end of a line is reached) is indicated by the capability + am. Hence the description of ansi includes am. Numeric capabilities + are followed by the character "#" and then a positive value. Thus cols, which indicates the number of columns the terminal has, gives the - 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). + value "80" for ansi. Values for numeric capabilities may be specified + in decimal, octal or hexadecimal, using the C programming language + conventions (e.g., 255, 0377 and 0xff or 0xFF). - Finally, string valued capabilities, such as el (clear to end of line - sequence) are given by the two-character code, an "=", and then a + Finally, string valued capabilities, such as el (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- - ities for easy encoding of characters there: + A number of escape sequences are provided in the string valued + capabilities for easy encoding of characters there: o Both \E and \e map to an ESCAPE character, @@ -1210,9 +1258,9 @@ respectively. X/Open Curses does not say what "appropriate x" 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 @@ -1228,71 +1276,70 @@ o and \0 for null. \0 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 stty(1). - 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. + 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 + implementations. Finally, characters may be given as three octal digits after a \. - A delay in milliseconds may appear anywhere in a string capability, - enclosed in $<..> brackets, as in el=\EK$<5>, and padding characters + A delay in milliseconds may appear anywhere in a string capability, + enclosed in $<..> brackets, as in el=\EK$<5>, and padding characters are supplied by tputs(3x) to provide this delay. - o The delay must be a number with at most one decimal place of preci- - sion; it may be followed by suffixes "*" or "/" or both. + o The delay must be a number with at most one decimal place of + precision; it may be followed by suffixes "*" or "/" or both. - o 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 + o 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 lines affected.) Normally, padding is advisory if the device has the xon capability; it is used for cost computation but does not trigger delays. - o A "/" suffix indicates that the padding is mandatory and forces a + o A "/" suffix indicates that the padding is mandatory and forces a delay of the given number of milliseconds even on devices for which xon 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 ind in the example above.
- The ncurses 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, ncurses eliminates + The ncurses 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 + environment variables. Before starting to search, ncurses eliminates duplicates in its search list. - o If the environment variable TERMINFO is set, it is interpreted as + o 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. - o If TERMINFO is not set, ncurses will instead look in the directory + o If TERMINFO is not set, ncurses will instead look in the directory $HOME/.terminfo for a compiled description. - o Next, if the environment variable TERMINFO_DIRS is set, ncurses - will interpret the contents of that variable as a list of colon- + o Next, if the environment variable TERMINFO_DIRS is set, ncurses + 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 /usr/share/terminfo. o Finally, ncurses searches these compiled-in locations: - o a list of directories (/usr/local/ncurses/share/ter- - minfo:/usr/share/terminfo), and + o a list of directories (no default value), and - o the system terminfo directory, /usr/share/terminfo (the com- - piled-in default). + o the system terminfo directory, /usr/share/terminfo (the + compiled-in default).
@@ -1319,15 +1366,15 @@ wraps around to the beginning of the next line when it reaches the right margin, then it should have the am capability. If the terminal can clear its screen, leaving the cursor in the home position, then - this is given by the clear string capability. If the terminal over- - strikes (rather than clearing a position when a character is struck + this is given by the clear string capability. If the terminal + overstrikes (rather than clearing a position when a character is struck over) then it should have the os capability. If the terminal is a printing terminal, with no soft copy unit, give it both hc and os. (os 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 cr. (Normally - this will be carriage return, control M.) If there is a code to pro- - duce an audible signal (bell, beep, etc) give this as bel. + this will be carriage return, control/M.) If there is a code to + produce an audible signal (bell, beep, etc) give this as bel. If there is a code to move the cursor one position to the left (such as backspace) that capability should be given as cub1. Similarly, codes @@ -1360,14 +1407,14 @@ 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 terminfo file usually assumes that this is on; - i.e., am. If the terminal has a command which moves to the first col- - umn of the next line, that command can be given as nel (newline). It - does not matter if the command clears the remainder of the current + i.e., am. If the terminal has a command which moves to the first + column of the next line, that command can be given as nel (newline). + It does not matter if the command clears the remainder of the current line, so if the terminal has no cr and lf it may still be possible to craft a working nel out of one or both of them. - These capabilities suffice to describe hard-copy and "glass-tty" termi- - nals. Thus the model 33 teletype is described as + These capabilities suffice to describe hard-copy and "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, @@ -1380,21 +1427,21 @@
- Cursor addressing and other strings requiring parameters in the termi- - nal are described by a parameterized string capability, with printf- - like escapes such as %x in it. For example, to address the cursor, the - cup 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 - by mrcup. + Cursor addressing and other strings requiring parameters in the + terminal are described by a parameterized string capability, with + printf-like escapes such as %x in it. For example, to address the + cursor, the cup 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 by mrcup. The parameter mechanism uses a stack and special % 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, - e.g., in the sgr string. + stack and then print it in some format. Print (e.g., "%d") is a + special case. Other operations, including "%t" pop their operand from + the stack. It is noted that more complex operations are often + necessary, e.g., in the sgr string. The % encodings have the following meanings: @@ -1471,8 +1518,8 @@ 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 "%gx%{5}%-". %P and %g vari- - ables are persistent across escape-string evaluations. + order. That is, to get x-5 one would use "%gx%{5}%-". %P and %g + variables 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 @@ -1506,31 +1553,31 @@ involve going up with cuu1 from the home position, but a program should never do this itself (unless ll 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- - ner of the screen, not of memory. (Thus, the \EH sequence on HP termi- - nals cannot be used for home.) + 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 cannot be used for home.) If the terminal has row or column absolute cursor addressing, these can be given as single parameter capabilities hpa (horizontal position absolute) and vpa (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 cup. If there are parameter- - ized local motions (e.g., move n spaces to the right) these can be - given as cud, cub, cuf, and cuu with a single parameter indicating how - many spaces to move. These are primarily useful if the terminal does - not have cup, such as the TEKTRONIX 4025. + hp2645) and can be used in preference to cup. If there are + parameterized local motions (e.g., move n spaces to the right) these + can be given as cud, cub, cuf, and cuu with a single parameter + indicating how many spaces to move. These are primarily useful if the + terminal does not have cup, 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 smcup and rmcup. 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 smcup sets the command character to be the one - used by terminfo. If the smcup sequence will not restore the screen - after an rmcup sequence is output (to the state prior to outputting - rmcup), specify nrrmc. + 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. This is also used for + the TEKTRONIX 4025, where smcup sets the command character to be the + one used by terminfo. If the smcup sequence will not restore the + screen after an rmcup sequence is output (to the state prior to + outputting rmcup), specify nrrmc.
@@ -1541,8 +1588,8 @@ given as el1. If the terminal can clear from the current position to the end of the display, then this should be given as ed. Ed 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 ed is not avail- - able.) + a request to delete a large number of lines, if a true ed is not + available.)
@@ -1561,53 +1608,55 @@ The cursor position is, alas, undefined after using this command. It is possible to get the effect of insert or delete line using csr on - a properly chosen region; the sc and rc (save and restore cursor) com- - mands may be useful for ensuring that your synthesized insert/delete + a properly chosen region; the sc and rc (save and restore cursor) + commands may be useful for ensuring that your synthesized insert/delete string does not move the cursor. (Note that the ncurses(3x) library does this synthesis automatically, so you need not compose insert/delete strings for an entry with csr). - 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 - (like the HP-700/90 series, which however also has insert/delete). + 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 however also has + insert/delete). - Inserting lines at the top or bottom of the screen can also be done - using ri or ind on many terminals without a true insert/delete line, + Inserting lines at the top or bottom of the screen can also be done + using ri or ind on many terminals without a true insert/delete line, and is often faster even on terminals with those features. - The boolean non_dest_scroll_region should be set if each scrolling win- - 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 - region, and do ri followed by dl1 or ind. If the data scrolled off the - bottom of the region by the ri re-appears, then scrolling is non- - destructive. System V and XSI Curses expect that ind, ri, indn, and - rin will simulate destructive scrolling; their documentation cautions - you not to define csr unless this is true. This curses implementation - is more liberal and will do explicit erases after scrolling if ndsrc 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 wind. The four parameters are the starting and ending lines in + The boolean non_dest_scroll_region 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 something to the bottom line, move the cursor to the top + of the region, and do ri followed by dl1 or ind. If the data scrolled + off the bottom of the region by the ri re-appears, then scrolling is + non-destructive. System V and XSI Curses expect that ind, ri, indn, + and rin will simulate destructive scrolling; their documentation + cautions you not to define csr unless this is true. This curses + implementation is more liberal and will do explicit erases after + scrolling if ndsrc 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 wind. 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 da capability - should be given; if display memory can be retained below, then db - should be given. These indicate that deleting a line or scrolling may - bring non-blank lines up from below or that scrolling back with ri may + should be given; if display memory can be retained below, then db + should be given. These indicate that deleting a line or scrolling may + bring non-blank lines up from below or that scrolling back with ri may bring down non-blank lines.
- There are two basic kinds of intelligent terminals with respect to - insert/delete character which can be described using terminfo. 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 - screen which is either eliminated, or expanded to two untyped blanks. + There are two basic kinds of intelligent terminals with respect to + insert/delete character which can be described using terminfo. 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" @@ -1617,9 +1666,9 @@ 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 in, which stands - for "insert null". + of the current line and onto the next as you insert, you have the + second type of terminal, and should give the capability in, 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 @@ -1704,8 +1753,8 @@ 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 sgr, only those for which corresponding sep- - arate attribute commands exist. + modes need be supported by sgr, only those for which corresponding + separate attribute commands exist. For example, the DEC vt220 supports most of the modes: @@ -1724,15 +1773,15 @@ 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, + is set up to be the combination of reverse and bold. The vt220 + terminal 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 + output 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 @@ -1754,19 +1803,19 @@ %?%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 - 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 (xmc) 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 msgr capability, asserting that it is + 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 (xmc) deposit special + "cookies" when they receive mode-setting sequences, which affect the + display algorithm rather than having extra bits for each character. + Some terminals, 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 msgr 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 @@ -1793,8 +1842,8 @@ 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 - to transmit or not transmit, give these codes as smkx and rmkx. Other- - wise the keypad is assumed to always transmit. + to transmit or not transmit, give these codes as smkx and rmkx. + Otherwise the keypad is assumed to always transmit. The codes sent by the left arrow, right arrow, up arrow, down arrow, and home keys can be given as kcub1, kcuf1, kcuu1, kcud1, and khome @@ -1856,43 +1905,60 @@ The capabilities nlab, lw and lh 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 smln and rmln. smln is nor- - mally output after one or more pln sequences to make sure that the + turn the labels on and off, give them in smln and rmln. smln is + normally output after one or more pln sequences to make sure that the change becomes visible.
- If the terminal has hardware tabs, the command to advance to the next - tab stop can be given as ht (usually control I). A "back-tab" command - which moves leftward to the preceding tab stop can be given as cbt. 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 ht or cbt 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 n spaces when the terminal is powered up, the - numeric parameter it is given, showing the number of spaces the tabs - are set to. This is normally used by the tset 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 is1, is2, and is3, initialization strings - for the terminal, iprog, the path name of a program to be run to ini- - tialize the terminal, and if, 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 init option of the tput 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: + + o If the terminal has hardware tabs, the command to advance to the + next tab stop can be given as ht (usually control/I). + + o A "back-tab" command which moves leftward to the preceding tab stop + can be given as cbt. + + 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 ht or cbt even if they are present, since + the user may not have the tab stops properly set. + + o If the terminal has hardware tabs which are initially set every n + spaces when the terminal is powered up, the numeric parameter it is + given, showing the number of spaces the tabs are set to. + + The it capability is normally used by the tset 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 + + o is1, is2, and is3, initialization strings for the terminal, + + o iprog, the path name of a program to be run to initialize the + terminal, + + o and if, 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 init option of the tput program, each time the + user logs in. They will be printed in the following order: run the program iprog - output is1 is2 + output + is1 and + is2 set the margins using - mgc, smgl and smgr + mgc or + smglp and smgrp or + smgl and smgr set tabs using tbc and hts @@ -1900,95 +1966,117 @@ print the file if - and finally - output is3. + and finally output + is3. - Most initialization is done with is2. Special terminal modes can be - set up without duplicating strings by putting the common sequences in + Most initialization is done with is2. Special terminal modes can be + set up without duplicating strings by putting the common sequences in is2 and special cases in is1 and is3. - A set of sequences that does a harder reset from a totally unknown + A set of sequences that does a harder reset from a totally unknown state can be given as rs1, rs2, rf and rs3, analogous to is1 , is2 , if - and is3 respectively. These strings are output by the reset program, - which is used when the terminal gets into a wedged state. Commands are - normally placed in rs1, rs2 rs3 and rf 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 is2, 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 reset program writes strings including iprog, etc., in the same - order as the init program, using rs1, etc., instead of is1, etc. If - any of rs1, rs2, rs3, or rf reset capability strings are missing, the - reset program falls back upon the corresponding initialization capabil- - ity string. - - If there are commands to set and clear tab stops, they can be given as + and is3 respectively. These strings are output by reset option of + tput, or by the reset program (an alias of tset), which is used when + the terminal gets into a wedged state. Commands are normally placed in + rs1, rs2 rs3 and rf 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 is2, 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 reset program writes strings including iprog, etc., in the same + order as the init program, using rs1, etc., instead of is1, etc. If + any of rs1, rs2, rs3, or rf reset capability strings are missing, the + reset program falls back upon the corresponding initialization + capability string. + + If there are commands to set and clear tab stops, they can be given as tbc (clear all tab stops) and hts (set a tab stop in the current column - of every row). If a more complex sequence is needed to set the tabs + 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 is2 or if. + The tput reset command uses the same capability strings as the reset + command, although the two programs (tput and reset) provide different + command-line options. + + In practice, these terminfo capabilities are not often used in + initialization of tabs (though they are required for the tabs program): + + o Almost all hardware terminals (at least those which supported tabs) + initialized those to every eight columns: + + The only exception was the AT&T 2300 series, which set tabs to + every five columns. + + o In particular, developers of the hardware terminals which are + commonly used as models for modern terminal emulators provided + documentation demonstrating that eight columns were the standard. + + o Because of this, the terminal initialization programs tput and tset + use the tbc (clear_all_tabs) and hts (set_tab) capabilities + directly only when the it (init_tabs) capability is set to a value + other than eight. +
- 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 char- - acters after certain cursor motions and screen changes. + 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 certain cursor motions and screen changes. If the terminal uses xon/xoff handshaking for flow control (that is, it - automatically emits ^S back to the host when its input buffers are - close to full), set xon. This capability suppresses the emission of - padding. You can also set it for memory-mapped console devices effec- - tively that do not have a speed limit. Padding information should - still be included so that routines can make better decisions about rel- - ative costs, but actual pad characters will not be transmitted. + automatically emits ^S back to the host when its input buffers are + close to full), set xon. This capability suppresses the emission of + padding. You can also set it for memory-mapped console devices + effectively that do not have a speed limit. Padding information should + still be included so that routines can make better decisions about + relative costs, but actual pad characters will not be transmitted. If pb (padding baud rate) is given, padding is suppressed at baud rates - below the value of pb. If the entry has no padding baud rate, then + below the value of pb. If the entry has no padding baud rate, then whether padding is emitted or not is completely controlled by xon. - If the terminal requires other than a null (zero) character as a pad, - then this can be given as pad. Only the first character of the pad + If the terminal requires other than a null (zero) character as a pad, + then this can be given as pad. Only the first character of the pad string is used.
- Some terminals have an extra "status line" which is not normally used + Some terminals have an extra "status line" which is not normally used by software (and thus not counted in the terminal's lines capability). - The simplest case is a status line which is cursor-addressable but not + The simplest case is a status line which is cursor-addressable but not part of the main scrolling region on the screen; the Heathkit H19 has a - status line of this kind, as would a 24-line VT100 with a 23-line + status line of this kind, as would a 24-line VT100 with a 23-line scrolling region set up on initialization. This situation is indicated by the hs capability. - Some terminals with status lines need special sequences to access the - status line. These may be expressed as a string with single parameter - tsl which takes the cursor to a given zero-origin column on the status - line. The capability fsl must return to the main-screen cursor posi- - tions before the last tsl. You may need to embed the string values of - sc (save cursor) and rc (restore cursor) in tsl and fsl to accomplish - this. + Some terminals with status lines need special sequences to access the + status line. These may be expressed as a string with single parameter + tsl which takes the cursor to a given zero-origin column on the status + line. The capability fsl must return to the main-screen cursor + positions before the last tsl. You may need to embed the string values + of sc (save cursor) and rc (restore cursor) in tsl and fsl to + accomplish this. - The status line is normally assumed to be the same width as the width - of the terminal. If this is untrue, you can specify it with the + The status line is normally assumed to be the same width as the width + of the terminal. If this is untrue, you can specify it with the numeric capability wsl. A command to erase or blank the status line may be specified as dsl. - The boolean capability eslok specifies that escape sequences, tabs, + The boolean capability eslok specifies that escape sequences, tabs, etc., work ordinarily in the status line. - The ncurses implementation does not yet use any of these capabilities. + The ncurses implementation does not yet use any of these capabilities. They are documented here in case they ever become important.
- Many terminals have alternate character sets useful for forms-drawing. - Terminfo and curses have built-in support for most of the drawing char- - acters supported by the VT100, with some characters from the AT&T - 4410v1 added. This alternate character set may be specified by the + Many terminals have alternate character sets useful for forms-drawing. + Terminfo and curses have built-in support for most of 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 acsc capability. Glyph ACS Ascii acsc acsc @@ -2004,9 +2092,9 @@ 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 upper left corner ACS_ULCORNER + l 0x6c lower left corner ACS_LLCORNER + m 0x6d @@ -2030,34 +2118,34 @@ A few notes apply to the table itself: - o X/Open Curses incorrectly states that the mapping for lantern is - uppercase "I" although Unix implementations use the lowercase "i" + o X/Open Curses incorrectly states that the mapping for lantern is + uppercase "I" although Unix implementations use the lowercase "i" mapping. - o The DEC VT100 implemented graphics using the alternate character - set feature, temporarily switching modes and sending characters in - the range 0x60 (96) to 0x7e (126) (the acsc Value column in the ta- - ble). + o The DEC VT100 implemented graphics using the alternate character + set feature, temporarily switching modes and sending characters in + the range 0x60 (96) to 0x7e (126) (the acsc Value column in the + table). o The AT&T terminal added graphics characters outside that range. - Some of the characters within the range do not match the VT100; - presumably they were used in the AT&T terminal: board of squares - replaces the VT100 newline symbol, while lantern symbol replaces + Some of the characters within the range do not match the VT100; + presumably they were used in the AT&T terminal: board of squares + replaces the VT100 newline symbol, while lantern symbol replaces the VT100 vertical tab symbol. The other VT100 symbols for control - characters (horizontal tab, carriage return and line-feed) are not + characters (horizontal tab, carriage return and line-feed) are not (re)used in curses. - 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 smacs/rmacs switches) will be rendered as the + 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 smacs/rmacs switches) will be rendered as the corresponding graphic. Then read off the VT100/your terminal character pairs right to left in sequence; these become the ACSC string.
- The curses library functions init_pair and init_color manipulate the - color pairs and color values discussed in this section (see + The curses library functions init_pair and init_color manipulate the + color pairs and color values discussed in this section (see curs_color(3x) for details on these and related functions). Most color terminals are either "Tektronix-like" or "HP-like": @@ -2066,45 +2154,46 @@ is usually 8), and can set character-cell foreground and background characters independently, mixing them into N * N color-pairs. - o On HP-like terminals, the user must set each color pair up sepa- - rately (foreground and 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. + o On HP-like terminals, the user 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. ANSI-compatible terminals are Tektronix-like. Some basic color capabilities are independent of the color method. The - numeric capabilities colors and pairs specify the maximum numbers of - colors and color-pairs that can be displayed simultaneously. The op + numeric capabilities colors and pairs specify the maximum numbers of + colors and color-pairs that can be displayed simultaneously. The op (original pair) string resets foreground and background colors to their - default values for the terminal. The oc 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 cur- - rent background color rather than the power-up default background; + default values for the terminal. The oc 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 bce. - While the curses library works with color pairs (reflecting the inabil- - ity of some devices to set foreground and background colors indepen- - dently), there are separate capabilities for setting these features: + While the curses library works with color pairs (reflecting the + inability of some devices to set foreground and background colors + independently), there are separate capabilities for setting these + features: - o To change the current foreground or background color on a Tek- - tronix-type terminal, use setaf (set ANSI foreground) and setab - (set ANSI background) or setf (set foreground) and setb (set back- - ground). These take one parameter, the color number. The SVr4 + o To change the current foreground or background color on a + Tektronix-type terminal, use setaf (set ANSI foreground) and setab + (set ANSI background) or setf (set foreground) and setb (set + background). These take one parameter, the color number. The SVr4 documentation describes only setaf/setab; the XPG4 draft says that "If the terminal supports ANSI escape sequences to set background - and foreground, they should be coded as setaf and setab, respec- - tively. + and foreground, they should be coded as setaf and setab, + respectively. o If the terminal supports other escape sequences to set background - and foreground, they should be coded as setf and setb, respec- - tively. The vidputs and the refresh(3x) functions use the setaf - and setab capabilities if they are defined. + and foreground, they should be coded as setf and setb, + respectively. The vidputs and the refresh(3x) functions use the + setaf and setab capabilities if they are defined. - The setaf/setab and setf/setb capabilities take a single numeric argu- - ment each. Argument values 0-7 of setaf/setab are portably defined as - follows (the middle column is the symbolic #define available in the + The setaf/setab and setf/setb capabilities take a single numeric + argument each. Argument values 0-7 of setaf/setab are portably defined + as follows (the middle column is the symbolic #define available in the header for the curses or ncurses libraries). The terminal hardware is - free to map these as it likes, but the RGB values indicate normal loca- - tions in color space. + free to map these as it likes, but the RGB values indicate normal + locations in color space. Color #define Value RGB black COLOR_BLACK 0 0, 0, 0 @@ -2129,8 +2218,8 @@ yellow COLOR_YELLOW 6 max,max,0 white COLOR_WHITE 7 max,max,max - It is important to not confuse the two sets of color capabilities; oth- - erwise red/blue will be interchanged on the display. + It is important to not confuse the two sets of color capabilities; + otherwise red/blue will be interchanged on the display. On an HP-like terminal, use scp with a color-pair number parameter to set which color pair is current. @@ -2141,20 +2230,21 @@ indicate that colors can be modified. If so, the initc capability will take a color number (0 to colors - 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 capa- - bility hls is present, they are instead as HLS (Hue, Lightness, + interpreted as RGB (Red, Green, Blue) values. If the boolean + capability hls is present, they are instead as HLS (Hue, Lightness, Saturation) indices. The ranges are terminal-dependent. o On an HP-like terminal, initp may give a capability for changing a - color-pair value. It will take seven parameters; a color-pair num- - ber (0 to max_pairs - 1), and two triples describing first back- - ground and then foreground colors. These parameters must be (Red, - Green, Blue) or (Hue, Lightness, Saturation) depending on hls. + color-pair value. It will take seven parameters; a color-pair + number (0 to max_pairs - 1), and two triples describing first + background and then foreground colors. These parameters must be + (Red, Green, Blue) or (Hue, Lightness, Saturation) depending on + hls. - On some color terminals, colors collide with highlights. You can reg- - ister these collisions with the ncv capability. This is a bit-mask of - attributes not to be used when colors are enabled. The correspondence - with the attributes understood by curses is as follows: + On some color terminals, colors collide with highlights. You can + register these collisions with the ncv capability. This is a bit-mask + of attributes not to be used when colors are enabled. The + correspondence with the attributes understood by curses is as follows: Attribute Bit Decimal Set by A_STANDOUT 0 1 sgr @@ -2174,134 +2264,134 @@ A_VERTICAL 14 16384 sgr1 A_ITALIC 15 32768 sitm - For example, on many IBM PC consoles, the underline attribute collides - with the foreground color blue and is not available in color mode. + 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 ncv capability of 2. - SVr4 curses does nothing with ncv, ncurses recognizes it and optimizes + SVr4 curses does nothing with ncv, ncurses recognizes it and optimizes the output in favor of colors.
- If the terminal requires other than a null (zero) character as a pad, - then this can be given as pad. Only the first character of the pad + If the terminal requires other than a null (zero) character as a pad, + then this can be given as pad. Only the first character of the pad string is used. If the terminal does not have a pad character, specify - npc. Note that ncurses implements the termcap-compatible PC variable; - though the application may set this value to something other than a - null, ncurses will test npc first and use napms if the terminal has no + npc. Note that ncurses implements the termcap-compatible PC variable; + though the application may set this value to something other than a + null, ncurses will test npc 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 hu (half-line up) and hd (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 ff - (usually control L). + If the terminal can move up or down half a line, this can be indicated + with hu (half-line up) and hd (half-line down). This is primarily + useful for superscripts and subscripts on hard-copy terminals. If a + hard-copy terminal can eject to the next page (form feed), give this as + ff (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- - ters) this can be indicated with the parameterized string rep. 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 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 rep. + 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 cmdch. A prototype command character - is chosen which is used in all capabilities. This character is given - in the cmdch capability to identify it. The following convention is + 4025, this can be indicated with cmdch. A prototype command character + is chosen which is used in all capabilities. This character is given + in the cmdch capability to identify it. The following convention is supported on some UNIX systems: The environment is to be searched for a - CC variable, and if found, all occurrences of the prototype character + CC 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 kind of known - terminal, such as switch, dialup, patch, and network, should include - the gn (generic) capability so that programs can complain that they do - not know how to talk to the terminal. (This capability does not apply - to virtual terminal descriptions for which the escape sequences are + Terminal descriptions that do not represent a specific kind of known + terminal, such as switch, dialup, patch, and network, should include + the gn (generic) capability so that programs can complain that they do + not know how to talk to the terminal. (This capability does not apply + to virtual 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 - km. Otherwise, software will assume that the 8th bit is parity and it - will usually be cleared. If strings exist to turn this "meta mode" on + 8th bit of any character transmitted, this fact can be indicated with + km. Otherwise, software will assume that the 8th bit is parity and it + will usually be cleared. If strings exist to turn this "meta mode" on and off, they can be given as smm and rmm. 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 lm. A value + once, the number of lines of memory can be indicated with lm. A value of lm#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 virtual terminal + If the terminal is one of those supported by the UNIX virtual terminal protocol, the terminal number can be given as vt. - Media copy strings which control an auxiliary printer connected to the - terminal can be given as mc0: print the contents of the screen, mc4: - turn off the printer, and mc5: turn on the printer. When the printer - is on, all text sent to the terminal will be sent to the printer. It - is undefined whether the text is also displayed on the terminal screen - when the printer is on. A variation mc5p takes one parameter, and - leaves the printer on for as many characters as the value of the param- - eter, then turns the printer off. The parameter should not exceed 255. - All text, including mc4, is transparently passed to the printer while - an mc5p is in effect. + Media copy strings which control an auxiliary printer connected to the + terminal can be given as mc0: print the contents of the screen, mc4: + turn off the printer, and mc5: turn on the printer. When the printer + is on, all text sent to the terminal will be sent to the printer. It + is undefined whether the text is also displayed on the terminal screen + when the printer is on. A variation mc5p takes one parameter, and + leaves the printer on for as many characters as the value of the + parameter, then turns the printer off. The parameter should not exceed + 255. All text, including mc4, is transparently passed to the printer + while an mc5p is in effect.
- Hazeltine terminals, which do not allow "~" characters to be displayed + Hazeltine terminals, which do not allow "~" characters to be displayed should indicate hz. - Terminals which ignore a line-feed immediately after an am wrap, such + Terminals which ignore a line-feed immediately after an am wrap, such as the Concept and vt100, should indicate xenl. - If el is required to get rid of standout (instead of merely writing + If el is required to get rid of standout (instead of merely writing normal text on top of it), xhp should be given. Teleray terminals, where tabs turn all characters moved over to blanks, - should indicate xt (destructive tabs). Note: the variable indicating - this is now "dest_tabs_magic_smso"; in older versions, it was tel- - eray_glitch. This glitch is also taken to mean that it is not possible - to position the cursor on top of a "magic cookie", that to erase stand- - out mode it is instead necessary to use delete and insert line. The - ncurses implementation ignores this glitch. - - The Beehive Superbee, which is unable to correctly transmit the escape - or control C characters, has xsb, 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, + should indicate xt (destructive tabs). Note: the variable indicating + this is now "dest_tabs_magic_smso"; in older versions, it was + teleray_glitch. This glitch is also taken to mean that it is not + possible to position the cursor on top of a "magic cookie", that to + erase standout mode it is instead necessary to use delete and insert + line. The ncurses implementation ignores this glitch. + + The Beehive Superbee, which is unable to correctly transmit the escape + or control/C characters, has xsb, 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". - Other specific terminal problems may be corrected by adding more capa- - bilities of the form xx. + Other specific terminal problems may be corrected by adding more + capabilities of the form xx.
- Long terminfo entries are unlikely to be a problem; to date, no entry - has even approached terminfo's 4096-byte string-table maximum. Unfor- - tunately, the termcap translations are much more strictly limited (to - 1023 bytes), thus termcap translations of long terminfo entries can + Long terminfo entries are unlikely to be a problem; to date, no entry + has even approached terminfo's 4096-byte string-table maximum. + Unfortunately, the termcap translations 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 tgetent 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 tgetent is searching for is, + The man pages for 4.3BSD and older versions of tgetent 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 tgetent is searching for is, several bad things can happen. - Some termcap libraries print a warning message or exit if they find an + Some termcap libraries print a warning message or exit if they find an entry that's longer than 1023 bytes; others do not; others truncate the - entries to 1023 bytes. Some application programs allocate more than + entries to 1023 bytes. Some application programs allocate more than the recommended 1K 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 + 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 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 particular terminal. This is the - length of the entry as it exists in /etc/termcap, minus the backslash- + The "before tc expansion" length is the most important one, because it + affects more than just users of that particular 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 libraries strip off the final newline, too (GNU termcap does not). Now suppose: @@ -2310,105 +2400,105 @@ o and the application has only allocated a 1k buffer, - o 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 + o 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 is the entry it wants, - o and tgetent is searching for a terminal type that either is the - long entry, appears in the termcap file after the long entry, or - does not appear in the file at all (so that tgetent has to search + o and tgetent is searching for a terminal type that either is the + long entry, appears in the termcap file after the long entry, or + does not appear in the file at all (so that tgetent has to search the whole termcap file). - Then tgetent will overwrite memory, perhaps its stack, and probably - core dump the program. Programs like telnet are particularly vulnera- - ble; modern telnets pass along values like the terminal type automati- - cally. The results are almost as undesirable with a termcap library, - like SunOS 4.1.3 and Ultrix 4.4, that prints warning messages when it - reads an overly long termcap entry. If a termcap library truncates - long entries, like OSF/1 3.0, it is immune to dying here but will - return incorrect data for the terminal. + Then tgetent 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 are almost as undesirable with a termcap + library, like SunOS 4.1.3 and Ultrix 4.4, that prints warning messages + when it reads an overly long termcap entry. If a termcap library + truncates long entries, like OSF/1 3.0, it is immune to dying here but + will return incorrect data for the terminal. - The "after tc expansion" length will have a similar effect to the + 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" expansion once it is found the terminal + since tgetent only does "tc" expansion 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 is too long even before - "tc" expansion, it will have this effect even for users of some other - terminal types and users whose TERM variable does not have a termcap + 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 is too long even before + "tc" expansion, it will have this effect even for users of some other + terminal types and users whose TERM variable does not have a termcap entry. - When in -C (translate to termcap) mode, the ncurses implementation of - tic(1m) issues warning messages when the pre-tc length of a termcap - translation is too long. The -c (check) option also checks resolved + When in -C (translate to termcap) mode, the ncurses implementation of + tic(1m) 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.
- It is not wise to count on portability of binary terminfo entries - between commercial UNIX versions. The problem is that there are at - least two versions of terminfo (under HP-UX and AIX) which diverged - from System V terminfo after SVr1, and have added extension capabili- - ties to the string table that (in the binary format) collide with Sys- - tem V and XSI Curses extensions. + It is not wise to count on portability of binary terminfo entries + between commercial UNIX versions. The problem is that there are at + least two versions of terminfo (under HP-UX and AIX) which diverged + from System V terminfo after SVr1, and have added extension + capabilities to the string table that (in the binary format) collide + with System V and XSI Curses extensions.
- Searching for terminal descriptions in $HOME/.terminfo and TER- - MINFO_DIRS is not supported by older implementations. + Searching for terminal descriptions in $HOME/.terminfo and + TERMINFO_DIRS is not supported by older implementations. - Some SVr4 curses implementations, and all previous to SVr4, do not + Some SVr4 curses implementations, and all previous to SVr4, do not interpret the %A and %O operators in parameter strings. - SVr4/XPG4 do not specify whether msgr licenses movement while in an - alternate-character-set mode (such modes may, among other things, map - CR and NL to characters that do not trigger local motions). The - ncurses implementation ignores msgr in ALTCHARSET mode. This raises - the possibility that an XPG4 implementation making the opposite inter- - pretation may need terminfo entries made for ncurses to have msgr + SVr4/XPG4 do not specify whether msgr licenses movement while in an + alternate-character-set mode (such modes may, among other things, map + CR and NL to characters that do not trigger local motions). The + ncurses implementation ignores msgr in ALTCHARSET mode. This raises + the possibility that an XPG4 implementation making the opposite + interpretation may need terminfo entries made for ncurses to have msgr turned off. The ncurses library handles insert-character and insert-character modes - in a slightly non-standard way to get better update efficiency. See + in a slightly non-standard way to get better update efficiency. See the Insert/Delete Character subsection above. - The parameter substitutions for set_clock and display_clock are not - documented in SVr4 or the XSI Curses standard. They are deduced from + The parameter substitutions for set_clock and display_clock are not + documented in SVr4 or the XSI Curses standard. They are deduced from the documentation for the AT&T 505 terminal. - Be careful assigning the kmous capability. The ncurses library wants - to interpret it as KEY_MOUSE, for use by terminals and emulators like - xterm that can return mouse-tracking information in the keyboard-input + Be careful assigning the kmous capability. The ncurses library wants + to interpret it as KEY_MOUSE, for use by terminals and emulators like + xterm that can return mouse-tracking information in the keyboard-input stream. - X/Open Curses does not mention italics. Portable applications must - assume that numeric capabilities are signed 16-bit values. This - includes the no_color_video (ncv) capability. The 32768 mask value - used for italics with ncv can be confused with an absent or cancelled - ncv. If italics should work with colors, then the ncv value must be + X/Open Curses does not mention italics. Portable applications must + assume that numeric capabilities are signed 16-bit values. This + includes the no_color_video (ncv) capability. The 32768 mask value + used for italics with ncv can be confused with an absent or cancelled + ncv. If italics should work with colors, then the ncv value must be specified, even if it is zero. - Different commercial ports of terminfo and curses support different - subsets of the XSI Curses standard and (in some cases) different exten- - sion sets. Here is a summary, accurate as of October 1995: + Different commercial ports of terminfo and curses support different + subsets of the XSI Curses standard and (in some cases) different + extension sets. Here is a summary, accurate as of October 1995: o SVR4, Solaris, ncurses -- These support all SVr4 capabilities. o SGI -- Supports the SVr4 set, adds one undocumented extended string capability (set_pglen). - o SVr1, Ultrix -- These support a restricted subset of terminfo capa- - bilities. The booleans end with xon_xoff; the numerics with + o SVr1, Ultrix -- These support a restricted subset of terminfo + capabilities. The booleans end with xon_xoff; the numerics with width_status_line; and the strings with prtr_non. - o HP/UX -- Supports the SVr1 subset, plus the SVr[234] numerics - num_labels, label_height, label_width, plus function keys 11 - through 63, plus plab_norm, label_on, and label_off, plus some + o HP/UX -- Supports the SVr1 subset, plus the SVr[234] numerics + num_labels, label_height, label_width, plus function keys 11 + through 63, plus plab_norm, label_on, and label_off, plus some incompatible extensions in the string table. - o AIX -- Supports the SVr1 subset, plus function keys 11 through 63, + o AIX -- Supports the SVr1 subset, plus function keys 11 through 63, plus a number of incompatible string table extensions. o OSF -- Supports both the SVr4 set and the AIX extensions. @@ -2419,8 +2509,9 @@
- tic(1m), infocmp(1m), curses(3x), curs_color(3x), printf(3), term(5). - term_variables(3x). user_caps(5). + infocmp(1m), tabs(1), tic(1m), curses(3x), curs_color(3x), + curs_variables(3x), printf(3), term_variables(3x). term(5). + user_caps(5).