X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fterminfo.5.html;h=2cd565e8a72f6092a149b4452aa21ffc03e21271;hp=f8c93d325278f1d2100a2c33c992087545fed2f3;hb=e2d7d0028f4298dca2b0edaf2dc8ce30518d9218;hpb=71c0306f0824ef2b10c4c5813fb003db48f3012e diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index f8c93d32..2cd565e8 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-2009,2010 Free Software Foundation, Inc. * + * Copyright (c) 1998-2012,2013 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.18 2010/07/31 16:08:48 tom Exp @ + * @Id: terminfo.head,v 1.20 2013/03/02 23:52:37 tom Exp @ * Head of terminfo man page ends here - * @Id: terminfo.tail,v 1.51 2010/07/31 16:02:40 tom Exp @ + * @Id: terminfo.tail,v 1.61 2013/03/03 00:06:39 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 20100731). + This describes ncurses version 5.9 (patch 20130309). Entries in terminfo consist of a sequence of `,' separated fields (embedded commas may be escaped with a backslash or @@ -106,7 +106,7 @@ Terminal names (except for the last, verbose entry) should be chosen using the following conventions. The particular piece of hardware making up the terminal should have a - root name, thus ``hp2621''. This name should not contain + root name, thus "hp2621". This name should not contain hyphens. Modes that the hardware can be in, or user pref- erences, should be indicated by appending a hyphen and a mode suffix. Thus, a vt100 in 132 column mode would be @@ -132,7 +132,7 @@ For more on terminal naming conventions, see the term(7) manual page. - Capabilities + Predefined Capabilities The following is a complete table of the capabilities included in a terminfo description block and available to terminfo-using code. In each line of the table, @@ -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,53 @@ 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). + + User-Defined Capabilities + The preceding section listed the predefined capabilities. + They deal with some special features for terminals no + longer (or possibly never) produced. Occasionally there + are special features of newer terminals which are awkward + or impossible to represent by reusing the predefined capa- + bilities. + + ncurses addresses this limitation by allowing user-defined + capabilities. The tic and infocmp programs provide the -x + option for this purpose. When -x is set, tic treats + unknown capabilities as user-defined. That is, if tic + encounters a capability name which it does not recognize, + it infers its type (boolean, number or string) from the + syntax and makes an extended table entry for that capabil- + ity. The use_extended_names function makes this informa- + tion conditionally available to applications. The ncurses + library provides the data leaving most of the behavior to + applications: + + o User-defined capability strings whose name begins with + "k" are treated as function keys. + + o The types (boolean, number, string) determined by tic + can be inferred by successful calls on tigetflag, etc. + + o If the capability name happens to be two characters, + the capability is also available through the termcap + interface. + + While termcap is said to be extensible because it does not + use a predefined set of capabilities, in practice it has + been limited to the capabilities defined by terminfo + implementations. As a rule, user-defined capabilities + intended for use by termcap applications should be limited + to booleans and numbers to avoid running past the 1023 + byte limit assumed by termcap implementations and their + applications. In particular, providing extended sets of + function keys (past the 60 numbered keys and the handful + of special named keys) is best done using the longer names + available using terminfo. A Sample Entry The following entry, describing an ANSI-standard terminal, @@ -1047,13 +1092,17 @@ Entries may continue onto multiple lines by placing white space at the beginning of each line except the first. - Comments may be included on lines beginning with ``#''. - Capabilities in terminfo are of three types: Boolean capa- - bilities which indicate that the terminal has some partic- - ular feature, numeric capabilities giving the size of the - terminal or the size of particular delays, and string - capabilities, which give a sequence which can be used to - perform particular terminal operations. + Comments may be included on lines beginning with "#". + Capabilities in terminfo are of three types: + + o Boolean capabilities which indicate that the terminal + has some particular feature, + + o numeric capabilities giving the size of the terminal + or the size of particular delays, and + + o string capabilities, which give a sequence which can + be used to perform particular terminal operations. Types of Capabilities All capabilities have names. For instance, the fact that @@ -1078,12 +1127,32 @@ Both \E and \e map to an ESCAPE character, ^x maps to a control-x for any appropriate x, and the sequences \n \l \r \t \b \f \s give a newline, line-feed, return, tab, - backspace, form-feed, and space. Other escapes include \^ - for ^, \\ for \, \, for comma, \: for :, and \0 for null. - (\0 will produce \200, which does not terminate a string - but behaves as a null character on most terminals, provid- - ing CS7 is specified. See stty(1).) Finally, characters - may be given as three octal digits after a \. + backspace, form-feed, and space. Other escapes include + + o \^ for ^, + + o \\ for \, + + o \, for comma, + + o \: for :, + + o and \0 for null. + + \0 will produce \200, which does not terminate a + string but behaves as a null character on most termi- + nals, providing CS7 is specified. See stty(1). + + The reason for this quirk is to maintain binary com- + patibility of the compiled terminfo files with other + implementations, e.g., the SVr4 systems, which docu- + ment this. Compiled terminfo files use null-termi- + nated strings, with no lengths. Modifying this would + require a new binary format, which would not work with + other implementations. + + Finally, characters may be given as three octal digits + after a \. A delay in milliseconds may appear anywhere in a string capability, enclosed in $<..> brackets, as in el=\EK$<5>, @@ -1107,28 +1176,40 @@ 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- - piled description you are working on. Only that directory - is searched. - - If TERMINFO is not set, the ncurses version of the ter- - minfo reader code will instead look in the directory - $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, - /usr/share/terminfo. - - (Neither the $HOME/.terminfo lookups nor TERMINFO_DIRS - extensions are supported under stock System V ter- - minfo/curses.) + The ncurses library searches for terminal descriptions in + several places. It uses only the first description found. + The library has a compiled-in list of places to search + which can be overridden by environment variables. Before + starting to search, ncurses eliminates duplicates in its + search list. + + o If the environment variable TERMINFO is set, it is + interpreted as 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- + tion. + + 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 + database files) to be searched. + + An empty directory name (i.e., if the variable begins + or ends with a colon, or contains adacent colons) is + interpreted as the system location /usr/share/ter- + minfo. + + o Finally, ncurses searches these compiled-in locations: + + o a list of directories + (/usr/local/ncurses/share/terminfo:/usr/share/ter- + minfo), and + + o the system terminfo directory, /usr/share/terminfo + (the compiled-in default). Preparing Descriptions We now outline how to prepare descriptions of terminals. @@ -1478,24 +1559,26 @@ Elmer Owl, make a distinction between typed and untyped blanks on the screen, shifting upon an insert or delete only to an untyped blank on the screen which is either - eliminated, or expanded to two untyped blanks. You can - determine the kind of terminal you have by clearing the - screen and then typing text separated by cursor motions. - Type "abc def" using local cursor motions (not spaces) - between the "abc" and the "def". Then position the cursor - before the "abc" and put the terminal in insert mode. If - typing characters causes the rest of the line to shift - rigidly and characters to fall off the end, then your ter- - minal does not distinguish between blanks and untyped - positions. If the "abc" shifts over to the "def" which - then move together around the end of the current line and - onto the next as you insert, you have the second type of - terminal, and should give the capability in, which stands - for "insert null". While these are two logically separate - attributes (one line versus multi-line insert mode, and - special treatment of untyped spaces) we have seen no ter- - minals whose insert mode cannot be described with the sin- - gle attribute. + eliminated, or expanded to two untyped blanks. + + You can determine the kind of terminal you have by clear- + ing the screen and then typing text separated by cursor + motions. Type "abc def" using local cursor motions + (not spaces) between the "abc" and the "def". Then posi- + tion the cursor before the "abc" and put the terminal in + insert mode. If typing characters causes the rest of the + line to shift rigidly and characters to fall off the end, + then your terminal does not distinguish between blanks and + untyped positions. If the "abc" shifts over to the "def" + which then move together around the end of the current + line and onto the next as you insert, you have the second + type of terminal, and should give the capability in, which + stands for "insert null". + + While these are two logically separate attributes (one + line versus multi-line insert mode, and special treatment + of untyped spaces) we have seen no terminals whose insert + mode cannot be described with the single attribute. Terminfo can describe both terminals which have an insert mode, and terminals which send a simple sequence to open a @@ -1627,6 +1710,7 @@ 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%; @@ -1650,8 +1734,8 @@ 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 + 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 @@ -1689,74 +1773,105 @@ 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 - (clear the tab stop in this column), kclr (clear screen or - erase key), kdch1 (delete character), kdl1 (delete line), - krmir (exit insert mode), kel (clear to end of line), ked - (clear to end of screen), kich1 (insert character or enter - insert mode), kil1 (insert line), knp (next page), kpp - (previous page), kind (scroll forward/down), kri (scroll - backward/up), khts (set a tab stop in this column). In - addition, if the keypad has a 3 by 3 array of keys includ- - ing the four arrow keys, the other five keys can be given - as ka1, ka3, kb2, kc1, and kc3. These keys are useful - when the effects of a 3 by 3 directional pad are needed. - - Strings to program function keys can be given as pfkey, - pfloc, and pfx. A string to program screen labels should - 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 + + 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 transmitted by certain other special keys can be + given: + + o kll (home down), + + o kbs (backspace), + + o ktbc (clear all tabs), + + o kctab (clear the tab stop in this column), + + o kclr (clear screen or erase key), + + o kdch1 (delete character), + + o kdl1 (delete line), + + o krmir (exit insert mode), + + o kel (clear to end of line), + + o ked (clear to end of screen), + + o kich1 (insert character or enter insert mode), + + o kil1 (insert line), + + o knp (next page), + + o kpp (previous page), + + o kind (scroll forward/down), + + o kri (scroll backward/up), + + o khts (set a tab stop in this column). + + In addition, if the keypad has a 3 by 3 array of keys + including the four arrow keys, the other five keys can be + given as ka1, ka3, kb2, kc1, and kc3. These keys are use- + ful 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 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 - 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 + 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 pre- + ceding 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 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,104 +1891,104 @@ 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 + The ncurses implementation does not yet use any of these + capabilities. They are documented here in case they ever become important. Line Graphics - Many terminals have alternate character sets useful for - forms-drawing. Terminfo and curses build in support for - the drawing characters supported by the VT100, with some - characters from the AT&T 4410v1 added. This alternate + Many terminals have alternate character sets useful for + forms-drawing. Terminfo and curses build in support for + the drawing characters supported by the VT100, with some + characters from the AT&T 4410v1 added. This alternate character set may be specified by the acsc capability. Glyph ACS Ascii VT100 @@ -1908,61 +2023,60 @@ tee pointing right ACS_LTEE + t tee pointing up ACS_BTEE + v upper left corner ACS_ULCORNER + l - upper right corner ACS_URCORNER + k vertical line ACS_VLINE | x - The best way to define a new device's graphics set is to - add a column to a copy of this table for your terminal, - giving the character which (when emitted between - smacs/rmacs switches) will be rendered as the correspond- - ing graphic. Then read off the VT100/your terminal char- - acter pairs right to left in sequence; these become the + The best way to define a new device's graphics set is to + add a column to a copy of this table for your terminal, + giving the character which (when emitted between + smacs/rmacs switches) will be rendered as the correspond- + ing graphic. Then read off the VT100/your terminal char- + acter pairs right to left in sequence; these become the ACSC string. Color Handling - Most color terminals are either `Tektronix-like' or `HP- - like'. Tektronix-like terminals have a predefined set of - N colors (where N usually 8), and can set character-cell + Most color terminals are either `Tektronix-like' or `HP- + like'. Tektronix-like terminals have a predefined set of + N colors (where N usually 8), and can set character-cell foreground and background characters independently, mixing - them into N * N color-pairs. On HP-like terminals, the + them into N * N color-pairs. On HP-like terminals, the use must set each color pair up separately (foreground and - background are not independently settable). Up to M - color-pairs may be set up from 2*M different colors. + background are not independently settable). Up to M + color-pairs may be set up from 2*M different colors. ANSI-compatible terminals are Tektronix-like. Some basic color capabilities are independent of the color method. The numeric capabilities colors and pairs specify - the maximum numbers of colors and color-pairs that can be - displayed simultaneously. The op (original pair) string - resets foreground and background colors to their default - values for the terminal. The oc string resets all colors - or color-pairs to their default values for the terminal. - Some terminals (including many PC terminal emulators) - erase screen areas with the current background color - rather than the power-up default background; these should + the maximum numbers of colors and color-pairs that can be + displayed simultaneously. The op (original pair) string + resets foreground and background colors to their default + values for the terminal. The oc string resets all colors + or color-pairs to their default values for the terminal. + Some terminals (including many PC terminal emulators) + erase screen areas with the current background color + rather than the power-up default background; these should have the boolean capability bce. - To change the current foreground or background color on a - Tektronix-type terminal, use setaf (set ANSI foreground) - and setab (set ANSI background) or setf (set foreground) - and setb (set background). These take one parameter, the + To change the current foreground or background color on a + Tektronix-type terminal, use setaf (set ANSI foreground) + and setab (set ANSI background) or setf (set foreground) + and setb (set background). These take one parameter, the color number. The SVr4 documentation describes only - setaf/setab; the XPG4 draft says that "If the terminal + setaf/setab; the XPG4 draft says that "If the terminal supports ANSI escape sequences to set background and fore- - ground, they should be coded as setaf and setab, respec- - tively. If the terminal supports other escape sequences - to set background and foreground, they should be coded as - setf and setb, respectively. The vidputs() function and - the refresh functions use setaf and setab if they are + ground, they should be coded as setaf and setab, respec- + tively. If the terminal supports other escape sequences + to set background and foreground, they should be coded as + setf and setb, respectively. The vidputs() function and + the refresh functions use setaf and setab if they are defined." - The setaf/setab and setf/setb capabilities take a single + The setaf/setab and setf/setb capabilities take a single numeric argument each. Argument values 0-7 of setaf/setab - are portably defined as follows (the middle column is the + are portably defined as follows (the middle column is the symbolic #define available in the header for the curses or - ncurses libraries). The terminal hardware is free to map - these as it likes, but the RGB values indicate normal + ncurses libraries). The terminal hardware is free to map + these as it likes, but the RGB values indicate normal locations in color space. Color #define Value RGB @@ -1975,7 +2089,7 @@ cyan COLOR_CYAN 6 0,max,max white COLOR_WHITE 7 max,max,max - The argument values of setf/setb historically correspond + The argument values of setf/setb historically correspond to a different mapping, i.e., Color #define Value RGB @@ -1987,33 +2101,34 @@ magenta COLOR_MAGENTA 5 max,0,max yellow COLOR_YELLOW 6 max,max,0 white COLOR_WHITE 7 max,max,max + It is important to not confuse the two sets of color capa- - bilities; otherwise red/blue will be interchanged on the + bilities; otherwise red/blue will be interchanged on the display. - On an HP-like terminal, use scp with a color-pair number + 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, + 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. + - 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 + (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 + 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. - On some color terminals, colors collide with highlights. + On some color terminals, colors collide with highlights. You can register these collisions with the ncv capability. - This is a bit-mask of attributes not to be used when col- - ors are enabled. The correspondence with the attributes + This is a bit-mask of attributes not to be used when col- + ors are enabled. The correspondence with the attributes understood by curses is as follows: Attribute Bit Decimal @@ -2027,240 +2142,243 @@ A_PROTECT 7 128 A_ALTCHARSET 8 256 - For example, on many IBM PC consoles, the underline - attribute collides with the foreground color blue and is - not available in color mode. These should have an ncv + For example, on many IBM PC consoles, the underline + attribute collides with the foreground color blue and is + not available in color mode. These should have an ncv capability of 2. - SVr4 curses does nothing with ncv, ncurses recognizes it + 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 - first character of the pad string is used. If the termi- + If the terminal requires other than a null (zero) charac- + ter as a pad, then this can be given as pad. Only the + first character of the pad string is used. If the termi- nal does not have a pad character, specify npc. Note that - ncurses implements the termcap-compatible PC variable; - though the application may set this value to something - other than a null, ncurses will test npc first and use + ncurses implements the termcap-compatible PC variable; + though the application may set this value to something + other than a null, ncurses will test npc first and use napms if the terminal has no pad character. - If the terminal can move up or down half a line, this can - be indicated with hu (half-line up) and hd (half-line + If the terminal can move up or down half a line, this can + be indicated with hu (half-line up) and hd (half-line down). This is primarily useful for superscripts and sub- - scripts on hard-copy terminals. If a hard-copy terminal - can eject to the next page (form feed), give this as ff + scripts on hard-copy terminals. If a hard-copy terminal + can eject to the next page (form feed), give this as ff (usually control L). - If there is a command to repeat a given character a given - number of times (to save time transmitting a large number - of identical characters) this can be indicated with the - parameterized string rep. The first parameter is the - character to be repeated and the second is the number of - times to repeat it. Thus, tparm(repeat_char, 'x', 10) is + If there is a command to repeat a given character a given + number of times (to save time transmitting a large number + of identical characters) this can be indicated with the + parameterized string rep. The first parameter is the + character to be repeated and the second is the number of + times to repeat it. Thus, tparm(repeat_char, 'x', 10) is the same as `xxxxxxxxxx'. - If the terminal has a settable command character, such as - the TEKTRONIX 4025, this can be indicated with cmdch. A + If the terminal has a settable command character, such as + the TEKTRONIX 4025, this can be indicated with cmdch. A prototype command character is chosen which is used in all - capabilities. This character is given in the cmdch capa- - bility to identify it. The following convention is sup- - ported on some UNIX systems: The environment is to be - searched for a CC variable, and if found, all occurrences + capabilities. This character is given in the cmdch capa- + bility to identify it. The following convention is sup- + ported on some UNIX systems: The environment is to be + searched for a CC variable, and if found, all occurrences of the prototype character are replaced with the character in the environment variable. - Terminal descriptions that do not represent a specific + Terminal descriptions that do not represent a specific kind of known terminal, such as switch, dialup, patch, and - network, should include the gn (generic) capability so - that programs can complain that they do not know how to - talk to the terminal. (This capability does not apply to - virtual terminal descriptions for which the escape + network, should include the gn (generic) capability so + that programs can complain that they do not know how to + talk to the terminal. (This capability does not apply to + virtual terminal descriptions for which the escape sequences are known.) - If the terminal has a ``meta key'' which acts as a shift - key, setting the 8th bit of any character transmitted, - this fact can be indicated with km. Otherwise, software + If the terminal has a "meta key" which acts as a shift + key, setting the 8th bit of any character transmitted, + this fact can be indicated with km. Otherwise, software will assume that the 8th bit is parity and it will usually - be cleared. If strings exist to turn this ``meta mode'' - on and off, they can be given as smm and rmm. + be cleared. If strings exist to turn this "meta mode" on + and off, they can be given as smm and rmm. - If the terminal has more lines of memory than will fit on - the screen at once, the number of lines of memory can be - indicated with lm. A value of lm#0 indicates that the + If the terminal has more lines of memory than will fit on + the screen at once, the number of lines of memory can be + indicated with lm. A value of lm#0 indicates that the number of lines is not fixed, but that there is still more memory than fits on the screen. If the terminal is one of those supported by the UNIX vir- - tual terminal protocol, the terminal number can be given + tual terminal protocol, the terminal number can be given as vt. Media copy strings which control an auxiliary printer con- nected to the terminal can be given as mc0: print the con- - tents of the screen, mc4: turn off the printer, and mc5: - turn on the printer. When the printer is on, all text - sent to the terminal will be sent to the printer. It is + tents of the screen, mc4: turn off the printer, and mc5: + turn on the printer. When the printer is on, all text + sent to the terminal will be sent to the printer. It is undefined whether the text is also displayed on the termi- nal screen when the printer is on. A variation mc5p takes one parameter, and leaves the printer on for as many char- - acters as the value of the parameter, then turns the - printer off. The parameter should not exceed 255. All + acters as the value of the parameter, then turns the + printer off. The parameter should not exceed 255. All text, including mc4, is transparently passed to the printer while an mc5p is in effect. Glitches and Braindamage - Hazeltine terminals, which do not allow `~' characters to + Hazeltine terminals, which do not allow `~' characters to be displayed should indicate hz. Terminals which ignore a line-feed immediately after an am wrap, such 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 - cookie'', that to erase standout mode it is instead neces- + 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 - 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 - wants, - - * 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 + o a termcap entry before expansion is more than 1023 + bytes long, + + o and the application has only allocated a 1k buffer, + + o and the termcap library (like the one in BSD/OS 1.1 + and GNU) reads the whole entry into the buffer, no + matter what its length, to see if it is the entry it + wants, + + o and tgetent() is searching for a terminal type that + either is the long entry, appears in the termcap file + after the long entry, or does not appear in the file + at all (so that tgetent() has to search 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. 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

+       Searching for terminal descriptions in $HOME/.terminfo and
+       TERMINFO_DIRS is not supported by older implementations.
+
        Some SVr4 curses  implementations,  and  all  previous  to
        SVr4,  do not interpret the %A and %O operators in parame-
        ter strings.
@@ -2326,12 +2444,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.