X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fterminfo.5.html;h=445f3c54b72a935b87e272f857a0ae12b2ef8072;hp=366da6548e31edd0b0195816a92efefb7161415c;hb=f86cbeb5f9bd96ab041d34039c35749a14965039;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/terminfo.5.html b/doc/html/man/terminfo.5.html index 366da654..445f3c54 100644 --- a/doc/html/man/terminfo.5.html +++ b/doc/html/man/terminfo.5.html @@ -6,7 +6,7 @@ * Note: this must be run through tbl before nroff. * The magic cookie on the first line triggers this under some man programs. **************************************************************************** - * Copyright (c) 1998-2000,2002 Free Software Foundation, Inc. * + * Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -32,23 +32,33 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: terminfo.head,v 1.10 2002/08/17 23:37:10 tom Exp @ + * @Id: terminfo.head,v 1.18 2010/07/31 16:08:48 tom Exp @ * Head of terminfo man page ends here - * @Id: terminfo.tail,v 1.35 2002/04/20 16:49:33 tom Exp @ + * @Id: terminfo.tail,v 1.53 2010/12/04 18:38:55 tom Exp @ * Beginning of terminfo.tail file + * This file is part of ncurses. + * See "terminfo.head" for copyright. + *.in -2 + *.in +2 + *.in -2 + *.in +2 *.TH -->
-+terminfo(5) File Formats terminfo(5) + + +
@@ -67,31 +77,43 @@ libraries such as curses(3x). Terminfo describes termi- nals by giving a set of capabilities which they have, by specifying how to perform screen operations, and by speci- - fying padding requirements and initialization sequences. + fying padding requirements and initialization sequences. + This describes ncurses version 5.8 (patch 20110226). Entries in terminfo consist of a sequence of `,' separated fields (embedded commas may be escaped with a backslash or - notated as \054). White space after the `,' separator is - ignored. The first entry for each terminal gives the - names which are known for the terminal, separated by `|' - characters. The first name given is the most common - abbreviation for the terminal, the last name given should - be a long name fully identifying the terminal, and all - others are understood as synonyms for the terminal name. + notated as \054). White space after the `,' separator is + ignored. The first entry for each terminal gives the + names which are known for the terminal, separated by `|' + characters. The first name given is the most common + abbreviation for the terminal, the last name given should + be a long name fully identifying the terminal, and all + others are understood as synonyms for the terminal name. All names but the last should be in lower case and contain - no blanks; the last name may well contain upper case and + no blanks; the last name may well contain upper case and blanks for readability. + Lines beginning with a `#' in the first column are treated + as comments. While comment lines are legal at any point, + the output of captoinfo and infotocap (aliases for tic) + will move comments so they occur only between entries. + + Newlines and leading tabs may be used for formatting + entries for readability. These are removed from parsed + entries. The infocmp -f option relies on this to format + if-then-else expressions: the result can be read by tic. + Terminal names (except for the last, verbose entry) should be chosen using the following conventions. The particular - piece of hardware making up the terminal should have a - root name, thus ``hp2621''. This name should not contain + piece of hardware making up the terminal should have a + root name, thus ``hp2621''. This name should not contain hyphens. Modes that the hardware can be in, or user pref- - erences, should be indicated by appending a hyphen and a - mode suffix. Thus, a vt100 in 132 column mode would be + erences, should be indicated by appending a hyphen and a + mode suffix. Thus, a vt100 in 132 column mode would be vt100-w. The following suffixes should be used where pos- sible: + Suffix Meaning Example -nn Number of lines on the screen aaa-60 -np Number of pages of memory c100-4p @@ -104,47 +126,48 @@ -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 -w Wide mode (> 80 columns, usually 132) vt100-w - For more on terminal naming conventions, see the term(7) + For more on terminal naming conventions, see the term(7) manual page. Capabilities - The following is a complete table of the capabilities - included in a terminfo description block and available to + The following is a complete table of the capabilities + included in a terminfo description block and available to terminfo-using code. In each line of the table, - The variable is the name by which the programmer (at the + The variable is the name by which the programmer (at the terminfo level) accesses the capability. - The capname is the short name used in the text of the - database, and is used by a person updating the database. - Whenever possible, capnames are chosen to be the same as + The capname is the short name used in the text of the + database, and is used by a person updating the database. + Whenever possible, capnames are chosen to be the same as or similar to the ANSI X3.64-1979 standard (now superseded - by ECMA-48, which uses identical or very similar names). + by ECMA-48, which uses identical or very similar names). Semantics are also intended to match those of the specifi- cation. - The termcap code is the old termcap capability name (some + The termcap code is the old termcap capability name (some capabilities are new, and have names which termcap did not originate). - Capability names have no hard length limit, but an infor- - mal limit of 5 characters has been adopted to keep them - short and to allow the tabs in the source file Caps to + Capability names have no hard length limit, but an infor- + mal limit of 5 characters has been adopted to keep them + short and to allow the tabs in the source file Caps to line up nicely. - Finally, the description field attempts to convey the - semantics of the capability. You may find some codes in + Finally, the description field attempts to convey the + semantics of the capability. You may find some codes in the description field: (P) indicates that padding may be specified - #[1-9] in the description field indicates that the string + #[1-9] in the description field indicates that the string is passed through tparm with parms as given (#i). - (P*) indicates that padding may vary in proportion to + (P*) indicates that padding may vary in proportion to the number of lines affected (#i) indicates the ith parameter. @@ -152,6 +175,7 @@ These are the boolean capabilities: + Variable Cap- TCap Description Booleans name Code auto_left_margin bw bw cub1 wraps from col- @@ -163,11 +187,12 @@ can_change ccc cc terminal can re- define existing col- ors - ceol_standout_glitch xhp xs standout not erased by overwriting (hp) col_addr_glitch xhpa YA only positive motion for hpa/mhpa caps + + cpi_changes_res cpix YF changing character pitch changes reso- lution @@ -216,8 +241,6 @@ f2=ctrl C) no_pad_char npc NP pad character does not exist - - non_dest_scroll_region ndscr ND scrolling region is non-destructive non_rev_rmcup nrrmc NR smcup does not @@ -234,6 +257,8 @@ on the status line tilde_glitch hz hz cannot print ~'s (hazeltine) + + transparent_underline ul ul underline character overstrikes xon_xoff xon xo terminal uses @@ -241,6 +266,7 @@ These are the numeric capabilities: + Variable Cap- TCap Description Numeric name Code columns cols co number of columns in @@ -270,8 +296,6 @@ no_color_video ncv NC video attributes that cannot be used with colors - - num_labels nlab Nl number of labels on screen padding_baud_rate pb pb lowest baud rate @@ -281,10 +305,11 @@ width_status_line wsl ws number of columns in status line - The following numeric capabilities are present in the - SVr4.0 term structure, but are not yet documented in the + The following numeric capabilities are present in the + SVr4.0 term structure, but are not yet documented in the man page. They came in with SVr4's printer support. + Variable Cap- TCap Description Numeric name Code bit_image_entwining bitwin Yo number of passes for @@ -299,6 +324,7 @@ dot_horz_spacing spinh Yc spacing of dots hor- izontally in dots per inch + dot_vert_spacing spinv Yb spacing of pins ver- tically in pins per inch @@ -324,14 +350,13 @@ in units per inch print_rate cps Ym print rate in char- acters per second - - wide_char_size widcs Yn character step size when in double wide mode These are the string capabilities: + Variable Cap- TCap Description String name Code acs_chars acsc ac graphics charset @@ -364,6 +389,8 @@ home cursor (P*) clr_bol el1 cb Clear to beginning of line + + clr_eol el ce clear to end of line (P) clr_eos ed cd clear to end of @@ -378,8 +405,6 @@ cursor_address cup cm move to row #1 columns #2 cursor_down cud1 do down one line - - cursor_home home ho home cursor (if no cup) cursor_invisible civis vi make cursor invisi- @@ -431,9 +456,9 @@ enter_italics_mode sitm ZH Enter italic mode enter_leftward_mode slm ZI Start leftward car- riage motion + enter_micro_mode smicm ZJ Start micro-motion mode - enter_near_letter_quality snlq ZK Enter NLQ mode enter_normal_quality snrmq ZL Enter normal-quality mode @@ -487,7 +512,6 @@ flash_hook hook fh flash switch hook flash_screen flash vb visible bell (may not move cursor) - form_feed ff ff hardcopy terminal page eject (P*) from_status_line fsl fs return from status @@ -498,6 +522,7 @@ string init_2string is2 is initialization string + init_3string is3 i3 initialization string init_file if if name of initializa- @@ -540,8 +565,6 @@ in insert mode key_end kend @7 end key key_enter kent @8 enter/send key - - key_eol kel kE clear-to-end-of-line key key_eos ked kS clear-to-end-of- @@ -565,6 +588,7 @@ key_f22 kf22 FC F22 function key key_f23 kf23 FD F23 function key key_f24 kf24 FE F24 function key + key_f25 kf25 FF F25 function key key_f26 kf26 FG F26 function key key_f27 kf27 FH F27 function key @@ -595,7 +619,6 @@ key_f5 kf5 k5 F5 function key key_f50 kf50 Fe F50 function key key_f51 kf51 Ff F51 function key - key_f52 kf52 Fg F52 function key key_f53 kf53 Fh F53 function key key_f54 kf54 Fi F54 function key @@ -631,6 +654,7 @@ key_previous kprv %8 previous key key_print kprt %9 print key key_redo krdo %0 redo key + key_reference kref &1 reference key key_refresh krfr &2 refresh key key_replace krpl &3 replace key @@ -649,7 +673,6 @@ key key_select kslt *6 select key key_send kEND *7 shifted end key - key_seol kEOL *8 shifted clear-to- end-of-line key key_sexit kEXT *9 shifted exit key @@ -696,14 +719,14 @@ key f3 if not f3 lab_f4 lf4 l4 label on function key f4 if not f4 + + lab_f5 lf5 l5 label on function key f5 if not f5 lab_f6 lf6 l6 label on function key f6 if not f6 lab_f7 lf7 l7 label on function key f7 if not f7 - - lab_f8 lf8 l8 label on function key f8 if not f8 lab_f9 lf9 l9 label on function @@ -757,12 +780,13 @@ sor in micro mode parm_rindex rin SR scroll back #1 lines (P) - parm_up_cursor cuu UP up #1 lines (P*) parm_up_micro mcuu Zi Like parm_up_cursor in micro mode pkey_key pfkey pk program function key #1 to type string #2 + + pkey_local pfloc pl program function key #1 to execute string #2 @@ -811,7 +835,6 @@ line #1 or (if smgtp is not given) #2 lines from bottom - set_clock sclk SC set clock, #1 hrs #2 mins #3 secs set_color_pair scp sp Set current color @@ -829,6 +852,7 @@ umn set_right_margin_parm smgrp Zn Set right margin at column #1 + set_tab hts st set a tab in every row, current columns set_top_margin smgt Zo Set top margin at @@ -865,7 +889,6 @@ move past it up_half_line hu hu half a line up user0 u0 u0 User string #0 - user1 u1 u1 User string #1 user2 u2 u2 User string #2 user3 u3 u3 User string #3 @@ -881,10 +904,11 @@ 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. + Variable Cap- TCap Description String name Code alt_scancode_esc scesa S8 Alternate escape @@ -894,6 +918,7 @@ of same row bit_image_newline binel Zz Move to next row of the bit image + bit_image_repeat birep Xy Repeat bit image cell #1 #2 times char_set_names csnm Zy Produce #1'th item @@ -919,7 +944,6 @@ mode exit_pc_charset_mode rmpch S3 Exit PC character display mode - exit_scancode_mode rmsc S5 Exit PC scancode mode get_mouse getm Gm Curses should get @@ -960,20 +984,21 @@ cap). set_page_length slines YZ Set page length to #1 lines + set_tb_margin smgtb MT Sets both top and bottom margins to #1, #2 - 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 + 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 + 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 + Variable Cap- TCap Description String name Code enter_horizontal_hl_mode ehhlm Xh Enter horizontal highlight mode @@ -994,10 +1019,9 @@ to #1 hundredth of an inch - A Sample Entry The following entry, describing an ANSI-standard terminal, - is representative of what a terminfo entry for a modern + is representative of what a terminfo entry for a modern terminal typically looks like. ansi|ansi/pc-term compatible with color, @@ -1021,133 +1045,133 @@ sgr0=\E[0;10m, tbc=\E[2g, u6=\E[%d;%dR, u7=\E[6n, u8=\E[?%[;0123456789]c, u9=\E[c, vpa=\E[%p1%dd, - Entries may continue onto multiple lines by placing white - space at the beginning of each line except the first. - Comments may be included on lines beginning with ``#''. + 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 + 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. Types of Capabilities - All capabilities have names. For instance, the fact that - ANSI-standard terminals have automatic margins (i.e., an - automatic return and line-feed when the end of a line is - reached) is indicated by the capability am. Hence the + All capabilities have names. For instance, the fact that + ANSI-standard terminals have automatic margins (i.e., an + automatic return and line-feed when the end of a line is + reached) is indicated by the capability am. Hence the description of ansi includes am. Numeric capabilities are - followed by the character `#' and then a positive value. - Thus cols, which indicates the number of columns the ter- - minal has, gives the value `80' for ansi. Values for + followed by the character `#' and then a positive value. + Thus cols, which indicates the number of columns the ter- + minal has, gives the value `80' for ansi. Values for numeric capabilities may be specified in decimal, octal or - hexadecimal, using the C programming language conventions + hexadecimal, using the C programming language conventions (e.g., 255, 0377 and 0xff or 0xFF). - Finally, string valued capabilities, such as el (clear to + Finally, string valued capabilities, such as el (clear to end of line sequence) are given by the two-character code, - an `=', and then a string ending at the next following + an `=', and then a string ending at the next following `,'. - A number of escape sequences are provided in the string + A number of escape sequences are provided in the string valued capabilities for easy encoding of characters there. - 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, + 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 + 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 + ing CS7 is specified. See stty(1).) Finally, characters may be given as three octal digits after a \. - A delay in milliseconds may appear anywhere in a string - capability, enclosed in $<..> brackets, as in el=\EK$<5>, - and padding characters are supplied by tputs to provide - this delay. The delay must be a number with at most one + 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 + `*' 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 + 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 + 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. + Fetching Compiled Descriptions - If the environment variable TERMINFO is set, it is inter- - preted as the pathname of a directory containing the com- + 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, + 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- + (Neither the $HOME/.terminfo lookups nor TERMINFO_DIRS + extensions are supported under stock System V ter- minfo/curses.) Preparing Descriptions - We now outline how to prepare descriptions of terminals. - The most effective way to prepare a terminal description - is by imitating the description of a similar terminal in - terminfo and to build up a description gradually, using + We now outline how to prepare descriptions of terminals. + The most effective way to prepare a terminal description + is by imitating the description of a similar terminal in + terminfo and to build up a description gradually, using partial descriptions with vi or some other screen-oriented - program to check that they are correct. Be aware that a + program to check that they are correct. Be aware that a very unusual terminal may expose deficiencies in the abil- - ity of the terminfo file to describe it or bugs in the + ity of the terminfo file to describe it or bugs in the screen-handling code of the test program. - To get the padding for insert line right (if the terminal + To get the padding for insert line right (if the terminal manufacturer did not document it) a severe test is to edit - a large file at 9600 baud, delete 16 or so lines from the - middle of the screen, then hit the `u' key several times - quickly. If the terminal messes up, more padding is usu- - ally needed. A similar test can be used for insert char- + a large file at 9600 baud, delete 16 or so lines from the + middle of the screen, then hit the `u' key several times + quickly. If the terminal messes up, more padding is usu- + ally needed. A similar test can be used for insert char- acter. Basic Capabilities - The number of columns on each line for the terminal is - given by the cols numeric capability. If the terminal is - a CRT, then the number of lines on the screen is given by + The number of columns on each line for the terminal is + given by the cols numeric capability. If the terminal is + a CRT, then the number of lines on the screen is given by the lines capability. If the terminal wraps around to the - beginning of the next line when it reaches the right mar- + beginning of the next line when it reaches the right mar- gin, then it should have the am capability. If the termi- - nal can clear its screen, leaving the cursor in the home - position, then this is given by the clear string - capability. If the terminal overstrikes (rather than - clearing a position when a character is struck over) then - it should have the os capability. If the terminal is a - printing terminal, with no soft copy unit, give it both hc - and os. (os applies to storage scope terminals, such as - TEKTRONIX 4010 series, as well as hard copy and APL termi- - nals.) If there is a code to move the cursor to the left - edge of the current row, give this as cr. (Normally this - will be carriage return, control M.) If there is a code - to produce an audible signal (bell, beep, etc) give this - as bel. + nal can clear its screen, leaving the cursor in the home + position, then this is given by the clear string capabil- + ity. If the terminal overstrikes (rather than clearing a + position when a character is struck over) then it should + have the os capability. If the terminal is a printing + terminal, with no soft copy unit, give it both hc and os. + (os applies to storage scope terminals, such as TEKTRONIX + 4010 series, as well as hard copy and APL terminals.) If + there is a code to move the cursor to the left edge of the + current row, give this as cr. (Normally this will be car- + riage return, control M.) If there is a code to produce + an audible signal (bell, beep, etc) give this as bel. If there is a code to move the cursor one position to the left (such as backspace) that capability should be given @@ -1197,20 +1221,20 @@ "glass-tty" terminals. Thus the model 33 teletype is described as - 33|tty33|tty|model 33 teletype, - bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, + 33|tty33|tty|model 33 teletype, + bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, while the Lear Siegler ADM-3 is described as - adm3|3|lsi adm3, - am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, - ind=^J, lines#24, + adm3|3|lsi adm3, + am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, + ind=^J, lines#24, Parameterized Strings Cursor addressing and other strings requiring parameters in the terminal are described by a parameterized string - capability, with printf(3S) like escapes %x in it. For + capability, with printf(3) like escapes %x in it. For example, to address the cursor, the cup capability is given, using two parameters: the row and column to address to. (Rows and columns are numbered from zero and refer to @@ -1221,575 +1245,659 @@ The parameter mechanism uses a stack and special % codes to manipulate it. Typically a sequence will push one of the parameters onto the stack and then print it in some - format. Often more complex operations are necessary. + format. Print (e.g., "%d") is a special case. Other + operations, including "%t" pop their operand from the + stack. It is noted that more complex operations are often + necessary, e.g., in the sgr string. The % encodings have the following meanings: - %% outputs `%' - %[[:]flags][width[.precision]][doxXs] - as in printf, flags are [-+#] and space - %c print pop() like %c in printf() - %s print pop() like %s in printf() - - %p[1-9] push i'th parm - %P[a-z] set dynamic variable [a-z] to pop() - %g[a-z] get dynamic variable [a-z] and push it - %P[A-Z] set static variable [a-z] to pop() - %g[A-Z] get static variable [a-z] and push it - %'c' char constant c - %{nn} integer constant nn - %l push strlen(pop) - - %+ %- %* %/ %m - arithmetic (%m is mod): push(pop() op pop()) - %& %| %^ bit operations: push(pop() op pop()) - %= %> %< logical operations: push(pop() op pop()) - %A, %O logical and & or operations (for conditionals) - %! %~ unary operations push(op pop()) - %i add 1 to first two parameters (for ANSI terminals) - - %? expr %t thenpart %e elsepart %; - if-then-else, %e elsepart is optional. - else-if's are possible a la Algol 68: - %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; - ci are conditions, bi are bodies. + + %% outputs `%' + + %[[:]flags][width[.precision]][doxXs] + as in printf, flags are [-+#] and space. Use a `:' + to allow the next character to be a `-' flag, avoid- + ing interpreting "%-" as an operator. + + %c print pop() like %c in printf + + %s print pop() like %s in printf + + %p[1-9] + push i'th parameter + + %P[a-z] + set dynamic variable [a-z] to pop() + + %g[a-z] + get dynamic variable [a-z] and push it + + %P[A-Z] + set static variable [a-z] to pop() + + %g[A-Z] + get static variable [a-z] and push it + + The terms "static" and "dynamic" are misleading. + Historically, these are simply two different sets of + variables, whose values are not reset between calls + to tparm. However, that fact is not documented in + other implementations. Relying on it will adversely + impact portability to other implementations. + + %'c' char constant c + + %{nn} + integer constant nn + + %l push strlen(pop) + + %+ %- %* %/ %m + arithmetic (%m is mod): push(pop() op pop()) + + %& %| %^ + bit operations (AND, OR and exclusive-OR): push(pop() + op pop()) + + %= %> %< + logical operations: push(pop() op pop()) + + %A, %O + logical AND and OR operations (for conditionals) + + %! %~ + unary operations (logical and bit complement): + push(op pop()) + + %i add 1 to first two parameters (for ANSI terminals) + + %? expr %t thenpart %e elsepart %; + This forms an if-then-else. The %e elsepart is + optional. Usually the %? expr part pushes a value + onto the stack, and %t pops it from the stack, test- + ing if it is nonzero (true). If it is zero (false), + control passes to the %e (else) part. + + It is possible to form else-if's a la Algol 68: + %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; + + where ci are conditions, bi are bodies. + + Use the -f option of tic or infocmp to see the struc- + ture of if-then-else's. Some strings, e.g., sgr can + be very complicated when written on one line. The -f + option splits the string into lines with the parts + indented. Binary operations are in postfix form with the operands in - the usual order. That is, to get x-5 one would use - "%gx%{5}%-". %P and %g variables are persistent across + the usual order. That is, to get x-5 one would use + "%gx%{5}%-". %P and %g variables are persistent across escape-string evaluations. Consider the HP2645, which, to get to row 3 and column 12, - needs to be sent \E&a12c03Y padded for 6 milliseconds. - Note that the order of the rows and columns is inverted - here, and that the row and column are printed as two dig- + needs to be sent \E&a12c03Y padded for 6 milliseconds. + Note that the order of the rows and columns is inverted + here, and that the row and column are printed as two dig- its. Thus its cup capability is "cup=6\E&%p2%2dc%p1%2dY". The Microterm ACT-IV needs the current row and column sent - preceded by a ^T, with the row and column simply encoded - in binary, "cup=^T%p1%c%p2%c". Terminals which use "%c" - need to be able to backspace the cursor (cub1), and to + preceded by a ^T, with the row and column simply encoded + in binary, "cup=^T%p1%c%p2%c". Terminals which use "%c" + need to be able to backspace the cursor (cub1), and to move the cursor up one line on the screen (cuu1). This is - necessary because it is not always safe to transmit \n ^D - and \r, as the system may change or discard them. (The - library routines dealing with terminfo set tty modes so + necessary because it is not always safe to transmit \n ^D + and \r, as the system may change or discard them. (The + library routines dealing with terminfo set tty modes so that tabs are never expanded, so \t is safe to send. This turns out to be essential for the Ann Arbor 4080.) A final example is the LSI ADM-3a, which uses row and col- umn offset by a blank character, thus "cup=\E=%p1%' - '%+%c%p2%' '%+%c". After sending `\E=', this pushes the - first parameter, pushes the ASCII value for a space (32), - adds them (pushing the sum on the stack in place of the - two previous values) and outputs that value as a charac- - ter. Then the same is done for the second parameter. + '%+%c%p2%' '%+%c". After sending `\E=', this pushes the + first parameter, pushes the ASCII value for a space (32), + adds them (pushing the sum on the stack in place of the + two previous values) and outputs that value as a charac- + 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 - home; similarly a fast way of getting to the lower left- - hand corner can be given as ll; this may involve going up - with cuu1 from the home position, but a program should - never do this itself (unless ll does) because it can make - no assumption about the effect of moving up from the home - position. Note that the home position is the same as + upper left corner of screen) then this can be given as + home; similarly a fast way of getting to the lower left- + hand corner can be given as ll; this may involve going up + with cuu1 from the home position, but a program should + never do this itself (unless ll does) because it can make + no assumption about the effect of moving up from the home + position. Note that the home position is the same as addressing to (0,0): to the top left corner of the screen, - not of memory. (Thus, the \EH sequence on HP terminals + not of memory. (Thus, the \EH sequence on HP terminals cannot be used for home.) If the terminal has row or column absolute cursor address- - ing, these can be given as single parameter capabilities + ing, these can be given as single parameter capabilities hpa (horizontal position absolute) and vpa (vertical posi- tion absolute). Sometimes these are shorter than the more - general two parameter sequence (as with the hp2645) and - can be used in preference to cup. If there are parameter- - ized local motions (e.g., move n spaces to the right) - these can be given as cud, cub, cuf, and cuu with a single - parameter indicating how many spaces to move. These are - primarily useful if the terminal does not have cup, such - as the TEKTRONIX 4025. + general two parameter sequence (as with the hp2645) and + can be used in preference to cup. If there are + parameterized local motions (e.g., move n spaces to the + right) these can be given as cud, cub, cuf, and cuu with a + single parameter indicating how many spaces to move. + These are primarily useful if the terminal does not have + cup, such as the TEKTRONIX 4025. If the terminal needs to be in a special mode when running a program that uses these capabilities, the codes to enter - and exit this mode can be given as smcup and rmcup. This - arises, for example, from terminals like the Concept with - more than one page of memory. If the terminal has only - memory relative cursor addressing and not screen relative + and exit this mode can be given as smcup and rmcup. This + arises, for example, from terminals like the Concept with + more than one page of memory. If the terminal has only + memory relative cursor addressing and not screen relative cursor addressing, a one screen-sized window must be fixed - into the terminal for cursor addressing to work properly. + into the terminal for cursor addressing to work properly. This is also used for the TEKTRONIX 4025, where smcup sets - the command character to be the one used by terminfo. If - the smcup sequence will not restore the screen after an + the command character to be the one used by terminfo. If + the smcup sequence will not restore the screen after an rmcup sequence is output (to the state prior to outputting rmcup), specify nrrmc. Area Clears If the terminal can clear from the current position to the - end of the line, leaving the cursor where it is, this + end of the line, leaving the cursor where it is, this should be given as el. If the terminal can clear from the - beginning of the line to the current position inclusive, - leaving the cursor where it is, this should be given as - el1. If the terminal can clear from the current position - to the end of the display, then this should be given as - ed. Ed is only defined from the first column of a line. - (Thus, it can be simulated by a request to delete a large + beginning of the line to the current position inclusive, + leaving the cursor where it is, this should be given as + el1. If the terminal can clear from the current position + to the end of the display, then this should be given as + ed. Ed is only defined from the first column of a line. + (Thus, it can be simulated by a request to delete a large number of lines, if a true ed is not 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 - done only from the first position of a line. The cursor + If the terminal can open a new blank line before the line + where the cursor is, this should be given as il1; this is + done only from the first position of a line. The cursor must then appear on the newly blank line. If the terminal - can delete the line which the cursor is on, then this - should be given as dl1; this is done only from the first - position on the line to be deleted. Versions of il1 and - dl1 which take a single parameter and insert or delete + can delete the line which the cursor is on, then this + should be given as dl1; this is done only from the first + position on the line to be deleted. Versions of il1 and + dl1 which take a single parameter and insert or delete that many lines can be given as il and dl. - If the terminal has a settable scrolling region (like the - vt100) the command to set this can be described with the - csr capability, which takes two parameters: the top and + If the terminal has a settable scrolling region (like the + vt100) the command to set this can be described with the + csr capability, which takes two parameters: the top and bottom lines of the scrolling region. The cursor position is, alas, undefined after using this command. - It is possible to get the effect of insert or delete line + It is possible to get the effect of insert or delete line using csr on a properly chosen region; the sc and rc (save - and restore cursor) commands may be useful for ensuring - that your synthesized insert/delete string does not move - the cursor. (Note that the ncurses(3x) library does this - synthesis automatically, so you need not compose + and restore cursor) commands may be useful for ensuring + that your synthesized insert/delete string does not move + the cursor. (Note that the ncurses(3x) library does this + synthesis automatically, so you need not compose insert/delete strings for an entry with csr). Yet another way to construct insert and delete might be to - use a combination of index with the memory-lock feature - found on some terminals (like the HP-700/90 series, which + use a combination of index with the memory-lock feature + found on some terminals (like the HP-700/90 series, which however also has insert/delete). - Inserting lines at the top or bottom of the screen can - also be done using ri or ind on many terminals without a - true insert/delete line, and is often faster even on ter- + Inserting lines at the top or bottom of the screen can + also be done using ri or ind on many terminals without a + true insert/delete line, and is often faster even on ter- minals with those features. - The boolean non_dest_scroll_region should be set if each - scrolling window is effectively a view port on a screen- - sized canvas. To test for this capability, create a - scrolling region in the middle of the screen, write some- - thing to the bottom line, move the cursor to the top of + The boolean non_dest_scroll_region should be set if each + scrolling window is effectively a view port on a screen- + sized canvas. To test for this capability, create a + scrolling region in the middle of the screen, write some- + thing to the bottom line, move the cursor to the top of the region, and do ri followed by dl1 or ind. If the data - scrolled off the bottom of the region by the ri re- - appears, then scrolling is non-destructive. System V and - XSI Curses expect that ind, ri, indn, and rin will simu- - late destructive scrolling; their documentation cautions - you not to define csr unless this is true. This curses + scrolled off the bottom of the region by the ri re- + appears, then scrolling is non-destructive. System V and + XSI Curses expect that ind, ri, indn, and rin will simu- + 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. If the terminal has the ability to define a window as part - of memory, which all commands affect, it should be given + of memory, which all commands affect, it should be given as the parameterized string wind. The four parameters are - the starting and ending lines in memory and the starting + the starting and ending lines in memory and the starting and ending columns in memory, in that order. - If the terminal can retain display memory above, then the - da capability should be given; if display memory can be - retained below, then db should be given. These indicate - that deleting a line or scrolling may bring non-blank - lines up from below or that scrolling back with ri may + If the terminal can retain display memory above, then the + da capability should be given; if display memory can be + retained below, then db should be given. These indicate + that deleting a line or scrolling may bring non-blank + lines up from below or that scrolling back with ri may 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 - using terminfo. The most common insert/delete character - operations affect only the characters on the current line - and shift characters off the end of the line rigidly. - Other terminals, such as the Concept 100 and the Perkin - Elmer Owl, make a distinction between typed and untyped - blanks on the screen, shifting upon an insert or delete - only to an untyped blank on the screen which is either - eliminated, or expanded to two untyped blanks. You can - determine the kind of terminal you have by clearing the - screen and then typing text separated by cursor motions. - Type "abc def" using local cursor motions (not spaces) + There are two basic kinds of intelligent terminals with + respect to insert/delete character which can be described + using terminfo. The most common insert/delete character + operations affect only the characters on the current line + and shift characters off the end of the line rigidly. + Other terminals, such as the Concept 100 and the Perkin + Elmer Owl, make a distinction between typed and untyped + blanks on the screen, shifting upon an insert or delete + only to an untyped blank on the screen which is either + eliminated, or expanded to two untyped blanks. You can + determine the kind of terminal you have by clearing the + screen and then typing text separated by cursor motions. + Type "abc def" 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 + 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 + 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- + 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. - Terminfo can describe both terminals which have an insert + Terminfo can describe both terminals which have an insert mode, and terminals which send a simple sequence to open a - 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. - - If your terminal has both, insert mode is usually prefer- - able to ich1. Technically, you should not give both - unless the terminal actually requires both to be used in - combination. Accordingly, some non-curses applications - get confused if both are present; the symptom is doubled + 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 + 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 + unless the terminal actually requires both to be used in + combination. Accordingly, some non-curses applications + get confused if both are present; the symptom is doubled characters in an update using insert. This requirement is now rare; most ich sequences do not require previous smir, and most smir insert modes do not require ich1 before each - character. Therefore, the new curses actually assumes - this is the case and uses either rmir/smir or ich/ich1 as + character. Therefore, the new curses actually assumes + this is the case and uses either rmir/smir or ich/ich1 as appropriate (but not both). If you have to write an entry - to be used under new curses for a terminal old enough to + to be used under new curses for a terminal old enough to need both, include the rmir/smir sequences in ich1. If post insert padding is needed, give this as a number of - milliseconds in ip (a string option). Any other sequence - which may need to be sent after an insert of a single + milliseconds in ip (a string option). Any other sequence + which may need to be sent after an insert of a single character may also be given in ip. If your terminal needs both to be placed into an `insert mode' and a special code - to precede each inserted character, then both smir/rmir - and ich1 can be given, and both will be used. The ich + to precede each inserted character, then both smir/rmir + and ich1 can be given, and both will be used. The ich capability, with one parameter, n, will repeat the effects of ich1 n times. If padding is necessary between characters typed while not - in insert mode, give this as a number of milliseconds + 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., - if there is a tab after the insertion position). If your - terminal allows motion while in insert mode you can give - the capability mir to speed up inserting in this case. - Omitting mir will affect only speed. Some terminals + It is occasionally necessary to move around while in + insert mode to delete characters on the same line (e.g., + if there is a tab after the insertion position). If your + terminal allows motion while in insert mode you can give + the capability mir to speed up inserting in this case. + Omitting mir will affect only speed. Some terminals (notably Datamedia's) must not have mir because of the way their insert mode works. - Finally, you can specify dch1 to delete a single charac- - ter, dch with one parameter, n, to delete n characters, - and delete mode by giving smdc and rmdc to enter and exit - delete mode (any mode the terminal needs to be placed in + Finally, you can specify dch1 to delete a single charac- + ter, dch with one parameter, n, to delete n characters, + and delete mode by giving smdc and rmdc to enter and exit + delete mode (any mode the terminal needs to be placed in for dch1 to work). - A command to erase n characters (equivalent to outputting - n blanks without moving the cursor) can be given as ech + A command to erase n characters (equivalent to outputting + 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- + attributes, these can be represented in a number of dif- ferent ways. You should choose one display form as stand- out mode, representing a good, high contrast, easy-on-the- - eyes, format for highlighting error messages and other - attention getters. (If you have a choice, reverse video - plus half-bright is good, or reverse video alone.) The - sequences to enter and exit standout mode are given as - smso and rmso, respectively. If the code to change into - or out of standout mode leaves one or even two blank - spaces on the screen, as the TVI 912 and Teleray 1061 do, + eyes, format for highlighting error messages and other + attention getters. (If you have a choice, reverse video + plus half-bright is good, or reverse video alone.) The + sequences to enter and exit standout mode are given as + smso and rmso, respectively. If the code to change into + or out of standout mode leaves one or even two blank + spaces on the screen, as the TVI 912 and Teleray 1061 do, then xmc should be given to tell how many spaces are left. - Codes to begin underlining and end underlining can be - given as smul and rmul respectively. If the terminal has - a code to underline the current character and move the + Codes to begin underlining and end underlining can be + given as smul and rmul respectively. If the terminal has + a code to underline the current character and move the cursor one space to the right, such as the Microterm Mime, this can be given as uc. - Other capabilities to enter various highlighting modes - include blink (blinking) bold (bold or extra bright) dim - (dim or half-bright) invis (blanking or invisible text) - prot (protected) rev (reverse video) sgr0 (turn off all - attribute modes) smacs (enter alternate character set - mode) and rmacs (exit alternate character set mode). - Turning on any of these modes singly may or may not turn + Other capabilities to enter various highlighting modes + include blink (blinking) bold (bold or extra bright) dim + (dim or half-bright) invis (blanking or invisible text) + prot (protected) rev (reverse video) sgr0 (turn off all + attribute modes) smacs (enter alternate character set + mode) and rmacs (exit alternate character set mode). + Turning on any of these modes singly may or may not turn off other modes. - If there is a sequence to set arbitrary combinations of - modes, this should be given as sgr (set attributes), tak- - ing 9 parameters. Each parameter is either 0 or nonzero, + If there is a sequence to set arbitrary combinations of + modes, this should be given as sgr (set attributes), tak- + ing 9 parameters. Each parameter is either 0 or nonzero, as the corresponding attribute is on or off. The 9 param- - eters are, in order: standout, underline, reverse, blink, - dim, bold, blank, protect, alternate character set. Not - all modes need be supported by sgr, only those for which + eters are, in order: standout, underline, reverse, blink, + dim, bold, blank, protect, alternate character set. Not + all modes need be supported by sgr, only those for which corresponding separate attribute commands exist. For example, the DEC vt220 supports most of the modes: - tparm parameter attribute escape sequence - - none none \E[0m - p1 standout \E[0;1;7m - p2 underline \E[0;4m - p3 reverse \E[0;7m - p4 blink \E[0;5m - p5 dim not available - p6 bold \E[0;1m - p7 invis \E[0;8m - p8 protect not used - p9 altcharset ^O (off) ^N (on) - - We begin each escape sequence by turning off any existing - modes, since there is no quick way to determine whether + + tparm parameter attribute escape sequence + + none none \E[0m + p1 standout \E[0;1;7m + p2 underline \E[0;4m + p3 reverse \E[0;7m + p4 blink \E[0;5m + p5 dim not available + p6 bold \E[0;1m + p7 invis \E[0;8m + p8 protect not used + p9 altcharset ^O (off) ^N (on) + + We begin each escape sequence by turning off any existing + modes, since there is no quick way to determine whether they are active. Standout is set up to be the combination - of reverse and bold. The vt220 terminal has a protect - mode, though it is not commonly used in sgr because it - protects characters on the screen from the host's era- - sures. The altcharset mode also is different in that it - is either ^O or ^N, depending on whether it is off or on. - If all modes are turned on, the resulting sequence is + of reverse and bold. The vt220 terminal has a protect + mode, though it is not commonly used in sgr because it + protects characters on the screen from the host's era- + sures. The altcharset mode also is different in that it + is either ^O or ^N, depending on whether it is off or on. + If all modes are turned on, the resulting sequence is \E[0;1;4;5;7;8m^N. - Some sequences are common to different modes. For exam- - ple, ;7 is output when either p1 or p3 is true, that is, + Some sequences are common to different modes. For exam- + ple, ;7 is output when either p1 or p3 is true, that is, if either standout or reverse modes are turned on. - Writing out the above sequences, along with their depen- + Writing out the above sequences, along with their depen- dencies yields - sequence when to output terminfo translation - \E[0 always \E[0 - ;1 if p1 or p6 %?%p1%p6%|%t;1%; - ;4 if p2 %?%p2%|%t;4%; - ;5 if p4 %?%p4%|%t;5%; - ;7 if p1 or p3 %?%p1%p3%|%t;7%; - ;8 if p7 %?%p7%|%t;8%; + sequence when to output terminfo translation + + \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%; - m always m - ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; + ;7 if p1 or p3 %?%p1%p3%|%t;7%; + ;8 if p7 %?%p7%|%t;8%; + m always m + ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; Putting this all together into the sgr sequence gives: sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p1%p3%|%t;7%; %?%p4%t;5%;%?%p7%t;8%;m%?%p9%t\016%e\017%;, - Remember that if you specify sgr, you must also specify - sgr0. - - Terminals with the ``magic cookie'' glitch (xmc) deposit - special ``cookies'' when they receive mode-setting - sequences, which affect the display algorithm rather than - having extra bits for each character. Some terminals, - such as the HP 2621, automatically leave standout mode - when they move to a new line or the cursor is addressed. - Programs using standout mode should exit standout mode - before moving the cursor or sending a newline, unless the - msgr capability, asserting that it is safe to move in + Remember that if you specify sgr, you must also specify + sgr0. Also, some implementations rely on sgr being given + if sgr0 is, Not all terminfo entries necessarily have an + sgr string, however. Many terminfo entries are derived + from termcap entries which have no sgr string. The only + drawback to adding an sgr string is that termcap also + assumes that sgr0 does not exit alternate character set + mode. + + Terminals with the ``magic cookie'' glitch (xmc) deposit + special ``cookies'' when they receive mode-setting + sequences, which affect the display algorithm rather than + having extra bits for each character. Some terminals, + such as the HP 2621, automatically leave standout mode + when they move to a new line or the cursor is addressed. + Programs using standout mode should exit standout mode + before moving the cursor or sending a newline, unless the + msgr capability, asserting that it is safe to move in standout mode, is present. - If the terminal has a way of flashing the screen to indi- - cate an error quietly (a bell replacement) then this can + If the terminal has a way of flashing the screen to indi- + cate an error quietly (a bell replacement) then this can be given as flash; it must not move the cursor. - If the cursor needs to be made more visible than normal + If the cursor needs to be made more visible than normal when it is not on the bottom line (to make, for example, a - non-blinking underline into an easier to find block or + non-blinking underline into an easier to find block or blinking underline) give this sequence as cvvis. If there - is a way to make the cursor completely invisible, give + is a way to make the cursor completely invisible, give that as civis. The capability cnorm should be given which undoes the effects of both of these modes. If your terminal correctly generates underlined characters - (with no special codes needed) even though it does not - overstrike, then you should give the capability ul. If a - character overstriking another leaves both characters on + (with no special codes needed) even though it does not + overstrike, then you should give the capability ul. If a + character overstriking another leaves both characters on the screen, specify the capability os. If overstrikes are - erasable with a blank, then this should be indicated by + erasable with a blank, then this should be indicated by giving eo. Keypad and Function Keys If the terminal has a keypad that transmits codes when the - keys are pressed, this information can be given. Note + keys are pressed, this information can be given. Note that it is not possible to handle terminals where the key- pad only works in local (this applies, for example, to the - unshifted HP 2621 keys). If the keypad can be set to - transmit or not transmit, give these codes as smkx and + unshifted HP 2621 keys). If the keypad can be set to + transmit or not transmit, give these codes as smkx and rmkx. Otherwise the keypad is assumed to always transmit. - The codes sent by the left arrow, right arrow, up arrow, - down arrow, and home keys can be given as kcub1, kcuf1, - kcuu1, kcud1, and khome respectively. If there are - function keys such as f0, f1, ..., f10, the codes they - send can be given as kf0, kf1, ..., kf10. If these keys - have labels other than the default f0 through f10, the - labels can be given as lf0, lf1, ..., lf10. The codes - transmitted by certain other special keys can be given: - kll (home down), kbs (backspace), ktbc (clear all tabs), - kctab (clear the tab stop in this column), kclr (clear - screen or erase key), kdch1 (delete character), kdl1 + 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: + 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 + of line), ked (clear to end of screen), kich1 (insert + character or enter insert mode), kil1 (insert line), knp (next page), kpp (previous page), kind (scroll for- ward/down), kri (scroll backward/up), khts (set a tab stop - in this column). In addition, if the keypad has a 3 by 3 - array of keys including the four arrow keys, the other - five keys can be given as ka1, ka3, kb2, kc1, and kc3. - These keys are useful when the effects of a 3 by 3 direc- + in this column). In addition, if the keypad has a 3 by 3 + array of keys including the four arrow keys, the other + five keys can be given as ka1, ka3, kb2, kc1, and kc3. + These keys are useful when the effects of a 3 by 3 direc- tional pad are needed. - 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 pre- - sent, since the user may not have the tab stops properly - set. If the terminal has hardware tabs which are ini- - tially set every n spaces when the terminal is powered up, - the numeric parameter it is given, showing the number of - spaces the tabs are set to. This is normally used by the - tset command to determine whether to set the mode for - 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 - will be printed in the following order: run the program - iprog; output is1; is2; set the margins using mgc, smgl - and smgr; set tabs using tbc and hts; print the file if; - and finally output is3. + of the tput program, each time the user logs in. They + will be printed in the following order: + + run the program + iprog + + output is1 is2 + + set the margins using + mgc, smgl and smgr + + set tabs using + tbc and hts + + print the file + if + + and finally + output is3. Most initialization is done with is2. Special terminal modes can be set up without duplicating strings by putting the common sequences in is2 and special cases in is1 and - is3. A pair of sequences that does a harder reset from a - totally unknown state can be analogously given as rs1, - rs2, rf, and rs3, analogous to is2 and if. These strings - are output by the reset program, which is used when the - terminal gets into a wedged state. Commands are normally - placed in rs1, rs2 rs3 and rf only if they produce annoy- - ing effects on the screen and are not necessary when log- - ging in. For example, the command to set the vt100 into - 80-column mode would normally be part of is2, but it - causes an annoying glitch of the screen and is not nor- - mally needed since the terminal is usually already in 80 - column mode. + is3. + + A set of sequences that does a harder reset from a totally + unknown state can be given as rs1, rs2, rf and rs3, analo- + gous to is1 , is2 , if and is3 respectively. These + strings are output by the reset program, which is used + when the terminal gets into a wedged state. Commands are + normally placed in rs1, rs2 rs3 and rf only if they pro- + duce annoying effects on the screen and are not necessary + when logging in. For example, the command to set the + vt100 into 80-column mode would normally be part of is2, + but it causes an annoying glitch of the screen and is not + normally needed since the terminal is usually already in + 80 column mode. + + The reset program writes strings including iprog, etc., in + the same order as the init program, using rs1, etc., + instead of is1, etc. If any of rs1, rs2, rs3, or rf reset + capability strings are missing, the reset program falls + back upon the corresponding initialization capability + string. If there are commands to set and clear tab stops, they can - be given as tbc (clear all tab stops) and hts (set a tab - 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 don't support either + Many older and slower terminals do not support either XON/XOFF or DTR handshaking, including hard copy terminals - and some very archaic CRTs (including, for example, DEC - VT100s). These may require padding characters after cer- + 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 - don't 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 - Name Name Default Name + + 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 < , @@ -1806,6 +1914,7 @@ 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 ! | @@ -1823,59 +1932,60 @@ 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 - numeric argument each. Argument values 0-7 are portably - defined as follows (the middle column is the symbolic - #define available in the header for the curses or ncurses - libraries). The terminal hardware is free to map these as - it likes, but the RGB values indicate normal locations in - color space. + The setaf/setab and setf/setb capabilities take a single + numeric argument each. Argument values 0-7 of setaf/setab + are portably defined as follows (the middle column is the + symbolic #define available in the header for the curses or + ncurses libraries). The terminal hardware is free to map + these as it likes, but the RGB values indicate normal + locations in color space. + Color #define Value RGB black COLOR_BLACK 0 0, 0, 0 @@ -1887,6 +1997,22 @@ cyan COLOR_CYAN 6 0,max,max white COLOR_WHITE 7 max,max,max + The argument values of setf/setb historically correspond + to a different mapping, i.e., + + Color #define Value RGB + black COLOR_BLACK 0 0, 0, 0 + blue COLOR_BLUE 1 0,0,max + green COLOR_GREEN 2 0,max,0 + cyan COLOR_CYAN 3 0,max,max + red COLOR_RED 4 max,0,0 + magenta COLOR_MAGENTA 5 max,0,max + yellow COLOR_YELLOW 6 max,max,0 + white COLOR_WHITE 7 max,max,max + It is important to not confuse the two sets of color capa- + bilities; otherwise red/blue will be interchanged on the + display. + On an HP-like terminal, use scp with a color-pair number parameter to set which color pair is current. @@ -1912,6 +2038,7 @@ 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 @@ -2055,6 +2182,7 @@ A capability can be canceled by placing xx@ to the left of the use reference that imports it, where xx is the capa- bility. For example, the entry + 2621-nl, smkx@, rmkx@, use=2621, defines a 2621-nl that does not have the smkx or rmkx @@ -2065,38 +2193,39 @@ Pitfalls of Long Entries Long terminfo entries are unlikely to be a problem; to - date, no entry has even approached terminfo's 4K string- - table maximum. Unfortunately, the termcap translations - are much more strictly limited (to 1K), thus termcap - translations of long terminfo entries can cause problems. - - The man pages for 4.3BSD and older versions of tgetent() - instruct the user to allocate a 1K buffer for the termcap - entry. The entry gets null-terminated by the termcap - library, so that makes the maximum safe length for a term- - cap entry 1k-1 (1023) bytes. Depending on what the appli- - cation and the termcap library being used does, and where - in the termcap file the terminal type that tgetent() is - searching for is, several bad things can happen. + date, no entry has even approached terminfo's 4096-byte + string-table maximum. Unfortunately, the termcap transla- + tions are much more strictly limited (to 1023 bytes), thus + termcap translations of long terminfo entries can cause + problems. + + The man pages for 4.3BSD and older versions of tgetent() + instruct the user to allocate a 1024-byte buffer for the + termcap entry. The entry gets null-terminated by the + termcap library, so that makes the maximum safe length for + a termcap entry 1k-1 (1023) bytes. Depending on what the + application and the termcap library being used does, and + where in the termcap file the terminal type that tgetent() + is searching for is, several bad things can happen. Some termcap libraries print a warning message or exit if they find an entry that's longer than 1023 bytes; others - don't; others truncate the entries to 1023 bytes. Some + do not; others truncate the entries to 1023 bytes. Some application programs allocate more than the recommended 1K - for the termcap entry; others don't. + for the termcap entry; others do not. Each termcap entry has two important sizes associated with it: before "tc" expansion, and after "tc" expansion. "tc" is the capability that tacks on another termcap entry to the end of the current one, to add on its capabilities. - If a termcap entry doesn't use the "tc" capability, then + 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 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: @@ -2107,16 +2236,16 @@ * and the termcap library (like the one in BSD/OS 1.1 and GNU) reads the whole entry into the buffer, no - matter what its length, to see if it's the entry it + matter what its length, to see if it is the entry it wants, - * and tgetent() is searching for a terminal type that + * and tgetent() is searching for a terminal type that either is the long entry, appears in the termcap file - after the long entry, or doesn't appear in the file - at all (so that tgetent() has to search the whole + after the long entry, or does not appear in the file + at all (so that tgetent() has to search the whole termcap file). - Then tgetent() will overwrite memory, perhaps its stack, + 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 @@ -2129,20 +2258,20 @@ The "after tc expansion" length will have a similar effect to the above, but only for people who actually set TERM to - that terminal type, since tgetent() only does "tc" expan- - sion once it's found the terminal type it was looking for, - not while searching. + that terminal type, since tgetent() only does "tc" expan- + sion once it is found the terminal type it was looking + for, not while searching. In summary, a termcap entry that is longer than 1023 bytes can cause, on various combinations of termcap libraries and applications, a core dump, warnings, or incorrect - operation. If it's too long even before "tc" expansion, + 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 termcap entry. When in -C (translate to termcap) mode, the ncurses imple- - mentation of tic(1) issues warning messages when the pre- + mentation of tic(1m) issues warning messages when the pre- tc length of a termcap translation is too long. The -c (check) option also checks resolved (after tc expansion) lengths. @@ -2160,13 +2289,13 @@
Some SVr4 curses implementations, and all previous to - SVr4, don't interpret the %A and %O operators in parameter - strings. + 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 don't - trigger local motions). The ncurses implementation + 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 @@ -2222,64 +2351,20 @@ descriptions -
- tic(1m), curses(3x), printf(3S), term(5). + tic(1m), infocmp(1m), curses(3x), printf(3), term(5). + term_variables(3x).
- Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. + Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + terminfo(5)