X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fterminfo.5.html;h=33d86e2b62683039f9006c142cec0ca23b6c8482;hp=366da6548e31edd0b0195816a92efefb7161415c;hb=70322aa06a4a97ebff76d2869ad923cdf51ee0a9;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index 366da654..33d86e2b 100644 --- a/doc/html/man/terminfo.5.html +++ b/doc/html/man/terminfo.5.html @@ -6,7 +6,7 @@ * Note: this must be run through tbl before nroff. * The magic cookie on the first line triggers this under some man programs. **************************************************************************** - * Copyright (c) 1998-2000,2002 Free Software Foundation, Inc. * + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -32,23 +32,33 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: terminfo.head,v 1.10 2002/08/17 23:37:10 tom Exp @ + * @Id: terminfo.head,v 1.18 2010/07/31 16:08:48 tom Exp @ * Head of terminfo man page ends here - * @Id: terminfo.tail,v 1.35 2002/04/20 16:49:33 tom Exp @ + * @Id: terminfo.tail,v 1.53 2010/12/04 18:38:55 tom Exp @ * Beginning of terminfo.tail file + * This file is part of ncurses. + * See "terminfo.head" for copyright. + *.in -2 + *.in +2 + *.in -2 + *.in +2 *.TH -->
-+terminfo(5) File Formats terminfo(5) + + +
@@ -67,28 +77,39 @@ libraries such as curses(3x). Terminfo describes termi- nals by giving a set of capabilities which they have, by specifying how to perform screen operations, and by speci- - fying padding requirements and initialization sequences. + fying padding requirements and initialization sequences. + This describes ncurses version 5.7 (patch 20110122). Entries in terminfo consist of a sequence of `,' separated fields (embedded commas may be escaped with a backslash or - notated as \054). White space after the `,' separator is - ignored. The first entry for each terminal gives the - names which are known for the terminal, separated by `|' - characters. The first name given is the most common - abbreviation for the terminal, the last name given should - be a long name fully identifying the terminal, and all - others are understood as synonyms for the terminal name. + notated as \054). White space after the `,' separator is + ignored. The first entry for each terminal gives the + names which are known for the terminal, separated by `|' + characters. The first name given is the most common + abbreviation for the terminal, the last name given should + be a long name fully identifying the terminal, and all + others are understood as synonyms for the terminal name. All names but the last should be in lower case and contain - no blanks; the last name may well contain upper case and + no blanks; the last name may well contain upper case and blanks for readability. + Lines beginning with a `#' in the first column are treated + as comments. While comment lines are legal at any point, + the output of captoinfo and infotocap (aliases for tic) + will move comments so they occur only between entries. + + Newlines and leading tabs may be used for formatting + entries for readability. These are removed from parsed + entries. The infocmp -f option relies on this to format + if-then-else expressions: the result can be read by tic. + Terminal names (except for the last, verbose entry) should be chosen using the following conventions. The particular - piece of hardware making up the terminal should have a - root name, thus ``hp2621''. This name should not contain + piece of hardware making up the terminal should have a + root name, thus ``hp2621''. This name should not contain hyphens. Modes that the hardware can be in, or user pref- - erences, should be indicated by appending a hyphen and a - mode suffix. Thus, a vt100 in 132 column mode would be + erences, should be indicated by appending a hyphen and a + mode suffix. Thus, a vt100 in 132 column mode would be vt100-w. The following suffixes should be used where pos- sible: @@ -105,46 +126,47 @@ -rv Reverse video c100-rv -s Enable status line vt100-s -vb Use visible bell instead of beep wy370-vb + -w Wide mode (> 80 columns, usually 132) vt100-w - For more on terminal naming conventions, see the term(7) + For more on terminal naming conventions, see the term(7) manual page. Capabilities - The following is a complete table of the capabilities - included in a terminfo description block and available to + The following is a complete table of the capabilities + included in a terminfo description block and available to terminfo-using code. In each line of the table, - The variable is the name by which the programmer (at the + 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 are chosen to be the same as + 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). + by ECMA-48, which uses identical or very similar names). Semantics are also intended to match those of the specifi- cation. - The termcap code is the old termcap capability name (some + 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 infor- - mal limit of 5 characters has been adopted to keep them - short and to allow the tabs in the source file Caps to + Capability names have no hard length limit, but an infor- + mal limit of 5 characters has been adopted to keep them + short and to allow the tabs in the source file Caps to line up nicely. - Finally, the description field attempts to convey the - semantics of the capability. You may find some codes in + Finally, the description field attempts to convey the + semantics of the capability. You may find some codes in the description field: (P) indicates that padding may be specified - #[1-9] in the description field indicates that the string + #[1-9] in the description field indicates that the string is passed through tparm with parms as given (#i). - (P*) indicates that padding may vary in proportion to + (P*) indicates that padding may vary in proportion to the number of lines affected (#i) indicates the ith parameter. @@ -152,186 +174,189 @@ These are the boolean capabilities: - Variable Cap- TCap Description - Booleans name Code - auto_left_margin bw bw cub1 wraps from col- + + 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- + auto_right_margin am am terminal has auto- matic margins - back_color_erase bce ut screen erased with + back_color_erase bce ut screen erased with background color - can_change ccc cc terminal can re- + can_change ccc cc terminal can re- define existing col- ors - - ceol_standout_glitch xhp xs standout not erased + ceol_standout_glitch xhp xs standout not erased by overwriting (hp) - col_addr_glitch xhpa YA only positive motion + col_addr_glitch xhpa YA only positive motion for hpa/mhpa caps - cpi_changes_res cpix YF changing character + + + + cpi_changes_res cpix YF changing character pitch changes reso- lution - cr_cancels_micro_mode crxm YB using cr turns off + cr_cancels_micro_mode crxm YB using cr turns off micro mode - dest_tabs_magic_smso xt xt tabs destructive, + dest_tabs_magic_smso xt xt tabs destructive, magic so char (t1061) - eat_newline_glitch xenl xn newline ignored + eat_newline_glitch xenl xn newline ignored after 80 cols (con- cept) - erase_overstrike eo eo can erase over- + erase_overstrike eo eo can erase over- strikes with a blank - generic_type gn gn generic line type - hard_copy hc hc hardcopy terminal - hard_cursor chts HC cursor is hard to + generic_type gn gn generic line type + hard_copy hc hc hardcopy terminal + hard_cursor chts HC cursor is hard to see - has_meta_key km km Has a meta key + has_meta_key km km Has a meta key (i.e., sets 8th-bit) - has_print_wheel daisy YC printer needs opera- + has_print_wheel daisy YC printer needs opera- tor to change char- acter set - has_status_line hs hs has extra status + has_status_line hs hs has extra status line - hue_lightness_saturation hls hl terminal uses only + hue_lightness_saturation hls hl terminal uses only HLS color notation (Tektronix) - insert_null_glitch in in insert mode distin- + insert_null_glitch in in insert mode distin- guishes nulls - lpi_changes_res lpix YG changing line pitch + lpi_changes_res lpix YG changing line pitch changes resolution - memory_above da da display may be + memory_above da da display may be retained above the screen - memory_below db db display may be + memory_below db db display may be retained below the screen - move_insert_mode mir mi safe to move while + move_insert_mode mir mi safe to move while in insert mode - move_standout_mode msgr ms safe to move while + move_standout_mode msgr ms safe to move while in standout mode - needs_xon_xoff nxon nx padding will not + needs_xon_xoff nxon nx padding will not work, xon/xoff required - no_esc_ctlc xsb xb beehive (f1=escape, + no_esc_ctlc xsb xb beehive (f1=escape, f2=ctrl C) - no_pad_char npc NP pad character does + no_pad_char npc NP pad character does not exist - - - non_dest_scroll_region ndscr ND scrolling region is + non_dest_scroll_region ndscr ND scrolling region is non-destructive - non_rev_rmcup nrrmc NR smcup does not + non_rev_rmcup nrrmc NR smcup does not reverse rmcup - over_strike os os terminal can over- + over_strike os os terminal can over- strike - prtr_silent mc5i 5i printer will not + prtr_silent mc5i 5i printer will not echo on screen - row_addr_glitch xvpa YD only positive motion + row_addr_glitch xvpa YD only positive motion for vpa/mvpa caps - semi_auto_right_margin sam YE printing in last + semi_auto_right_margin sam YE printing in last column causes cr - status_line_esc_ok eslok es escape can be used + status_line_esc_ok eslok es escape can be used on the status line - tilde_glitch hz hz cannot print ~'s + tilde_glitch hz hz cannot print ~'s (hazeltine) - transparent_underline ul ul underline character + + + transparent_underline ul ul underline character overstrikes - xon_xoff xon xo terminal uses + xon_xoff xon xo terminal uses xon/xoff handshaking These are the numeric capabilities: - Variable Cap- TCap Description - Numeric name Code - columns cols co number of columns in + + Variable Cap- TCap Description + Numeric name Code + columns cols co number of columns in a line - init_tabs it it tabs initially every + init_tabs it it tabs initially every # spaces - label_height lh lh rows in each label - label_width lw lw columns in each + label_height lh lh rows in each label + label_width lw lw columns in each label - lines lines li number of lines on + lines lines li number of lines on screen or page - lines_of_memory lm lm lines of memory if > + lines_of_memory lm lm lines of memory if > line. 0 means varies - magic_cookie_glitch xmc sg number of blank + magic_cookie_glitch xmc sg number of blank characters left by smso or rmso - max_attributes ma ma maximum combined + max_attributes ma ma maximum combined attributes terminal can handle - max_colors colors Co maximum number of + max_colors colors Co maximum number of colors on screen - max_pairs pairs pa maximum number of + max_pairs pairs pa maximum number of color-pairs on the screen - maximum_windows wnum MW maximum number of + maximum_windows wnum MW maximum number of defineable windows - no_color_video ncv NC video attributes + no_color_video ncv NC video attributes that cannot be used with colors - - - num_labels nlab Nl number of labels on + num_labels nlab Nl number of labels on screen - padding_baud_rate pb pb lowest baud rate + padding_baud_rate pb pb lowest baud rate where padding needed - virtual_terminal vt vt virtual terminal + virtual_terminal vt vt virtual terminal number (CB/unix) - width_status_line wsl ws number of columns in + width_status_line wsl ws number of columns in status line - The following numeric capabilities are present in the - SVr4.0 term structure, but are not yet documented in the + The following numeric capabilities are present in the + SVr4.0 term structure, but are not yet documented in the man page. They came in with SVr4's printer support. - Variable Cap- TCap Description - Numeric name Code - bit_image_entwining bitwin Yo number of passes for + + Variable Cap- TCap Description + Numeric name Code + bit_image_entwining bitwin Yo number of passes for each bit-image row - bit_image_type bitype Yp type of bit-image + bit_image_type bitype Yp type of bit-image device - buffer_capacity bufsz Ya numbers of bytes + buffer_capacity bufsz Ya numbers of bytes buffered before printing - buttons btns BT number of buttons on + buttons btns BT number of buttons on mouse - dot_horz_spacing spinh Yc spacing of dots hor- + dot_horz_spacing spinh Yc spacing of dots hor- izontally in dots per inch - dot_vert_spacing spinv Yb spacing of pins ver- + + dot_vert_spacing spinv Yb spacing of pins ver- tically in pins per inch - max_micro_address maddr Yd maximum value in + max_micro_address maddr Yd maximum value in micro_..._address - max_micro_jump mjump Ye maximum value in + max_micro_jump mjump Ye maximum value in parm_..._micro - micro_col_size mcs Yf character step size + micro_col_size mcs Yf character step size when in micro mode - micro_line_size mls Yg line step size when + micro_line_size mls Yg line step size when in micro mode - number_of_pins npins Yh numbers of pins in + number_of_pins npins Yh numbers of pins in print-head - output_res_char orc Yi horizontal resolu- + output_res_char orc Yi horizontal resolu- tion in units per line - output_res_horz_inch orhi Yk horizontal resolu- + output_res_horz_inch orhi Yk horizontal resolu- tion in units per inch - output_res_line orl Yj vertical resolution + output_res_line orl Yj vertical resolution in units per line - output_res_vert_inch orvi Yl vertical resolution + output_res_vert_inch orvi Yl vertical resolution in units per inch - print_rate cps Ym print rate in char- + print_rate cps Ym print rate in char- acters per second - - - wide_char_size widcs Yn character step size + wide_char_size widcs Yn character step size when in double wide mode These are the string capabilities: + Variable Cap- TCap Description String name Code acs_chars acsc ac graphics charset @@ -364,6 +389,8 @@ 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 @@ -375,11 +402,9 @@ prototype !? create_window cwin CW define a window #1 from #2,#3 to #4,#5 - cursor_address cup cm move to row #1 - columns #2 + cursor_address cup cm move to row #1 col- + umns #2 cursor_down cud1 do down one line - - cursor_home home ho home cursor (if no cup) cursor_invisible civis vi make cursor invisi- @@ -431,9 +456,9 @@ enter_italics_mode sitm ZH Enter italic mode enter_leftward_mode slm ZI Start leftward car- riage motion + enter_micro_mode smicm ZJ Start micro-motion mode - enter_near_letter_quality snlq ZK Enter NLQ mode enter_normal_quality snrmq ZL Enter normal-quality mode @@ -487,7 +512,6 @@ flash_hook hook fh flash switch hook flash_screen flash vb visible bell (may not move cursor) - form_feed ff ff hardcopy terminal page eject (P*) from_status_line fsl fs return from status @@ -498,6 +522,7 @@ string init_2string is2 is initialization string + init_3string is3 i3 initialization string init_file if if name of initializa- @@ -540,8 +565,6 @@ in insert mode key_end kend @7 end key key_enter kent @8 enter/send key - - key_eol kel kE clear-to-end-of-line key key_eos ked kS clear-to-end-of- @@ -565,6 +588,7 @@ 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 @@ -595,7 +619,6 @@ key_f5 kf5 k5 F5 function key key_f50 kf50 Fe F50 function key key_f51 kf51 Ff F51 function key - key_f52 kf52 Fg F52 function key key_f53 kf53 Fh F53 function key key_f54 kf54 Fi F54 function key @@ -631,6 +654,7 @@ 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 @@ -649,7 +673,6 @@ key key_select kslt *6 select key key_send kEND *7 shifted end key - key_seol kEOL *8 shifted clear-to- end-of-line key key_sexit kEXT *9 shifted exit key @@ -696,14 +719,14 @@ 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 key f6 if not f6 lab_f7 lf7 l7 label on function key f7 if not f7 - - lab_f8 lf8 l8 label on function key f8 if not f8 lab_f9 lf9 l9 label on function @@ -757,12 +780,13 @@ sor in micro mode parm_rindex rin SR scroll back #1 lines (P) - parm_up_cursor cuu UP up #1 lines (P*) parm_up_micro mcuu Zi Like parm_up_cursor 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 @@ -811,7 +835,6 @@ line #1 or (if smgtp is not given) #2 lines from bottom - set_clock sclk SC set clock, #1 hrs #2 mins #3 secs set_color_pair scp sp Set current color @@ -829,6 +852,7 @@ umn set_right_margin_parm smgrp Zn Set right margin at column #1 + set_tab hts st set a tab in every row, current columns set_top_margin smgt Zo Set top margin at @@ -865,7 +889,6 @@ move past it up_half_line hu hu half a line up user0 u0 u0 User string #0 - user1 u1 u1 User string #1 user2 u2 u2 User string #2 user3 u3 u3 User string #3 @@ -885,6 +908,7 @@ 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 @@ -894,6 +918,7 @@ 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 @@ -919,7 +944,6 @@ mode exit_pc_charset_mode rmpch S3 Exit PC character display mode - exit_scancode_mode rmsc S5 Exit PC scancode mode get_mouse getm Gm Curses should get @@ -960,6 +984,7 @@ cap). set_page_length slines YZ Set page length to #1 lines + set_tb_margin smgtb MT Sets both top and bottom margins to #1, #2 @@ -972,8 +997,8 @@ these, they may not be binary-compatible with System V terminfo entries after SVr4.1; beware! - Variable Cap- TCap Description + Variable Cap- TCap Description String name Code enter_horizontal_hl_mode ehhlm Xh Enter horizontal highlight mode @@ -994,7 +1019,6 @@ to #1 hundredth of an inch - A Sample Entry The following entry, describing an ANSI-standard terminal, is representative of what a terminfo entry for a modern @@ -1031,7 +1055,6 @@ capabilities, which give a sequence which can be used to perform particular terminal operations. - Types of Capabilities All capabilities have names. For instance, the fact that ANSI-standard terminals have automatic margins (i.e., an @@ -1097,57 +1120,54 @@ variable as a list of colon- separated directories to be searched (an empty entry is interpreted as a command to search /usr/share/terminfo). If no description is found - in any of the TERMINFO_DIRS directories, the fetch fails. + in any of the TERMINFO_DIRS directories, the fetch fails. - If neither TERMINFO nor TERMINFO_DIRS is set, the last - place tried will be the system terminfo directory, + If neither TERMINFO nor TERMINFO_DIRS is set, the last + place tried will be the system terminfo directory, /usr/share/terminfo. - (Neither the $HOME/.terminfo lookups nor TERMINFO_DIRS - extensions are supported under stock System V ter- + (Neither the $HOME/.terminfo lookups nor TERMINFO_DIRS + extensions are supported under stock System V ter- minfo/curses.) - Preparing Descriptions - We now outline how to prepare descriptions of terminals. - The most effective way to prepare a terminal description - is by imitating the description of a similar terminal in - terminfo and to build up a description gradually, using + We now outline how to prepare descriptions of terminals. + The most effective way to prepare a terminal description + is by imitating the description of a similar terminal in + terminfo and to build up a description gradually, using partial descriptions with vi or some other screen-oriented - program to check that they are correct. Be aware that a + program to check that they are correct. Be aware that a very unusual terminal may expose deficiencies in the abil- - ity of the terminfo file to describe it or bugs in the + ity of the terminfo file to describe it or bugs in the screen-handling code of the test program. - To get the padding for insert line right (if the terminal + To get the padding for insert line right (if the terminal manufacturer did not document it) a severe test is to edit - a large file at 9600 baud, delete 16 or so lines from the - middle of the screen, then hit the `u' key several times - quickly. If the terminal messes up, more padding is usu- - ally needed. A similar test can be used for insert char- + a large file at 9600 baud, delete 16 or so lines from the + middle of the screen, then hit the `u' key several times + quickly. If the terminal messes up, more padding is usu- + ally needed. A similar test can be used for insert char- acter. - Basic Capabilities - The number of columns on each line for the terminal is - given by the cols numeric capability. If the terminal is - a CRT, then the number of lines on the screen is given by + The number of columns on each line for the terminal is + given by the cols numeric capability. If the terminal is + a CRT, then the number of lines on the screen is given by the lines capability. If the terminal wraps around to the - beginning of the next line when it reaches the right mar- + beginning of the next line when it reaches the right mar- gin, then it should have the am capability. If the termi- - nal can clear its screen, leaving the cursor in the home - position, then 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 termi- - nals.) 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 produce an audible signal (bell, beep, etc) give this - as bel. + nal can clear its screen, leaving the cursor in the home + position, then this is given by the clear string capabil- + ity. 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 car- + riage 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 @@ -1166,103 +1186,153 @@ left corner of the screen and send the ind (index) string. To scroll text down, a program goes to the top left corner - of the screen and sends the ri (reverse index) string. - The strings ind and ri are undefined when not on their + of the screen and sends the ri (reverse index) string. + The strings ind and ri are undefined when not on their respective corners of the screen. Parameterized versions of the scrolling sequences are indn and rin which have the same semantics as ind and ri except - that they take one parameter, and scroll that many lines. - They are also undefined except at the appropriate edge of + that they take one parameter, and scroll that many lines. + They are also undefined except at the appropriate edge of the screen. - The am capability tells whether the cursor sticks at the - right edge of the screen when text is output, but this + The am capability tells whether the cursor sticks at the + right edge of the screen when text is output, but this does not necessarily apply to a cuf1 from the last column. - The only local motion which is defined from the left edge - is if bw is given, then a cub1 from the left edge will - move to the right edge of the previous row. If bw is not - given, the effect is undefined. This is useful for draw- - ing 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 - 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 + The only local motion which is defined from the left edge + is if bw is given, then a cub1 from the left edge will + move to the right edge of the previous row. If bw is not + given, the effect is undefined. This is useful for draw- + ing 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 + 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" terminals. Thus the model 33 teletype is + "glass-tty" terminals. Thus the model 33 teletype is described as - 33|tty33|tty|model 33 teletype, - bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, + 33|tty33|tty|model 33 teletype, + bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, while the Lear Siegler ADM-3 is described as - adm3|3|lsi adm3, - am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, - ind=^J, lines#24, - + adm3|3|lsi adm3, + am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, + ind=^J, lines#24, Parameterized Strings - Cursor addressing and other strings requiring parameters - in the terminal are described by a parameterized string - capability, with printf(3S) like escapes %x in it. For - example, to address the cursor, the cup capability is + Cursor addressing and other strings requiring parameters + in the terminal are described by a parameterized string + capability, with printf(3) like escapes %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 + 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. Often more complex operations are necessary. + 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 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: - %% outputs `%' - %[[:]flags][width[.precision]][doxXs] - as in printf, flags are [-+#] and space - %c print pop() like %c in printf() - %s print pop() like %s in printf() - - %p[1-9] push i'th parm - %P[a-z] set dynamic variable [a-z] to pop() - %g[a-z] get dynamic variable [a-z] and push it - %P[A-Z] set static variable [a-z] to pop() - %g[A-Z] get static variable [a-z] and push it - %'c' char constant c - %{nn} integer constant nn - %l push strlen(pop) - - %+ %- %* %/ %m - arithmetic (%m is mod): push(pop() op pop()) - %& %| %^ bit operations: push(pop() op pop()) - %= %> %< logical operations: push(pop() op pop()) - %A, %O logical and & or operations (for conditionals) - %! %~ unary operations push(op pop()) - %i add 1 to first two parameters (for ANSI terminals) - - %? expr %t thenpart %e elsepart %; - if-then-else, %e elsepart is optional. - else-if's are possible a la Algol 68: - %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; - ci are conditions, bi are bodies. + %% outputs `%' + + %[[:]flags][width[.precision]][doxXs] + as in printf, flags are [-+#] and space. Use a `:' + to allow the next character to be a `-' flag, avoid- + ing interpreting "%-" as an operator. + + %c print pop() like %c in printf + + %s print pop() like %s in printf + + %p[1-9] + push i'th parameter + + %P[a-z] + set dynamic variable [a-z] to pop() + + %g[a-z] + get dynamic variable [a-z] and push it + + %P[A-Z] + set static variable [a-z] to pop() + + %g[A-Z] + get static variable [a-z] and push it + + The terms "static" and "dynamic" are misleading. + Historically, these are simply two different sets of + variables, whose values are not reset between calls + to tparm. However, that fact is not documented in + other implementations. Relying on it will adversely + impact portability to other implementations. + + %'c' char constant c + + %{nn} + integer constant nn + + %l push strlen(pop) + + %+ %- %* %/ %m + arithmetic (%m is mod): push(pop() op pop()) + + %& %| %^ + bit operations (AND, OR and exclusive-OR): push(pop() + op pop()) + + %= %> %< + logical operations: push(pop() op pop()) + + %A, %O + logical AND and OR operations (for conditionals) + + %! %~ + unary operations (logical and bit complement): + push(op pop()) + + %i add 1 to first two parameters (for ANSI terminals) + + %? expr %t thenpart %e elsepart %; + This forms an if-then-else. The %e elsepart is + optional. Usually the %? expr part pushes a value + onto the stack, and %t pops it from the stack, test- + ing if it is nonzero (true). If it is zero (false), + control passes to the %e (else) part. + + It is possible to form else-if's a la Algol 68: + %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; + + where ci are conditions, bi are bodies. + + Use the -f option of tic or infocmp to see the struc- + ture of if-then-else's. Some strings, e.g., sgr can + be very complicated when written on one line. The -f + option splits the string into lines with the parts + indented. Binary operations are in postfix form with the operands in - the usual order. That is, to get x-5 one would use - "%gx%{5}%-". %P and %g variables are persistent across + the usual 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 rows and columns is inverted - here, and that the row and column are printed as two dig- + needs to be sent \E&a12c03Y padded for 6 milliseconds. + Note that the order of the rows and columns is inverted + here, and that the row and column are printed as two dig- its. Thus its cup capability is "cup=6\E&%p2%2dc%p1%2dY". The Microterm ACT-IV needs the current row and column sent @@ -1285,7 +1355,6 @@ ter. Then the same is done for the second parameter. More complex arithmetic is possible using the stack. - Cursor Motions If the terminal has a fast way to home the cursor (to very upper left corner of screen) then this can be given as @@ -1325,7 +1394,6 @@ rmcup sequence is output (to the state prior to outputting rmcup), specify nrrmc. - Area Clears If the terminal can clear from the current position to the end of the line, leaving the cursor where it is, this @@ -1338,7 +1406,6 @@ (Thus, it can be simulated by a request to delete a large number of lines, if a true ed is not available.) - Insert/delete line and vertical motions If the terminal can open a new blank line before the line where the cursor is, this should be given as il1; this is @@ -1401,7 +1468,6 @@ lines up from below or that scrolling back with ri may bring down non-blank lines. - Insert/Delete Character There are two basic kinds of intelligent terminals with respect to insert/delete character which can be described @@ -1466,8 +1532,8 @@ of ich1 n times. If padding is necessary between characters typed while not - in insert mode, give this as a number of milliseconds - padding in rmp. + in insert mode, give this as a number of milliseconds pad- + ding in rmp. It is occasionally necessary to move around while in insert mode to delete characters on the same line (e.g., @@ -1488,7 +1554,6 @@ n blanks without moving the cursor) can be given as ech with one parameter. - Highlighting, Underlining, and Visible Bells If your terminal has one or more kinds of display attributes, these can be represented in a number of dif- @@ -1499,148 +1564,151 @@ plus half-bright is good, or reverse video alone.) The sequences to enter and exit standout mode are given as smso and rmso, respectively. If the code to change into - or out of standout mode leaves one or even two blank - spaces on the screen, as the TVI 912 and Teleray 1061 do, + or out of standout mode leaves one or even two blank spa- + ces on the screen, as the TVI 912 and Teleray 1061 do, then xmc should be given to tell how many spaces are left. - Codes to begin underlining and end underlining can be - given as smul and rmul respectively. If the terminal has - a code to underline the current character and move the + Codes to begin underlining and end underlining can be + given as smul and rmul respectively. If the terminal has + a code to underline the current character and move the cursor one space to the right, such as the Microterm Mime, this can be given as uc. - Other capabilities to enter various highlighting modes - include blink (blinking) bold (bold or extra bright) dim - (dim or half-bright) invis (blanking or invisible text) - prot (protected) rev (reverse video) sgr0 (turn off all - attribute modes) smacs (enter alternate character set - mode) and rmacs (exit alternate character set mode). - Turning on any of these modes singly may or may not turn + Other capabilities to enter various highlighting modes + include blink (blinking) bold (bold or extra bright) dim + (dim or half-bright) invis (blanking or invisible text) + prot (protected) rev (reverse video) sgr0 (turn off all + attribute modes) smacs (enter alternate character set + mode) and rmacs (exit alternate character set mode). + Turning on any of these modes singly may or may not turn off other modes. - If there is a sequence to set arbitrary combinations of - modes, this should be given as sgr (set attributes), tak- - ing 9 parameters. Each parameter is either 0 or nonzero, + If there is a sequence to set arbitrary combinations of + modes, this should be given as sgr (set attributes), tak- + ing 9 parameters. Each parameter is either 0 or nonzero, as the corresponding attribute is on or off. The 9 param- - eters 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 + eters 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 separate attribute commands exist. For example, the DEC vt220 supports most of the modes: - tparm parameter attribute escape sequence - - none none \E[0m - p1 standout \E[0;1;7m - p2 underline \E[0;4m - p3 reverse \E[0;7m - p4 blink \E[0;5m - p5 dim not available - p6 bold \E[0;1m - p7 invis \E[0;8m - p8 protect not used - p9 altcharset ^O (off) ^N (on) - - We begin each escape sequence by turning off any existing - modes, since there is no quick way to determine whether + tparm parameter attribute escape sequence + + none none \E[0m + p1 standout \E[0;1;7m + p2 underline \E[0;4m + p3 reverse \E[0;7m + p4 blink \E[0;5m + p5 dim not available + p6 bold \E[0;1m + p7 invis \E[0;8m + p8 protect not used + p9 altcharset ^O (off) ^N (on) + + We begin each escape sequence by turning off any existing + modes, since there is no quick way to determine whether they are active. Standout 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 era- - sures. 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 + 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 era- + sures. 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 exam- - ple, ;7 is output when either p1 or p3 is true, that is, + Some sequences are common to different modes. For exam- + ple, ;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 depen- + Writing out the above sequences, along with their depen- dencies yields - sequence when to output terminfo translation - - \E[0 always \E[0 - ;1 if p1 or p6 %?%p1%p6%|%t;1%; - ;4 if p2 %?%p2%|%t;4%; - ;5 if p4 %?%p4%|%t;5%; - ;7 if p1 or p3 %?%p1%p3%|%t;7%; - ;8 if p7 %?%p7%|%t;8%; + sequence when to output terminfo translation - m always m - ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; + \E[0 always \E[0 + ;1 if p1 or p6 %?%p1%p6%|%t;1%; + ;4 if p2 %?%p2%|%t;4%; + ;5 if p4 %?%p4%|%t;5%; + ;7 if p1 or p3 %?%p1%p3%|%t;7%; + ;8 if p7 %?%p7%|%t;8%; + m always m + ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; Putting this all together into the sgr sequence gives: sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p1%p3%|%t;7%; %?%p4%t;5%;%?%p7%t;8%;m%?%p9%t\016%e\017%;, - Remember that if you specify sgr, you must also specify - sgr0. - - 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 + Remember that if you specify sgr, you must also specify + sgr0. Also, some implementations rely on sgr being given + if sgr0 is, Not all terminfo entries necessarily have an + sgr string, however. Many terminfo entries are derived + from termcap entries which have no sgr string. The only + drawback to adding an sgr string is that termcap also + assumes that sgr0 does not exit alternate character set + mode. + + Terminals with the ``magic cookie'' glitch (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 indi- - cate an error quietly (a bell replacement) then this can + If the terminal has a way of flashing the screen to indi- + cate an error quietly (a bell replacement) then this can be given as flash; it must not move the cursor. - If the cursor needs to be made more visible than normal + If the cursor needs to be made more visible than normal when it is not on the bottom line (to make, for example, a - non-blinking underline into an easier to find block or + non-blinking underline into an easier to find block or blinking underline) give this sequence as cvvis. If there - is a way to make the cursor completely invisible, give + is a way to make the cursor completely invisible, give that as civis. The capability cnorm should be given which undoes the effects of both of these modes. If your terminal correctly generates underlined characters - (with no special codes needed) even though it does not - overstrike, then you should give the capability ul. If a - character overstriking another leaves both characters on + (with no special codes needed) even though it does not + overstrike, then you should give the capability ul. If a + character overstriking another leaves both characters on the screen, specify the capability os. If overstrikes are - erasable with a blank, then this should be indicated by + erasable with a blank, then this should be indicated by giving eo. - Keypad and Function Keys If the terminal has a keypad that transmits codes when the - keys are pressed, this information can be given. Note + keys are pressed, this information can be given. Note that it is not possible to handle terminals where the key- pad 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 + unshifted HP 2621 keys). If the keypad can be set 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 respectively. If there are - function keys such as f0, f1, ..., f10, the codes they - send can be given as kf0, kf1, ..., kf10. If these keys - have labels other than the default f0 through f10, the - labels can be given as lf0, lf1, ..., lf10. The codes - transmitted by certain other special keys can be given: - kll (home down), kbs (backspace), ktbc (clear all tabs), - kctab (clear the tab stop in this column), kclr (clear - screen or erase key), kdch1 (delete character), kdl1 - (delete line), krmir (exit insert mode), kel (clear to end - of line), ked (clear to end of screen), kich1 (insert - character or enter insert mode), kil1 (insert line), knp - (next page), kpp (previous page), kind (scroll for- - ward/down), kri (scroll backward/up), khts (set a tab stop - in this column). In addition, if the keypad has a 3 by 3 - array of keys including the four arrow keys, the other - five keys can be given as ka1, ka3, kb2, kc1, and kc3. - These keys are useful when the effects of a 3 by 3 direc- - tional pad are needed. + 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 respectively. If there are func- + tion keys such as f0, f1, ..., f10, the codes they send + can be given as kf0, kf1, ..., kf10. If these keys have + labels other than the default f0 through f10, the labels + can be given as lf0, lf1, ..., lf10. The codes transmit- + ted by certain other special keys can be given: kll (home + down), kbs (backspace), ktbc (clear all tabs), kctab + (clear the tab stop in this column), kclr (clear screen or + erase key), kdch1 (delete character), kdl1 (delete line), + krmir (exit insert mode), kel (clear to end of line), ked + (clear to end of screen), kich1 (insert character or enter + insert mode), kil1 (insert line), knp (next page), kpp + (previous page), kind (scroll forward/down), kri (scroll + backward/up), khts (set a tab stop in this column). In + addition, if the keypad has a 3 by 3 array of keys includ- + ing the four arrow keys, the other five keys can be given + as ka1, ka3, kb2, kc1, and kc3. These keys are useful + when the effects of a 3 by 3 directional pad are needed. Strings to program function keys can be given as pfkey, pfloc, and pfx. A string to program screen labels should @@ -1662,7 +1730,6 @@ or more pln sequences to make sure that the change becomes visible. - Tabs and Initialization If the terminal has hardware tabs, the command to advance to the next tab stop can be given as ht (usually control @@ -1670,13 +1737,13 @@ 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 pre- - sent, since the user may not have the tab stops properly - set. If the terminal has hardware tabs which are ini- - tially set every 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 + programs should not use ht or cbt even if they are + present, since the user may not have the tab stops prop- + erly set. If the terminal has hardware tabs which are + initially set every 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 @@ -1690,26 +1757,49 @@ 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; set the margins using mgc, smgl - and smgr; set tabs using tbc and hts; print the file if; - and finally output is3. + will be printed in the following order: + + run the program + iprog + + output is1 is2 + + set the margins using + mgc, smgl and smgr - Most initialization is done with is2. Special terminal + set tabs using + tbc and hts + + print the file + if + + 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 is2 and special cases in is1 and - is3. A pair of sequences that does a harder reset from a - totally unknown state can be analogously given as rs1, - rs2, rf, and rs3, analogous to is2 and if. 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 annoy- - ing effects on the screen and are not necessary when log- - ging in. For example, the command to set the vt100 into - 80-column mode would normally be part of is2, but it - causes an annoying glitch of the screen and is not nor- - mally needed since the terminal is usually already in 80 - column mode. + the common sequences in is2 and special cases in is1 and + is3. + + A set of sequences that does a harder reset from a totally + unknown state can be given as rs1, rs2, rf and rs3, analo- + gous 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 pro- + duce annoying effects on the screen and are not necessary + when logging in. For example, the command to set the + vt100 into 80-column mode would normally be part of 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 @@ -1719,7 +1809,7 @@ if. Delays and Padding - Many older and slower terminals don't support either + Many older and slower terminals do not support either XON/XOFF or DTR handshaking, including hard copy terminals and some very archaic CRTs (including, for example, DEC VT100s). These may require padding characters after cer- @@ -1730,7 +1820,7 @@ its input buffers are close to full), set xon. This capa- bility suppresses the emission of padding. You can also set it for memory-mapped console devices effectively that - don't have a speed limit. Padding information should + do not have a speed limit. Padding information should still be included so that routines can make better deci- sions about relative costs, but actual pad characters will not be transmitted. @@ -1744,7 +1834,6 @@ ter as a pad, then this can be given as pad. Only the first character of the pad string is used. - Status Lines Some terminals have an extra `status line' which is not normally used by software (and thus not counted in the @@ -1776,106 +1865,105 @@ 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. They are documented here in case they ever + The ncurses implementation does not yet use any of these + capabilities. They are documented here in case they ever become important. - Line Graphics - Many terminals have alternate character sets useful for - forms-drawing. Terminfo and curses build in support for - the drawing characters supported by the VT100, with some - characters from the AT&T 4410v1 added. This alternate + Many terminals have alternate character sets useful for + forms-drawing. Terminfo and curses build in support for + the drawing characters supported by the VT100, with some + characters from the AT&T 4410v1 added. This alternate character set may be specified by the acsc capability. - Glyph ACS Ascii VT100 - Name Name Default Name - UK pound sign ACS_STERLING f } - arrow pointing down ACS_DARROW v . - arrow pointing left ACS_LARROW < , - arrow pointing right ACS_RARROW > + - arrow pointing up ACS_UARROW ^ - - board of squares ACS_BOARD # h - bullet ACS_BULLET o ~ - checker board (stipple) ACS_CKBOARD : a - degree symbol ACS_DEGREE \ f - diamond ACS_DIAMOND + ` - greater-than-or-equal-to ACS_GEQUAL > z - greek pi ACS_PI * { - horizontal line ACS_HLINE - q - lantern symbol ACS_LANTERN # i - large plus or crossover ACS_PLUS + n - less-than-or-equal-to ACS_LEQUAL < y - lower left corner ACS_LLCORNER + m - lower right corner ACS_LRCORNER + j - not-equal ACS_NEQUAL ! | - plus/minus ACS_PLMINUS # g - scan line 1 ACS_S1 ~ o - scan line 3 ACS_S3 - p - scan line 7 ACS_S7 - r - scan line 9 ACS_S9 _ s - solid square block ACS_BLOCK # 0 - tee pointing down ACS_TTEE + w - tee pointing left ACS_RTEE + u - tee pointing right ACS_LTEE + t - tee pointing up ACS_BTEE + v - upper left corner ACS_ULCORNER + l - upper right corner ACS_URCORNER + k - vertical line ACS_VLINE | x - - The best way to define a new device's graphics set is to - add a column to a copy of this table for your terminal, - giving the character which (when emitted between - smacs/rmacs switches) will be rendered as the correspond- - ing graphic. Then read off the VT100/your terminal char- - acter pairs right to left in sequence; these become the + Glyph ACS Ascii VT100 + Name Name Default Name + UK pound sign ACS_STERLING f } + arrow pointing down ACS_DARROW v . + arrow pointing left ACS_LARROW < , + arrow pointing right ACS_RARROW > + + arrow pointing up ACS_UARROW ^ - + board of squares ACS_BOARD # h + bullet ACS_BULLET o ~ + checker board (stipple) ACS_CKBOARD : a + degree symbol ACS_DEGREE \ f + diamond ACS_DIAMOND + ` + greater-than-or-equal-to ACS_GEQUAL > z + greek pi ACS_PI * { + horizontal line ACS_HLINE - q + lantern symbol ACS_LANTERN # i + large plus or crossover ACS_PLUS + n + less-than-or-equal-to ACS_LEQUAL < y + lower left corner ACS_LLCORNER + m + lower right corner ACS_LRCORNER + j + not-equal ACS_NEQUAL ! | + plus/minus ACS_PLMINUS # g + scan line 1 ACS_S1 ~ o + scan line 3 ACS_S3 - p + scan line 7 ACS_S7 - r + scan line 9 ACS_S9 _ s + solid square block ACS_BLOCK # 0 + tee pointing down ACS_TTEE + w + tee pointing left ACS_RTEE + u + tee pointing right ACS_LTEE + t + tee pointing up ACS_BTEE + v + upper left corner ACS_ULCORNER + l + + upper right corner ACS_URCORNER + k + vertical line ACS_VLINE | x + + The best way to define a new device's graphics set is to + add a column to a copy of this table for your terminal, + giving the character which (when emitted between + smacs/rmacs switches) will be rendered as the correspond- + ing graphic. Then read off the VT100/your terminal char- + acter pairs right to left in sequence; these become the ACSC string. - Color Handling - Most color terminals are either `Tektronix-like' or `HP- - like'. Tektronix-like terminals have a predefined set of - N colors (where N usually 8), and can set character-cell + Most color terminals are either `Tektronix-like' or `HP- + like'. Tektronix-like terminals have a predefined set of + N colors (where N usually 8), and can set character-cell foreground and background characters independently, mixing - them into N * N color-pairs. On HP-like terminals, the + them into N * N color-pairs. On HP-like terminals, the use must set each color pair up separately (foreground and - background are not independently settable). Up to M - color-pairs may be set up from 2*M different colors. + background are not independently settable). Up to M + color-pairs may be set up from 2*M different colors. ANSI-compatible terminals are Tektronix-like. Some basic color capabilities are independent of the color method. The numeric capabilities 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 current background color - rather than the power-up default background; these should + the maximum numbers of colors and color-pairs that can be + displayed simultaneously. The 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 current background color + rather than the power-up default background; these should have the boolean capability bce. - 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 + 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 + setaf/setab; the XPG4 draft says that "If the terminal supports ANSI escape sequences to set background and fore- - ground, they should be coded as setaf and setab, respec- - tively. If the terminal supports other escape sequences - to set background and foreground, they should be coded as - setf and setb, respectively. The vidputs() function and - the refresh functions use setaf and setab if they are + ground, they should be coded as setaf and setab, respec- + tively. If the terminal supports other escape sequences + to set background and foreground, they should be coded as + setf and setb, respectively. The vidputs() function and + the refresh functions use setaf and setab if they are defined." - The setaf/setab and setf/setb capabilities take a single - numeric argument each. Argument values 0-7 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 locations in - color space. + 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 + locations in color space. Color #define Value RGB black COLOR_BLACK 0 0, 0, 0 @@ -1887,6 +1975,22 @@ cyan COLOR_CYAN 6 0,max,max white COLOR_WHITE 7 max,max,max + The argument values of setf/setb historically correspond + to a different mapping, i.e., + + Color #define Value RGB + black COLOR_BLACK 0 0, 0, 0 + blue COLOR_BLUE 1 0,0,max + green COLOR_GREEN 2 0,max,0 + cyan COLOR_CYAN 3 0,max,max + red COLOR_RED 4 max,0,0 + magenta COLOR_MAGENTA 5 max,0,max + 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 capa- + bilities; 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. @@ -1912,16 +2016,16 @@ ors are enabled. The correspondence with the attributes understood by curses is as follows: - Attribute Bit Decimal - A_STANDOUT 0 1 - A_UNDERLINE 1 2 - A_REVERSE 2 4 - A_BLINK 3 8 - A_DIM 4 16 - A_BOLD 5 32 - A_INVIS 6 64 - A_PROTECT 7 128 - A_ALTCHARSET 8 256 + Attribute Bit Decimal + A_STANDOUT 0 1 + A_UNDERLINE 1 2 + A_REVERSE 2 4 + A_BLINK 3 8 + A_DIM 4 16 + A_BOLD 5 32 + A_INVIS 6 64 + A_PROTECT 7 128 + A_ALTCHARSET 8 256 For example, on many IBM PC consoles, the underline attribute collides with the foreground color blue and is @@ -1931,7 +2035,6 @@ SVr4 curses does nothing with ncv, ncurses recognizes it and optimizes the output in favor of colors. - Miscellaneous If the terminal requires other than a null (zero) charac- ter as a pad, then this can be given as pad. Only the @@ -2005,7 +2108,6 @@ text, including mc4, is transparently passed to the printer while an mc5p is in effect. - Glitches and Braindamage Hazeltine terminals, which do not allow `~' characters to be displayed should indicate hz. @@ -2013,207 +2115,207 @@ 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 normal text on top of it), xhp should be + 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- + 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 + not possible to position the cursor on top of a ``magic cookie'', that to erase standout mode it is instead neces- sary to use delete and insert line. The ncurses implemen- tation ignores this glitch. - The Beehive Superbee, which is unable to correctly trans- - mit the escape or control C characters, has xsb, indicat- - ing 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 + The Beehive Superbee, which is unable to correctly trans- + mit the escape or control C characters, has xsb, indicat- + ing 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 + Other specific terminal problems may be corrected by adding more capabilities of the form xx. - Similar Terminals 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 vari- - ant, the string capability use can be given with the name - of the base terminal. The capabilities given before use - override those in the base type named by use. 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. Capabili- - ties given explicitly in the entry override those brought + can be defined as being just like the other (the base) + with certain exceptions. In the definition of the vari- + ant, the string capability use can be given with the name + of the base terminal. The capabilities given before use + override those in the base type named by use. 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. Capabili- + ties 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 reference that imports it, where xx is the capa- + the use reference that imports it, where xx is the capa- bility. 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 user preferences. + 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 user preferences. Pitfalls of Long Entries - Long terminfo entries are unlikely to be a problem; to - date, no entry has even approached terminfo's 4K string- - table maximum. Unfortunately, the termcap translations - are much more strictly limited (to 1K), thus termcap - translations of long terminfo entries can cause problems. - - The man pages for 4.3BSD and older versions of tgetent() - instruct the user to allocate a 1K buffer for the termcap - entry. The entry gets null-terminated by the termcap - library, so that makes the maximum safe length for a term- - cap entry 1k-1 (1023) bytes. Depending on what the appli- - cation and the termcap library being used does, and where - in the termcap file the terminal type that tgetent() is - searching for is, several bad things can happen. - - Some termcap libraries print a warning message or exit if - they find an entry that's longer than 1023 bytes; others - don't; others truncate the entries to 1023 bytes. Some + 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 transla- + tions are much more strictly limited (to 1023 bytes), thus + termcap translations of long terminfo entries can cause + problems. + + The man pages for 4.3BSD and older versions of 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 entry that's longer than 1023 bytes; others + do not; others truncate the entries to 1023 bytes. Some application programs allocate more than the recommended 1K - for the termcap entry; others don't. + for the termcap entry; others do not. Each termcap entry has two important sizes associated with it: before "tc" expansion, and after "tc" expansion. "tc" - is the capability that tacks on another termcap entry to - the end of the current one, to add on its capabilities. - If a termcap entry doesn't use the "tc" capability, then + 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 par- - ticular terminal. This is the length of the entry as it + The "before tc expansion" length is the most important + one, because it affects more than just users of that par- + ticular terminal. This is the length of the entry as it exists in /etc/termcap, minus the backslash-newline pairs, - which tgetent() strips out while reading it. Some termcap - libraries strip off the final newline, too (GNU termcap + which tgetent() strips out while reading it. Some termcap + libraries strip off the final newline, too (GNU termcap does not). Now suppose: - * a termcap entry before expansion is more than 1023 + * a termcap entry before expansion is more than 1023 bytes long, * and the application has only allocated a 1k buffer, - * and the termcap library (like the one in BSD/OS 1.1 - and GNU) reads the whole entry into the buffer, no - matter what its length, to see if it's the entry it + * 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, - * and tgetent() is searching for a terminal type that + * and tgetent() is searching for a terminal type that either is the long entry, appears in the termcap file - after the long entry, or doesn't appear in the file - at all (so that tgetent() has to search the whole + after the long entry, or does not appear in the file + at all (so that 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 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 + 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 above, but only for people who actually set TERM to - that terminal type, since tgetent() only does "tc" expan- - sion once it's found the terminal type it was looking for, - not while searching. + that terminal type, since tgetent() only does "tc" expan- + sion once it is found the terminal type it was looking + for, not while searching. In summary, a termcap entry that is longer than 1023 bytes - can cause, on various combinations of termcap libraries - and applications, a core dump, warnings, or incorrect - operation. If it's too long even before "tc" expansion, + 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 ter- - minal types and users whose TERM variable does not have a + minal types and users whose TERM variable does not have a termcap entry. When in -C (translate to termcap) mode, the ncurses imple- - mentation of tic(1) 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) + mentation 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. Binary Compatibility - 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 + 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 + SVr1, and have added extension capabilities to the string + table that (in the binary format) collide with System V and XSI Curses extensions.
- Some SVr4 curses implementations, and all previous to - SVr4, don't 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 don't - trigger local motions). The ncurses implementation - ignores msgr in ALTCHARSET mode. This raises the possi- - bility that an XPG4 implementation making the opposite - interpretation may need terminfo entries made for ncurses + Some SVr4 curses implementations, and all previous to + SVr4, do not interpret the %A and %O operators in parame- + ter 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 possi- + bility 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- + The ncurses library handles insert-character and insert- character modes in a slightly non-standard way to get bet- - ter update efficiency. See the Insert/Delete Character + ter update efficiency. See the Insert/Delete Character subsection above. - The parameter substitutions for set_clock and dis- - play_clock are not documented in SVr4 or the XSI Curses + The parameter substitutions for set_clock and dis- + play_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 - wants to interpret it as KEY_MOUSE, for use by terminals - and emulators like xterm that can return mouse-tracking + Be careful assigning the kmous capability. The ncurses + 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. - Different commercial ports of terminfo and curses support - different subsets of the XSI Curses standard and (in some + 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, accu- rate as of October 1995: SVR4, Solaris, ncurses -- These support all SVr4 capabili- ties. - SGI -- Supports the SVr4 set, adds one undocumented + SGI -- Supports the SVr4 set, adds one undocumented extended string capability (set_pglen). - SVr1, Ultrix -- These support a restricted subset of ter- - minfo capabilities. The booleans end with xon_xoff; the - numerics with width_status_line; and the strings with + SVr1, Ultrix -- These support a restricted subset of ter- + minfo capabilities. The booleans end with xon_xoff; the + numerics with width_status_line; and the strings with prtr_non. - HP/UX -- Supports the SVr1 subset, plus the SVr[234] + HP/UX -- Supports the SVr1 subset, plus the SVr[234] numerics num_labels, label_height, label_width, plus func- - tion keys 11 through 63, plus plab_norm, label_on, and + tion keys 11 through 63, plus plab_norm, label_on, and label_off, plus some incompatible extensions in the string table. - AIX -- Supports the SVr1 subset, plus function keys 11 - through 63, plus a number of incompatible string table + AIX -- Supports the SVr1 subset, plus function keys 11 + through 63, plus a number of incompatible string table extensions. - OSF -- Supports both the SVr4 set and the AIX extensions. + OSF -- Supports both the SVr4 set and the AIX extensions.@@ -2222,64 +2324,20 @@ descriptions -
- tic(1m), curses(3x), printf(3S), term(5). + tic(1m), infocmp(1m), curses(3x), printf(3), term(5). + term_variables(3x).
- Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + terminfo(5)