X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fterminfo.5.html;h=40f2770f6d9f4dbf84679478e2a478eec2644e66;hp=d0ceccfb7b09dfb65f6cbbe61b70d791a61d0c12;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hpb=603f0cb25b7acc8f04f4b18d2a2fe6f90039829a;ds=sidebyside diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index d0ceccfb..40f2770f 100644 --- a/doc/html/man/terminfo.5.html +++ b/doc/html/man/terminfo.5.html @@ -5,7 +5,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-2012,2013 Free Software Foundation, Inc. * + * Copyright (c) 1998-2013,2016 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -31,9 +31,9 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: terminfo.head,v 1.21 2013/03/09 22:11:36 tom Exp @ + * @Id: terminfo.head,v 1.22 2016/10/15 17:02:31 tom Exp @ * Head of terminfo man page ends here - * @Id: terminfo.tail,v 1.69 2015/04/26 14:47:23 tom Exp @ + * @Id: terminfo.tail,v 1.76 2017/01/07 18:32:49 tom Exp @ * Beginning of terminfo.tail file * This file is part of ncurses. * See "terminfo.head" for copyright. @@ -75,7 +75,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 6.0 (patch 20160611). + This describes ncurses version 6.0 (patch 20170114). Entries in terminfo consist of a sequence of `,' separated fields (embedded commas may be escaped with a backslash or @@ -1167,56 +1167,63 @@ A delay in milliseconds may appear anywhere in a string capability, enclosed in $<..> brackets, as in el=\EK$<5>, - and padding characters are supplied by tputs to provide - this delay. The delay must be a number with at most one - decimal place of precision; it may be followed by suffixes - "*" or "/" or both. A "*" indicates that the padding - required is proportional to the number of lines affected - by the operation, and the amount given is the per- - affected-unit padding required. (In the case of insert - character, the factor is still the number of lines - affected.) Normally, padding is advisory if the device - has the xon capability; it is used for cost computation - but does not trigger delays. A "/" suffix indicates that - the padding is mandatory and forces a delay of the given - number of milliseconds even on devices for which xon is - present to indicate flow control. - - Sometimes individual capabilities must be commented out. - To do this, put a period before the capability name. For + and padding characters are supplied by tputs(3x) to pro- + vide this delay. + + o The delay must be a number with at most one decimal + place of precision; it may be followed by suffixes "*" + or "/" or both. + + o A "*" indicates that the padding required is propor- + tional to the number of lines affected by the opera- + tion, and the amount given is the per-affected-unit + padding required. (In the case of insert character, + the factor is still the number of lines affected.) + + Normally, padding is advisory if the device has the + xon capability; it is used for cost computation but + does not trigger delays. + + o A "/" suffix indicates that the padding is mandatory + and forces a delay of the given number of milliseconds + even on devices for which xon is present to indicate + flow control. + + Sometimes individual capabilities must be commented out. + To do this, put a period before the capability name. For example, see the second ind in the example above.
- The ncurses library searches for terminal descriptions in + The ncurses library searches for terminal descriptions in several places. It uses only the first description found. - The library has a compiled-in list of places to search - which can be overridden by environment variables. Before - starting to search, ncurses eliminates duplicates in its + The library has a compiled-in list of places to search + which can be overridden by environment variables. Before + starting to search, ncurses eliminates duplicates in its search list. - o If the environment variable TERMINFO is set, it is - interpreted as the pathname of a directory containing - the compiled description you are working on. Only + o If the environment variable TERMINFO is set, it is + interpreted as the pathname of a directory containing + the compiled description you are working on. Only that directory is searched. - o If TERMINFO is not set, ncurses will instead look in - the directory $HOME/.terminfo for a compiled descrip- + o If TERMINFO is not set, ncurses will instead look in + the directory $HOME/.terminfo for a compiled descrip- tion. - o Next, if the environment variable TERMINFO_DIRS is + o Next, if the environment variable TERMINFO_DIRS is set, ncurses will interpret the contents of that vari- - able as a list of colon-separated directories (or + able as a list of colon-separated directories (or database files) to be searched. - An empty directory name (i.e., if the variable begins - or ends with a colon, or contains adjacent colons) is - interpreted as the system location /usr/share/ter- + An empty directory name (i.e., if the variable begins + or ends with a colon, or contains adjacent colons) is + interpreted as the system location /usr/share/ter- minfo. o Finally, ncurses searches these compiled-in locations: - o a list of directories + o a list of directories (/usr/local/ncurses/share/terminfo:/usr/share/ter- minfo), and @@ -1225,91 +1232,91 @@
- 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.
- 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 - 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, @@ -1323,21 +1330,21 @@
- Cursor addressing and other strings requiring parameters - in the terminal are described by a parameterized string - capability, with printf-like escapes such as %x in it. - For example, to address the cursor, the cup capability is + Cursor addressing and other strings requiring parameters + in the terminal are described by a parameterized string + capability, with printf-like escapes such as %x in it. + For example, to address the cursor, the cup capability is given, using two parameters: the row and column to address to. (Rows and columns are numbered from zero and refer to the physical screen visible to the user, not to any unseen - memory.) If the terminal has memory relative cursor + memory.) If the terminal has memory relative cursor addressing, that can be indicated by mrcup. - The parameter mechanism uses a stack and special % codes - to manipulate it. Typically a sequence will push one of - the parameters onto the stack and then print it in some - format. Print (e.g., "%d") is a special case. Other - operations, including "%t" pop their operand from the + 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. @@ -1346,19 +1353,19 @@ %% outputs "%" %[[:]flags][width[.precision]][doxXs] - as in printf, flags are [-+#] and space. Use a ":" - to allow the next character to be a "-" flag, avoid- + 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 + %c print pop() like %c in printf - %s print pop() like %s 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() + set dynamic variable [a-z] to pop() %g[a-z]/ get dynamic variable [a-z] and push it @@ -1369,12 +1376,13 @@ %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. + 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(3x). However, that fact is not documented + in other implementations. Relying on it will + adversely impact portability to other implementa- + tions. %'c' char constant c @@ -1384,7 +1392,7 @@ %l push strlen(pop) %+, %-, %*, %/, %m - arithmetic (%m is mod): push(pop() op pop()) + arithmetic (%m is mod): push(pop() op pop()) %&, %|, %^ bit operations (AND, OR and exclusive-OR): push(pop() @@ -1398,7 +1406,7 @@ %!, %~ unary operations (logical and bit complement): - push(op pop()) + push(op pop()) %i add 1 to first two parameters (for ANSI terminals) @@ -1552,7 +1560,7 @@ late destructive scrolling; their documentation cautions you not to define csr unless this is true. This curses implementation is more liberal and will do explicit erases - after scrolling if ndstr is defined. + after scrolling if ndsrc is defined. If the terminal has the ability to define a window as part of memory, which all commands affect, it should be given @@ -1879,7 +1887,7 @@ 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 + 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 @@ -1892,7 +1900,7 @@ 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 @@ -1920,7 +1928,7 @@ 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 + 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 @@ -1930,10 +1938,10 @@ normally needed since the terminal is usually already in 80 column mode. - The reset program writes strings including iprog, etc., in + 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 + capability strings are missing, the reset program falls back upon the corresponding initialization capability string. @@ -2060,41 +2068,57 @@
- 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 - 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. - ANSI-compatible terminals are Tektronix-like. + The curses library functions init_pair and init_color + manipulate the color pairs and color values discussed in + this section (see curs_color(3x) for details on these and + related functions). + + Most color terminals are either "Tektronix-like" or "HP- + like": + + o Tektronix-like terminals have a predefined set of N + colors (where N is usually 8), and can set character- + cell foreground and background characters indepen- + dently, mixing them into N * N color-pairs. + + o On HP-like terminals, the user must set each color + pair up separately (foreground and background are not + independently settable). Up to M color-pairs may be + set up from 2*M different colors. ANSI-compatible + terminals are Tektronix-like. Some basic color capabilities are independent of the color method. The numeric capabilities colors and pairs specify - the maximum numbers of colors and color-pairs that can be - displayed simultaneously. The op (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 - color number. The SVr4 documentation describes only - setaf/setab; the XPG4 draft says that "If the terminal - supports ANSI escape sequences to set background and 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 - defined." + While the curses library works with color pairs (reflect- + ing the inability of some devices to set foreground and + background colors independently), there are separate capa- + bilities for setting these features: + + o To change the current foreground or background color + on a Tektronix-type terminal, use setaf (set ANSI + foreground) and setab (set ANSI background) or setf + (set foreground) and setb (set background). These + take one parameter, the color number. The SVr4 docu- + mentation describes only setaf/setab; the XPG4 draft + says that "If the terminal supports ANSI escape + sequences to set background and foreground, they + should be coded as setaf and setab, respectively. + + o If the terminal supports other escape sequences to set + background and foreground, they should be coded as + setf and setb, respectively. The vidputs and the + refresh(3x) functions use the setaf and setab capabil- + ities if they are defined. The setaf/setab and setf/setb capabilities take a single numeric argument each. Argument values 0-7 of setaf/setab @@ -2112,6 +2136,7 @@ blue COLOR_BLUE 4 0,0,max magenta COLOR_MAGENTA 5 max,0,max cyan COLOR_CYAN 6 0,max,max + white COLOR_WHITE 7 max,max,max The argument values of setf/setb historically correspond @@ -2134,21 +2159,25 @@ On an HP-like terminal, use scp with a color-pair number parameter to set which color pair is current. - On a Tektronix-like terminal, the capability ccc may be - present to indicate that colors can be modified. If so, - the initc capability will take a color number (0 to colors - - 1)and three more parameters which describe the color. - These three parameters default to being interpreted as RGB - (Red, Green, Blue) values. If the boolean capability hls - is present, they are instead as HLS (Hue, Lightness, Satu- - ration) indices. The ranges are terminal-dependent. - - On an HP-like terminal, initp may give a capability for - changing a color-pair value. It will take seven parame- - ters; a color-pair number (0 to max_pairs - 1), and two - triples describing first background and then foreground - colors. These parameters must be (Red, Green, Blue) or - (Hue, Lightness, Saturation) depending on hls. + Some terminals allow the color values to be modified: + + o On a Tektronix-like terminal, the capability ccc may + be present to indicate that colors can be modified. + If so, the initc capability will take a color number + (0 to colors - 1)and three more parameters which + describe the color. These three parameters default to + being interpreted as RGB (Red, Green, Blue) values. + If the boolean capability hls is present, they are + instead as HLS (Hue, Lightness, Saturation) indices. + The ranges are terminal-dependent. + + o On an HP-like terminal, initp may give a capability + for changing a color-pair value. It will take seven + parameters; a color-pair number (0 to max_pairs - 1), + and two triples describing first background and then + foreground colors. These parameters must be (Red, + Green, Blue) or (Hue, Lightness, Saturation) depending + on hls. On some color terminals, colors collide with highlights. You can register these collisions with the ncv capability. @@ -2323,13 +2352,13 @@ termcap translations of long terminfo entries can cause problems. - The man pages for 4.3BSD and older versions of tgetent() + 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() + 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 @@ -2349,7 +2378,7 @@ one, because it affects more than just users of that par- ticular terminal. This is the length of the entry as it exists in /etc/termcap, minus the backslash-newline pairs, - which tgetent() strips out while reading it. Some termcap + which tgetent strips out while reading it. Some termcap libraries strip off the final newline, too (GNU termcap does not). Now suppose: @@ -2363,28 +2392,28 @@ matter what its length, to see if it is the entry it wants, - o and tgetent() is searching for a terminal type that + o and tgetent is searching for a terminal type that either is the long entry, appears in the termcap file after the long entry, or does not appear in the file - at all (so that tgetent() has to search the whole - termcap file). - - Then tgetent() will overwrite memory, perhaps its stack, - and probably core dump the program. Programs like telnet - are particularly 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. + at all (so that tgetent has to search the whole term- + cap 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 the termi- + nal. 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 - for, not while searching. + that terminal type, since tgetent only does "tc" expansion + once it is found the terminal type it was looking for, not + while searching. In summary, a termcap entry that is longer than 1023 bytes can cause, on various combinations of termcap libraries @@ -2486,8 +2515,8 @@
- tic(1m), infocmp(1m), curses(3x), printf(3), term(5). - term_variables(3x). + tic(1m), infocmp(1m), curses(3x), curs_color(3x), + printf(3), term(5). term_variables(3x).