X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fterminfo.5.html;h=90e75e532ecf1e2a5e4e2497b43ded352c50c42a;hp=9ca502dd107b1020ac56a89577c74d78370cab89;hb=f367fa254ce3fe29710c86971f04e03111c2bd2c;hpb=77afe78361875f531dc2bf8d73f2e781c8e76176 diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index 9ca502dd..90e75e53 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-2007,2009 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,9 +32,9 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: terminfo.head,v 1.17 2009/09/19 19:59:38 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.50 2009/09/19 19:56:15 tom Exp @ + * @Id: terminfo.tail,v 1.55 2011/12/17 23:19:59 tom Exp @ * Beginning of terminfo.tail file * This file is part of ncurses. * See "terminfo.head" for copyright. @@ -78,7 +78,7 @@ 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. - This describes ncurses version 5.7 (patch 20100109). + This describes ncurses version 5.9 (patch 20120107). Entries in terminfo consist of a sequence of `,' separated fields (embedded commas may be escaped with a backslash or @@ -113,6 +113,7 @@ vt100-w. The following suffixes should be used where pos- sible: + Suffix Meaning Example -nn Number of lines on the screen aaa-60 -np Number of pages of memory c100-4p @@ -125,8 +126,8 @@ -ns No status line hp2626-ns -rv Reverse video c100-rv -s Enable status line vt100-s - -vb Use visible bell instead of beep wy370-vb + -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) @@ -175,134 +176,133 @@ 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 @@ -310,47 +310,47 @@ 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 @@ -402,8 +402,8 @@ 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) @@ -904,8 +904,8 @@ zero_motion zerom Zx No motion for subse- quent character - The following string capabilities are present in the - SVr4.0 term structure, but were originally not documented + The following string capabilities are present in the + SVr4.0 term structure, but were originally not documented in the man page. @@ -989,13 +989,14 @@ bottom margins to #1, #2 - The XSI Curses standard added these. They are some - post-4.1 versions of System V curses, e.g., Solaris 2.5 - and IRIX 6.x. 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! + The XSI Curses standard added these hardcopy capabili- + ties. 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. Accord- + ing 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! Variable Cap- TCap Description @@ -1015,9 +1016,11 @@ set_a_attributes sgr1 sA Define second set of video attributes #1-#6 - set_pglen_inch slengthsL YI Set page length - to #1 hundredth of - an inch + set_pglen_inch slengthYI Set page length to + #1 hundredth of an + inch (some implemen- + tations use sL for + termcap). A Sample Entry The following entry, describing an ANSI-standard terminal, @@ -1055,6 +1058,7 @@ 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 @@ -1106,6 +1110,7 @@ To do this, put a period before the capability name. For example, see the second ind in the example above. + Fetching Compiled Descriptions If the environment variable TERMINFO is set, it is inter- preted as the pathname of a directory containing the com- @@ -1117,72 +1122,75 @@ $HOME/.terminfo for a compiled description. If it fails to find one there, and the environment variable TER- MINFO_DIRS is set, it will interpret the contents of that - 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. - - If neither TERMINFO nor TERMINFO_DIRS is set, the last - place tried will be the system terminfo directory, + variable as a list of colon- separated directories (or + database files) to be searched (an empty entry is inter- + preted as a command to search /usr/share/terminfo). If no + description is found in any of the TERMINFO_DIRS directo- + ries, the fetch fails. + + 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 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 + 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 + 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 - as cub1. Similarly, codes to move to the right, up, and + If there is a code to move the cursor one position to the + left (such as backspace) that capability should be given + as cub1. Similarly, codes to move to the right, up, and down should be given as cuf1, cuu1, and cud1. These local - cursor motions should not alter the text they pass over, - for example, you would not normally use `cuf1= ' because + cursor motions should not alter the text they pass over, + for example, you would not normally use `cuf1= ' because the space would erase the character moved over. - A very important point here is that the local cursor - motions encoded in terminfo are undefined at the left and - top edges of a CRT terminal. Programs should never - attempt to backspace around the left edge, unless bw is + A very important point here is that the local cursor + motions encoded in terminfo are undefined at the left and + top edges of a CRT terminal. Programs should never + attempt to backspace around the left edge, unless bw is given, and never attempt to go up locally off the top. In - order to scroll text up, a program will go to the bottom + order to scroll text up, a program will go to the bottom left corner of the screen and send the ind (index) string. To scroll text down, a program goes to the top left corner @@ -1226,6 +1234,7 @@ 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 @@ -1247,6 +1256,7 @@ The % encodings have the following meanings: + %% outputs `%' %[[:]flags][width[.precision]][doxXs] @@ -1319,20 +1329,20 @@ where ci are conditions, bi are bodies. Use the -f option of tic or infocmp to see the struc- - ture of if-the-else's. Some strings, e.g., sgr can + 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 + 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 @@ -1355,6 +1365,7 @@ 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 @@ -1394,6 +1405,7 @@ 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 @@ -1406,6 +1418,7 @@ (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 @@ -1468,6 +1481,7 @@ 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 @@ -1502,10 +1516,10 @@ blank position on the current line. Give as smir the sequence to get into insert mode. Give as rmir the sequence to leave insert mode. Now give as ich1 any - sequence needed to be sent just before sending the charac- - ter to be inserted. Most terminals with a true insert - mode will not give ich1; terminals which send a sequence - to open a screen position should give it here. + sequence needed to be sent just before sending the + character to be inserted. Most terminals with a true + insert mode will not give ich1; terminals which send a + sequence to open a screen position should give it here. If your terminal has both, insert mode is usually prefer- able to ich1. Technically, you should not give both @@ -1532,8 +1546,8 @@ of ich1 n times. If padding is necessary between characters typed while not - in insert mode, give this as a number of milliseconds pad- - ding in rmp. + in insert mode, give this as a number of milliseconds + padding in rmp. It is occasionally necessary to move around while in insert mode to delete characters on the same line (e.g., @@ -1554,6 +1568,7 @@ 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- @@ -1564,199 +1579,204 @@ 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 spa- - ces on the screen, as the TVI 912 and Teleray 1061 do, + or out of standout mode leaves one or even two blank + spaces 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%; - m always m - ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; + 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%; + + 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. 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 + 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 + 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 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 + 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 + 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 + 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 + 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 - be specified as pln. Each of these strings takes two - parameters: the function key number to program (from 0 to - 10) and the string to program it with. Function key num- - bers out of this range may program undefined keys in a - terminal dependent manner. The difference between the - capabilities is that pfkey causes pressing the given key - to be the same as the user typing the given string; pfloc + Strings to program function keys can be given as pfkey, + pfloc, and pfx. A string to program screen labels should + be specified as pln. Each of these strings takes two + parameters: the function key number to program (from 0 to + 10) and the string to program it with. Function key num- + bers out of this range may program undefined keys in a + terminal dependent manner. The difference between the + capabilities is that pfkey causes pressing the given key + to be the same as the user typing the given string; pfloc causes the string to be executed by the terminal in local; - and pfx causes the string to be transmitted to the com- + and pfx causes the string to be transmitted to the com- puter. The capabilities nlab, lw and lh define the number of pro- - grammable 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 normally output after one + grammable 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 normally output after one 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 - I). A ``back-tab'' command which moves leftward to the + 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 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 + 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 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 they are properly set. - Other capabilities include is1, is2, and is3, initializa- - tion strings for the terminal, iprog, the path name of a - program to be run to initialize the terminal, 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. + Other capabilities include is1, is2, and is3, initializa- + tion strings for the terminal, iprog, the path name of a + program to be run to initialize the terminal, 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 + of the tput program, each time the user logs in. They will be printed in the following order: run the program @@ -1776,99 +1796,101 @@ and finally output is3. - Most initialization is done with is2. Special terminal + 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 + 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 + 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., + 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 + 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 com- - plex sequence is needed to set the tabs than can be - described by this, the sequence can be placed in is2 or + be given as tbc (clear all tab stops) and hts (set a tab + stop in the current column of every row). If a more com- + plex sequence is needed to set the tabs than can be + described by this, the sequence can be placed in is2 or if. Delays and Padding - Many older and slower terminals do not 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- + and some very archaic CRTs (including, for example, DEC + VT100s). These may require padding characters after cer- tain 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 + (that is, it automatically emits ^S back to the host when 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 - do not have a speed limit. Padding information should - still be included so that routines can make better deci- + bility 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 deci- sions 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 whether padding is emitted or not + 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 whether padding is emitted or not is completely controlled by xon. - If the terminal requires other than a null (zero) charac- - ter as a pad, then this can be given as pad. Only the + If the terminal requires other than a null (zero) charac- + ter as a pad, then this can be given as pad. Only the first character of the pad string is used. + Status Lines - Some terminals have an extra `status line' which is not - normally used by software (and thus not counted in the + 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 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 scrolling - region set up on initialization. This situation is indi- + 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 scrolling + region set up on initialization. This situation is indi- cated by the hs capability. Some terminals with status lines need special sequences to - access the status line. These may be expressed as a + 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 capa- + a given zero-origin column on the status line. The capa- bility 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 + 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 + 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 speci- + A command to erase or blank the status line may be speci- fied as dsl. - The boolean capability eslok specifies that escape + 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 become important. + Line Graphics Many terminals have alternate character sets useful for forms-drawing. Terminfo and curses build in support for @@ -1876,41 +1898,42 @@ 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 + + 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, @@ -1920,6 +1943,7 @@ 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 @@ -1965,6 +1989,7 @@ 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 red COLOR_RED 1 max,0,0 @@ -2016,16 +2041,17 @@ 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 @@ -2035,6 +2061,7 @@ 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 @@ -2108,6 +2135,7 @@ 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. @@ -2115,207 +2143,209 @@ 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, + 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 + 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 4096-byte + 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 + 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 + 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 + 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 + 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 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 does not 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 + 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 is 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 does not 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 is found the terminal type it was looking + 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 is 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(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) + 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.

EXTENSIONS

-       Some SVr4 curses  implementations,  and  all  previous  to
-       SVr4,  do not interpret the %A and %O operators in parame-
+       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
+       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.
@@ -2326,12 +2356,13 @@

SEE ALSO

-       tic(1m), infocmp(1m), curses(3x), printf(3), term(5).
+       tic(1m),   infocmp(1m),  curses(3x),  printf(3),  term(5).
+       term_variables(3x).

AUTHORS

-       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.