| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> |
| 2 | <!-- |
| 3 | * t |
| 4 | * DO NOT EDIT THIS FILE BY HAND! |
| 5 | * It is generated from terminfo.head, Caps, and terminfo.tail. |
| 6 | * Note: this must be run through tbl before nroff. |
| 7 | * The magic cookie on the first line triggers this under some man programs. |
| 8 | **************************************************************************** |
| 9 | * Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * |
| 10 | * * |
| 11 | * Permission is hereby granted, free of charge, to any person obtaining a * |
| 12 | * copy of this software and associated documentation files (the * |
| 13 | * "Software"), to deal in the Software without restriction, including * |
| 14 | * without limitation the rights to use, copy, modify, merge, publish, * |
| 15 | * distribute, distribute with modifications, sublicense, and/or sell * |
| 16 | * copies of the Software, and to permit persons to whom the Software is * |
| 17 | * furnished to do so, subject to the following conditions: * |
| 18 | * * |
| 19 | * The above copyright notice and this permission notice shall be included * |
| 20 | * in all copies or substantial portions of the Software. * |
| 21 | * * |
| 22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 23 | * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 24 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 25 | * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 26 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 27 | * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 28 | * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 29 | * * |
| 30 | * Except as contained in this notice, the name(s) of the above copyright * |
| 31 | * holders shall not be used in advertising or otherwise to promote the * |
| 32 | * sale, use or other dealings in this Software without prior written * |
| 33 | * authorization. * |
| 34 | **************************************************************************** |
| 35 | * @Id: terminfo.head,v 1.16 2007/03/04 00:09:46 tom Exp @ |
| 36 | * Head of terminfo man page ends here |
| 37 | * @Id: terminfo.tail,v 1.49 2008/02/16 20:57:43 tom Exp @ |
| 38 | * Beginning of terminfo.tail file |
| 39 | * This file is part of ncurses. |
| 40 | * See "terminfo.head" for copyright. |
| 41 | *.in -2 |
| 42 | *.in +2 |
| 43 | *.in -2 |
| 44 | *.in +2 |
| 45 | *.TH |
| 46 | --> |
| 47 | <HTML> |
| 48 | <HEAD> |
| 49 | <TITLE>terminfo 5 File Formats</TITLE> |
| 50 | <link rev=made href="mailto:bug-ncurses@gnu.org"> |
| 51 | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 52 | </HEAD> |
| 53 | <BODY> |
| 54 | <H1>terminfo 5 File Formats</H1> |
| 55 | <HR> |
| 56 | <PRE> |
| 57 | <!-- Manpage converted by man2html 3.0.1 --> |
| 58 | <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> File Formats <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> |
| 59 | |
| 60 | |
| 61 | |
| 62 | |
| 63 | </PRE> |
| 64 | <H2>NAME</H2><PRE> |
| 65 | terminfo - terminal capability data base |
| 66 | |
| 67 | |
| 68 | </PRE> |
| 69 | <H2>SYNOPSIS</H2><PRE> |
| 70 | /usr/share/terminfo/*/* |
| 71 | |
| 72 | |
| 73 | </PRE> |
| 74 | <H2>DESCRIPTION</H2><PRE> |
| 75 | <EM>Terminfo</EM> is a data base describing terminals, used by |
| 76 | screen-oriented programs such as <STRONG><A HREF="nvi.1.html">nvi(1)</A></STRONG>, <STRONG><A HREF="rogue.1.html">rogue(1)</A></STRONG> and |
| 77 | libraries such as <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. <EM>Terminfo</EM> describes termi- |
| 78 | nals by giving a set of capabilities which they have, by |
| 79 | specifying how to perform screen operations, and by speci- |
| 80 | fying padding requirements and initialization sequences. |
| 81 | This describes <STRONG>ncurses</STRONG> version 5.6 (patch 20081011). |
| 82 | |
| 83 | Entries in <EM>terminfo</EM> consist of a sequence of `,' separated |
| 84 | fields (embedded commas may be escaped with a backslash or |
| 85 | notated as \054). White space after the `,' separator is |
| 86 | ignored. The first entry for each terminal gives the |
| 87 | names which are known for the terminal, separated by `|' |
| 88 | characters. The first name given is the most common |
| 89 | abbreviation for the terminal, the last name given should |
| 90 | be a long name fully identifying the terminal, and all |
| 91 | others are understood as synonyms for the terminal name. |
| 92 | All names but the last should be in lower case and contain |
| 93 | no blanks; the last name may well contain upper case and |
| 94 | blanks for readability. |
| 95 | |
| 96 | Lines beginning with a `#' in the first column are treated |
| 97 | as comments. While comment lines are legal at any point, |
| 98 | the output of <STRONG>captoinfo</STRONG> and <STRONG>infotocap</STRONG> (aliases for <STRONG>tic</STRONG>) |
| 99 | will move comments so they occur only between entries. |
| 100 | |
| 101 | Newlines and leading tabs may be used for formatting |
| 102 | entries for readability. These are removed from parsed |
| 103 | entries. The <STRONG>infocmp</STRONG> <STRONG>-f</STRONG> option relies on this to format |
| 104 | if-then-else expressions: the result can be read by <STRONG>tic</STRONG>. |
| 105 | |
| 106 | Terminal names (except for the last, verbose entry) should |
| 107 | be chosen using the following conventions. The particular |
| 108 | piece of hardware making up the terminal should have a |
| 109 | root name, thus ``hp2621''. This name should not contain |
| 110 | hyphens. Modes that the hardware can be in, or user pref- |
| 111 | erences, should be indicated by appending a hyphen and a |
| 112 | mode suffix. Thus, a vt100 in 132 column mode would be |
| 113 | vt100-w. The following suffixes should be used where pos- |
| 114 | sible: |
| 115 | |
| 116 | |
| 117 | <STRONG>Suffix</STRONG> <STRONG>Meaning</STRONG> <STRONG>Example</STRONG> |
| 118 | -<EM>nn</EM> Number of lines on the screen aaa-60 |
| 119 | -<EM>n</EM>p Number of pages of memory c100-4p |
| 120 | -am With automargins (usually the default) vt100-am |
| 121 | -m Mono mode; suppress color ansi-m |
| 122 | -mc Magic cookie; spaces when highlighting wy30-mc |
| 123 | -na No arrow keys (leave them in local) c100-na |
| 124 | -nam Without automatic margins vt100-nam |
| 125 | -nl No status line att4415-nl |
| 126 | -ns No status line hp2626-ns |
| 127 | -rv Reverse video c100-rv |
| 128 | -s Enable status line vt100-s |
| 129 | |
| 130 | -vb Use visible bell instead of beep wy370-vb |
| 131 | -w Wide mode (> 80 columns, usually 132) vt100-w |
| 132 | |
| 133 | For more on terminal naming conventions, see the <STRONG>term(7)</STRONG> |
| 134 | manual page. |
| 135 | |
| 136 | <STRONG>Capabilities</STRONG> |
| 137 | The following is a complete table of the capabilities |
| 138 | included in a terminfo description block and available to |
| 139 | terminfo-using code. In each line of the table, |
| 140 | |
| 141 | The <STRONG>variable</STRONG> is the name by which the programmer (at the |
| 142 | terminfo level) accesses the capability. |
| 143 | |
| 144 | The <STRONG>capname</STRONG> is the short name used in the text of the |
| 145 | database, and is used by a person updating the database. |
| 146 | Whenever possible, capnames are chosen to be the same as |
| 147 | or similar to the ANSI X3.64-1979 standard (now superseded |
| 148 | by ECMA-48, which uses identical or very similar names). |
| 149 | Semantics are also intended to match those of the specifi- |
| 150 | cation. |
| 151 | |
| 152 | The termcap code is the old <STRONG>termcap</STRONG> capability name (some |
| 153 | capabilities are new, and have names which termcap did not |
| 154 | originate). |
| 155 | |
| 156 | Capability names have no hard length limit, but an infor- |
| 157 | mal limit of 5 characters has been adopted to keep them |
| 158 | short and to allow the tabs in the source file <STRONG>Caps</STRONG> to |
| 159 | line up nicely. |
| 160 | |
| 161 | Finally, the description field attempts to convey the |
| 162 | semantics of the capability. You may find some codes in |
| 163 | the description field: |
| 164 | |
| 165 | (P) indicates that padding may be specified |
| 166 | |
| 167 | #[1-9] in the description field indicates that the string |
| 168 | is passed through tparm with parms as given (#<EM>i</EM>). |
| 169 | |
| 170 | (P*) indicates that padding may vary in proportion to |
| 171 | the number of lines affected |
| 172 | |
| 173 | (#<EM>i</EM>) indicates the <EM>i</EM>th parameter. |
| 174 | |
| 175 | |
| 176 | These are the boolean capabilities: |
| 177 | |
| 178 | |
| 179 | <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> |
| 180 | <STRONG>Booleans</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> |
| 181 | auto_left_margin bw bw cub1 wraps from col- |
| 182 | umn 0 to last column |
| 183 | auto_right_margin am am terminal has auto- |
| 184 | matic margins |
| 185 | back_color_erase bce ut screen erased with |
| 186 | background color |
| 187 | can_change ccc cc terminal can re- |
| 188 | define existing col- |
| 189 | ors |
| 190 | ceol_standout_glitch xhp xs standout not erased |
| 191 | by overwriting (hp) |
| 192 | col_addr_glitch xhpa YA only positive motion |
| 193 | for hpa/mhpa caps |
| 194 | |
| 195 | |
| 196 | cpi_changes_res cpix YF changing character |
| 197 | pitch changes reso- |
| 198 | lution |
| 199 | cr_cancels_micro_mode crxm YB using cr turns off |
| 200 | micro mode |
| 201 | dest_tabs_magic_smso xt xt tabs destructive, |
| 202 | magic so char |
| 203 | (t1061) |
| 204 | eat_newline_glitch xenl xn newline ignored |
| 205 | after 80 cols (con- |
| 206 | cept) |
| 207 | erase_overstrike eo eo can erase over- |
| 208 | strikes with a blank |
| 209 | generic_type gn gn generic line type |
| 210 | hard_copy hc hc hardcopy terminal |
| 211 | hard_cursor chts HC cursor is hard to |
| 212 | see |
| 213 | has_meta_key km km Has a meta key |
| 214 | (i.e., sets 8th-bit) |
| 215 | has_print_wheel daisy YC printer needs opera- |
| 216 | tor to change char- |
| 217 | acter set |
| 218 | has_status_line hs hs has extra status |
| 219 | line |
| 220 | hue_lightness_saturation hls hl terminal uses only |
| 221 | HLS color notation |
| 222 | (Tektronix) |
| 223 | insert_null_glitch in in insert mode distin- |
| 224 | guishes nulls |
| 225 | lpi_changes_res lpix YG changing line pitch |
| 226 | changes resolution |
| 227 | memory_above da da display may be |
| 228 | retained above the |
| 229 | screen |
| 230 | memory_below db db display may be |
| 231 | retained below the |
| 232 | screen |
| 233 | move_insert_mode mir mi safe to move while |
| 234 | in insert mode |
| 235 | move_standout_mode msgr ms safe to move while |
| 236 | in standout mode |
| 237 | needs_xon_xoff nxon nx padding will not |
| 238 | work, xon/xoff |
| 239 | required |
| 240 | no_esc_ctlc xsb xb beehive (f1=escape, |
| 241 | f2=ctrl C) |
| 242 | no_pad_char npc NP pad character does |
| 243 | not exist |
| 244 | non_dest_scroll_region ndscr ND scrolling region is |
| 245 | non-destructive |
| 246 | non_rev_rmcup nrrmc NR smcup does not |
| 247 | reverse rmcup |
| 248 | over_strike os os terminal can over- |
| 249 | strike |
| 250 | prtr_silent mc5i 5i printer will not |
| 251 | echo on screen |
| 252 | row_addr_glitch xvpa YD only positive motion |
| 253 | for vpa/mvpa caps |
| 254 | semi_auto_right_margin sam YE printing in last |
| 255 | column causes cr |
| 256 | status_line_esc_ok eslok es escape can be used |
| 257 | on the status line |
| 258 | tilde_glitch hz hz cannot print ~'s |
| 259 | (hazeltine) |
| 260 | |
| 261 | |
| 262 | transparent_underline ul ul underline character |
| 263 | overstrikes |
| 264 | xon_xoff xon xo terminal uses |
| 265 | xon/xoff handshaking |
| 266 | |
| 267 | These are the numeric capabilities: |
| 268 | |
| 269 | |
| 270 | <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> |
| 271 | <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> |
| 272 | columns cols co number of columns in |
| 273 | a line |
| 274 | init_tabs it it tabs initially every |
| 275 | # spaces |
| 276 | label_height lh lh rows in each label |
| 277 | label_width lw lw columns in each |
| 278 | label |
| 279 | lines lines li number of lines on |
| 280 | screen or page |
| 281 | lines_of_memory lm lm lines of memory if > |
| 282 | line. 0 means varies |
| 283 | magic_cookie_glitch xmc sg number of blank |
| 284 | characters left by |
| 285 | smso or rmso |
| 286 | max_attributes ma ma maximum combined |
| 287 | attributes terminal |
| 288 | can handle |
| 289 | max_colors colors Co maximum number of |
| 290 | colors on screen |
| 291 | max_pairs pairs pa maximum number of |
| 292 | color-pairs on the |
| 293 | screen |
| 294 | maximum_windows wnum MW maximum number of |
| 295 | defineable windows |
| 296 | no_color_video ncv NC video attributes |
| 297 | that cannot be used |
| 298 | with colors |
| 299 | num_labels nlab Nl number of labels on |
| 300 | screen |
| 301 | padding_baud_rate pb pb lowest baud rate |
| 302 | where padding needed |
| 303 | virtual_terminal vt vt virtual terminal |
| 304 | number (CB/unix) |
| 305 | width_status_line wsl ws number of columns in |
| 306 | status line |
| 307 | |
| 308 | The following numeric capabilities are present in the |
| 309 | SVr4.0 term structure, but are not yet documented in the |
| 310 | man page. They came in with SVr4's printer support. |
| 311 | |
| 312 | |
| 313 | <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> |
| 314 | <STRONG>Numeric</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> |
| 315 | bit_image_entwining bitwin Yo number of passes for |
| 316 | each bit-image row |
| 317 | bit_image_type bitype Yp type of bit-image |
| 318 | device |
| 319 | buffer_capacity bufsz Ya numbers of bytes |
| 320 | buffered before |
| 321 | printing |
| 322 | buttons btns BT number of buttons on |
| 323 | mouse |
| 324 | dot_horz_spacing spinh Yc spacing of dots hor- |
| 325 | izontally in dots |
| 326 | per inch |
| 327 | |
| 328 | dot_vert_spacing spinv Yb spacing of pins ver- |
| 329 | tically in pins per |
| 330 | inch |
| 331 | max_micro_address maddr Yd maximum value in |
| 332 | micro_..._address |
| 333 | max_micro_jump mjump Ye maximum value in |
| 334 | parm_..._micro |
| 335 | micro_col_size mcs Yf character step size |
| 336 | when in micro mode |
| 337 | micro_line_size mls Yg line step size when |
| 338 | in micro mode |
| 339 | number_of_pins npins Yh numbers of pins in |
| 340 | print-head |
| 341 | output_res_char orc Yi horizontal resolu- |
| 342 | tion in units per |
| 343 | line |
| 344 | output_res_horz_inch orhi Yk horizontal resolu- |
| 345 | tion in units per |
| 346 | inch |
| 347 | output_res_line orl Yj vertical resolution |
| 348 | in units per line |
| 349 | output_res_vert_inch orvi Yl vertical resolution |
| 350 | in units per inch |
| 351 | print_rate cps Ym print rate in char- |
| 352 | acters per second |
| 353 | wide_char_size widcs Yn character step size |
| 354 | when in double wide |
| 355 | mode |
| 356 | |
| 357 | These are the string capabilities: |
| 358 | |
| 359 | |
| 360 | <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> |
| 361 | <STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> |
| 362 | acs_chars acsc ac graphics charset |
| 363 | pairs, based on |
| 364 | vt100 |
| 365 | back_tab cbt bt back tab (P) |
| 366 | bell bel bl audible signal |
| 367 | (bell) (P) |
| 368 | carriage_return cr cr carriage return (P*) |
| 369 | (P*) |
| 370 | change_char_pitch cpi ZA Change number of |
| 371 | characters per inch |
| 372 | to #1 |
| 373 | change_line_pitch lpi ZB Change number of |
| 374 | lines per inch to #1 |
| 375 | change_res_horz chr ZC Change horizontal |
| 376 | resolution to #1 |
| 377 | change_res_vert cvr ZD Change vertical res- |
| 378 | olution to #1 |
| 379 | change_scroll_region csr cs change region to |
| 380 | line #1 to line #2 |
| 381 | (P) |
| 382 | char_padding rmp rP like ip but when in |
| 383 | insert mode |
| 384 | clear_all_tabs tbc ct clear all tab stops |
| 385 | (P) |
| 386 | clear_margins mgc MC clear right and left |
| 387 | soft margins |
| 388 | clear_screen clear cl clear screen and |
| 389 | home cursor (P*) |
| 390 | clr_bol el1 cb Clear to beginning |
| 391 | of line |
| 392 | |
| 393 | |
| 394 | clr_eol el ce clear to end of line |
| 395 | (P) |
| 396 | clr_eos ed cd clear to end of |
| 397 | screen (P*) |
| 398 | column_address hpa ch horizontal position |
| 399 | #1, absolute (P) |
| 400 | command_character cmdch CC terminal settable |
| 401 | cmd character in |
| 402 | prototype !? |
| 403 | create_window cwin CW define a window #1 |
| 404 | from #2,#3 to #4,#5 |
| 405 | cursor_address cup cm move to row #1 |
| 406 | columns #2 |
| 407 | cursor_down cud1 do down one line |
| 408 | cursor_home home ho home cursor (if no |
| 409 | cup) |
| 410 | cursor_invisible civis vi make cursor invisi- |
| 411 | ble |
| 412 | cursor_left cub1 le move left one space |
| 413 | cursor_mem_address mrcup CM memory relative cur- |
| 414 | sor addressing, move |
| 415 | to row #1 columns #2 |
| 416 | cursor_normal cnorm ve make cursor appear |
| 417 | normal (undo |
| 418 | civis/cvvis) |
| 419 | cursor_right cuf1 nd non-destructive |
| 420 | space (move right |
| 421 | one space) |
| 422 | cursor_to_ll ll ll last line, first |
| 423 | column (if no cup) |
| 424 | cursor_up cuu1 up up one line |
| 425 | cursor_visible cvvis vs make cursor very |
| 426 | visible |
| 427 | define_char defc ZE Define a character |
| 428 | #1, #2 dots wide, |
| 429 | descender #3 |
| 430 | delete_character dch1 dc delete character |
| 431 | (P*) |
| 432 | delete_line dl1 dl delete line (P*) |
| 433 | dial_phone dial DI dial number #1 |
| 434 | dis_status_line dsl ds disable status line |
| 435 | display_clock dclk DK display clock |
| 436 | down_half_line hd hd half a line down |
| 437 | ena_acs enacs eA enable alternate |
| 438 | char set |
| 439 | enter_alt_charset_mode smacs as start alternate |
| 440 | character set (P) |
| 441 | enter_am_mode smam SA turn on automatic |
| 442 | margins |
| 443 | enter_blink_mode blink mb turn on blinking |
| 444 | enter_bold_mode bold md turn on bold (extra |
| 445 | bright) mode |
| 446 | enter_ca_mode smcup ti string to start pro- |
| 447 | grams using cup |
| 448 | enter_delete_mode smdc dm enter delete mode |
| 449 | enter_dim_mode dim mh turn on half-bright |
| 450 | mode |
| 451 | enter_doublewide_mode swidm ZF Enter double-wide |
| 452 | mode |
| 453 | enter_draft_quality sdrfq ZG Enter draft-quality |
| 454 | mode |
| 455 | enter_insert_mode smir im enter insert mode |
| 456 | enter_italics_mode sitm ZH Enter italic mode |
| 457 | enter_leftward_mode slm ZI Start leftward car- |
| 458 | riage motion |
| 459 | |
| 460 | enter_micro_mode smicm ZJ Start micro-motion |
| 461 | mode |
| 462 | enter_near_letter_quality snlq ZK Enter NLQ mode |
| 463 | enter_normal_quality snrmq ZL Enter normal-quality |
| 464 | mode |
| 465 | enter_protected_mode prot mp turn on protected |
| 466 | mode |
| 467 | enter_reverse_mode rev mr turn on reverse |
| 468 | video mode |
| 469 | enter_secure_mode invis mk turn on blank mode |
| 470 | (characters invisi- |
| 471 | ble) |
| 472 | enter_shadow_mode sshm ZM Enter shadow-print |
| 473 | mode |
| 474 | enter_standout_mode smso so begin standout mode |
| 475 | enter_subscript_mode ssubm ZN Enter subscript mode |
| 476 | enter_superscript_mode ssupm ZO Enter superscript |
| 477 | mode |
| 478 | enter_underline_mode smul us begin underline mode |
| 479 | enter_upward_mode sum ZP Start upward car- |
| 480 | riage motion |
| 481 | enter_xon_mode smxon SX turn on xon/xoff |
| 482 | handshaking |
| 483 | erase_chars ech ec erase #1 characters |
| 484 | (P) |
| 485 | exit_alt_charset_mode rmacs ae end alternate char- |
| 486 | acter set (P) |
| 487 | exit_am_mode rmam RA turn off automatic |
| 488 | margins |
| 489 | exit_attribute_mode sgr0 me turn off all |
| 490 | attributes |
| 491 | exit_ca_mode rmcup te strings to end pro- |
| 492 | grams using cup |
| 493 | exit_delete_mode rmdc ed end delete mode |
| 494 | exit_doublewide_mode rwidm ZQ End double-wide mode |
| 495 | exit_insert_mode rmir ei exit insert mode |
| 496 | exit_italics_mode ritm ZR End italic mode |
| 497 | exit_leftward_mode rlm ZS End left-motion mode |
| 498 | exit_micro_mode rmicm ZT End micro-motion |
| 499 | mode |
| 500 | exit_shadow_mode rshm ZU End shadow-print |
| 501 | mode |
| 502 | exit_standout_mode rmso se exit standout mode |
| 503 | exit_subscript_mode rsubm ZV End subscript mode |
| 504 | exit_superscript_mode rsupm ZW End superscript mode |
| 505 | exit_underline_mode rmul ue exit underline mode |
| 506 | exit_upward_mode rum ZX End reverse charac- |
| 507 | ter motion |
| 508 | exit_xon_mode rmxon RX turn off xon/xoff |
| 509 | handshaking |
| 510 | fixed_pause pause PA pause for 2-3 sec- |
| 511 | onds |
| 512 | flash_hook hook fh flash switch hook |
| 513 | flash_screen flash vb visible bell (may |
| 514 | not move cursor) |
| 515 | form_feed ff ff hardcopy terminal |
| 516 | page eject (P*) |
| 517 | from_status_line fsl fs return from status |
| 518 | line |
| 519 | goto_window wingo WG go to window #1 |
| 520 | hangup hup HU hang-up phone |
| 521 | init_1string is1 i1 initialization |
| 522 | string |
| 523 | init_2string is2 is initialization |
| 524 | string |
| 525 | |
| 526 | init_3string is3 i3 initialization |
| 527 | string |
| 528 | init_file if if name of initializa- |
| 529 | tion file |
| 530 | init_prog iprog iP path name of program |
| 531 | for initialization |
| 532 | initialize_color initc Ic initialize color #1 |
| 533 | to (#2,#3,#4) |
| 534 | initialize_pair initp Ip Initialize color |
| 535 | pair #1 to |
| 536 | fg=(#2,#3,#4), |
| 537 | bg=(#5,#6,#7) |
| 538 | insert_character ich1 ic insert character (P) |
| 539 | insert_line il1 al insert line (P*) |
| 540 | insert_padding ip ip insert padding after |
| 541 | inserted character |
| 542 | key_a1 ka1 K1 upper left of keypad |
| 543 | key_a3 ka3 K3 upper right of key- |
| 544 | pad |
| 545 | key_b2 kb2 K2 center of keypad |
| 546 | key_backspace kbs kb backspace key |
| 547 | key_beg kbeg @1 begin key |
| 548 | key_btab kcbt kB back-tab key |
| 549 | key_c1 kc1 K4 lower left of keypad |
| 550 | key_c3 kc3 K5 lower right of key- |
| 551 | pad |
| 552 | key_cancel kcan @2 cancel key |
| 553 | key_catab ktbc ka clear-all-tabs key |
| 554 | key_clear kclr kC clear-screen or |
| 555 | erase key |
| 556 | key_close kclo @3 close key |
| 557 | key_command kcmd @4 command key |
| 558 | key_copy kcpy @5 copy key |
| 559 | key_create kcrt @6 create key |
| 560 | key_ctab kctab kt clear-tab key |
| 561 | key_dc kdch1 kD delete-character key |
| 562 | key_dl kdl1 kL delete-line key |
| 563 | key_down kcud1 kd down-arrow key |
| 564 | key_eic krmir kM sent by rmir or smir |
| 565 | in insert mode |
| 566 | key_end kend @7 end key |
| 567 | key_enter kent @8 enter/send key |
| 568 | key_eol kel kE clear-to-end-of-line |
| 569 | key |
| 570 | key_eos ked kS clear-to-end-of- |
| 571 | screen key |
| 572 | key_exit kext @9 exit key |
| 573 | key_f0 kf0 k0 F0 function key |
| 574 | key_f1 kf1 k1 F1 function key |
| 575 | key_f10 kf10 k; F10 function key |
| 576 | key_f11 kf11 F1 F11 function key |
| 577 | key_f12 kf12 F2 F12 function key |
| 578 | key_f13 kf13 F3 F13 function key |
| 579 | key_f14 kf14 F4 F14 function key |
| 580 | key_f15 kf15 F5 F15 function key |
| 581 | key_f16 kf16 F6 F16 function key |
| 582 | key_f17 kf17 F7 F17 function key |
| 583 | key_f18 kf18 F8 F18 function key |
| 584 | key_f19 kf19 F9 F19 function key |
| 585 | key_f2 kf2 k2 F2 function key |
| 586 | key_f20 kf20 FA F20 function key |
| 587 | key_f21 kf21 FB F21 function key |
| 588 | key_f22 kf22 FC F22 function key |
| 589 | key_f23 kf23 FD F23 function key |
| 590 | key_f24 kf24 FE F24 function key |
| 591 | |
| 592 | key_f25 kf25 FF F25 function key |
| 593 | key_f26 kf26 FG F26 function key |
| 594 | key_f27 kf27 FH F27 function key |
| 595 | key_f28 kf28 FI F28 function key |
| 596 | key_f29 kf29 FJ F29 function key |
| 597 | key_f3 kf3 k3 F3 function key |
| 598 | key_f30 kf30 FK F30 function key |
| 599 | key_f31 kf31 FL F31 function key |
| 600 | key_f32 kf32 FM F32 function key |
| 601 | key_f33 kf33 FN F33 function key |
| 602 | key_f34 kf34 FO F34 function key |
| 603 | key_f35 kf35 FP F35 function key |
| 604 | key_f36 kf36 FQ F36 function key |
| 605 | key_f37 kf37 FR F37 function key |
| 606 | key_f38 kf38 FS F38 function key |
| 607 | key_f39 kf39 FT F39 function key |
| 608 | key_f4 kf4 k4 F4 function key |
| 609 | key_f40 kf40 FU F40 function key |
| 610 | key_f41 kf41 FV F41 function key |
| 611 | key_f42 kf42 FW F42 function key |
| 612 | key_f43 kf43 FX F43 function key |
| 613 | key_f44 kf44 FY F44 function key |
| 614 | key_f45 kf45 FZ F45 function key |
| 615 | key_f46 kf46 Fa F46 function key |
| 616 | key_f47 kf47 Fb F47 function key |
| 617 | key_f48 kf48 Fc F48 function key |
| 618 | key_f49 kf49 Fd F49 function key |
| 619 | key_f5 kf5 k5 F5 function key |
| 620 | key_f50 kf50 Fe F50 function key |
| 621 | key_f51 kf51 Ff F51 function key |
| 622 | key_f52 kf52 Fg F52 function key |
| 623 | key_f53 kf53 Fh F53 function key |
| 624 | key_f54 kf54 Fi F54 function key |
| 625 | key_f55 kf55 Fj F55 function key |
| 626 | key_f56 kf56 Fk F56 function key |
| 627 | key_f57 kf57 Fl F57 function key |
| 628 | key_f58 kf58 Fm F58 function key |
| 629 | key_f59 kf59 Fn F59 function key |
| 630 | key_f6 kf6 k6 F6 function key |
| 631 | key_f60 kf60 Fo F60 function key |
| 632 | key_f61 kf61 Fp F61 function key |
| 633 | key_f62 kf62 Fq F62 function key |
| 634 | key_f63 kf63 Fr F63 function key |
| 635 | key_f7 kf7 k7 F7 function key |
| 636 | key_f8 kf8 k8 F8 function key |
| 637 | key_f9 kf9 k9 F9 function key |
| 638 | key_find kfnd @0 find key |
| 639 | key_help khlp %1 help key |
| 640 | key_home khome kh home key |
| 641 | key_ic kich1 kI insert-character key |
| 642 | key_il kil1 kA insert-line key |
| 643 | key_left kcub1 kl left-arrow key |
| 644 | key_ll kll kH lower-left key (home |
| 645 | down) |
| 646 | key_mark kmrk %2 mark key |
| 647 | key_message kmsg %3 message key |
| 648 | key_move kmov %4 move key |
| 649 | key_next knxt %5 next key |
| 650 | key_npage knp kN next-page key |
| 651 | key_open kopn %6 open key |
| 652 | key_options kopt %7 options key |
| 653 | key_ppage kpp kP previous-page key |
| 654 | key_previous kprv %8 previous key |
| 655 | key_print kprt %9 print key |
| 656 | key_redo krdo %0 redo key |
| 657 | |
| 658 | key_reference kref &1 reference key |
| 659 | key_refresh krfr &2 refresh key |
| 660 | key_replace krpl &3 replace key |
| 661 | key_restart krst &4 restart key |
| 662 | key_resume kres &5 resume key |
| 663 | key_right kcuf1 kr right-arrow key |
| 664 | key_save ksav &6 save key |
| 665 | key_sbeg kBEG &9 shifted begin key |
| 666 | key_scancel kCAN &0 shifted cancel key |
| 667 | key_scommand kCMD *1 shifted command key |
| 668 | key_scopy kCPY *2 shifted copy key |
| 669 | key_screate kCRT *3 shifted create key |
| 670 | key_sdc kDC *4 shifted delete-char- |
| 671 | acter key |
| 672 | key_sdl kDL *5 shifted delete-line |
| 673 | key |
| 674 | key_select kslt *6 select key |
| 675 | key_send kEND *7 shifted end key |
| 676 | key_seol kEOL *8 shifted clear-to- |
| 677 | end-of-line key |
| 678 | key_sexit kEXT *9 shifted exit key |
| 679 | key_sf kind kF scroll-forward key |
| 680 | key_sfind kFND *0 shifted find key |
| 681 | key_shelp kHLP #1 shifted help key |
| 682 | key_shome kHOM #2 shifted home key |
| 683 | key_sic kIC #3 shifted insert-char- |
| 684 | acter key |
| 685 | key_sleft kLFT #4 shifted left-arrow |
| 686 | key |
| 687 | key_smessage kMSG %a shifted message key |
| 688 | key_smove kMOV %b shifted move key |
| 689 | key_snext kNXT %c shifted next key |
| 690 | key_soptions kOPT %d shifted options key |
| 691 | key_sprevious kPRV %e shifted previous key |
| 692 | key_sprint kPRT %f shifted print key |
| 693 | key_sr kri kR scroll-backward key |
| 694 | key_sredo kRDO %g shifted redo key |
| 695 | key_sreplace kRPL %h shifted replace key |
| 696 | key_sright kRIT %i shifted right-arrow |
| 697 | key |
| 698 | key_srsume kRES %j shifted resume key |
| 699 | key_ssave kSAV !1 shifted save key |
| 700 | key_ssuspend kSPD !2 shifted suspend key |
| 701 | key_stab khts kT set-tab key |
| 702 | key_sundo kUND !3 shifted undo key |
| 703 | key_suspend kspd &7 suspend key |
| 704 | key_undo kund &8 undo key |
| 705 | key_up kcuu1 ku up-arrow key |
| 706 | keypad_local rmkx ke leave 'key- |
| 707 | board_transmit' mode |
| 708 | keypad_xmit smkx ks enter 'key- |
| 709 | board_transmit' mode |
| 710 | lab_f0 lf0 l0 label on function |
| 711 | key f0 if not f0 |
| 712 | lab_f1 lf1 l1 label on function |
| 713 | key f1 if not f1 |
| 714 | lab_f10 lf10 la label on function |
| 715 | key f10 if not f10 |
| 716 | lab_f2 lf2 l2 label on function |
| 717 | key f2 if not f2 |
| 718 | lab_f3 lf3 l3 label on function |
| 719 | key f3 if not f3 |
| 720 | lab_f4 lf4 l4 label on function |
| 721 | key f4 if not f4 |
| 722 | |
| 723 | |
| 724 | lab_f5 lf5 l5 label on function |
| 725 | key f5 if not f5 |
| 726 | lab_f6 lf6 l6 label on function |
| 727 | key f6 if not f6 |
| 728 | lab_f7 lf7 l7 label on function |
| 729 | key f7 if not f7 |
| 730 | lab_f8 lf8 l8 label on function |
| 731 | key f8 if not f8 |
| 732 | lab_f9 lf9 l9 label on function |
| 733 | key f9 if not f9 |
| 734 | label_format fln Lf label format |
| 735 | label_off rmln LF turn off soft labels |
| 736 | label_on smln LO turn on soft labels |
| 737 | meta_off rmm mo turn off meta mode |
| 738 | meta_on smm mm turn on meta mode |
| 739 | (8th-bit on) |
| 740 | micro_column_address mhpa ZY Like column_address |
| 741 | in micro mode |
| 742 | micro_down mcud1 ZZ Like cursor_down in |
| 743 | micro mode |
| 744 | micro_left mcub1 Za Like cursor_left in |
| 745 | micro mode |
| 746 | micro_right mcuf1 Zb Like cursor_right in |
| 747 | micro mode |
| 748 | micro_row_address mvpa Zc Like row_address #1 |
| 749 | in micro mode |
| 750 | micro_up mcuu1 Zd Like cursor_up in |
| 751 | micro mode |
| 752 | newline nel nw newline (behave like |
| 753 | cr followed by lf) |
| 754 | order_of_pins porder Ze Match software bits |
| 755 | to print-head pins |
| 756 | orig_colors oc oc Set all color pairs |
| 757 | to the original ones |
| 758 | orig_pair op op Set default pair to |
| 759 | its original value |
| 760 | pad_char pad pc padding char |
| 761 | (instead of null) |
| 762 | parm_dch dch DC delete #1 characters |
| 763 | (P*) |
| 764 | parm_delete_line dl DL delete #1 lines (P*) |
| 765 | parm_down_cursor cud DO down #1 lines (P*) |
| 766 | parm_down_micro mcud Zf Like parm_down_cur- |
| 767 | sor in micro mode |
| 768 | parm_ich ich IC insert #1 characters |
| 769 | (P*) |
| 770 | parm_index indn SF scroll forward #1 |
| 771 | lines (P) |
| 772 | parm_insert_line il AL insert #1 lines (P*) |
| 773 | parm_left_cursor cub LE move #1 characters |
| 774 | to the left (P) |
| 775 | parm_left_micro mcub Zg Like parm_left_cur- |
| 776 | sor in micro mode |
| 777 | parm_right_cursor cuf RI move #1 characters |
| 778 | to the right (P*) |
| 779 | parm_right_micro mcuf Zh Like parm_right_cur- |
| 780 | sor in micro mode |
| 781 | parm_rindex rin SR scroll back #1 lines |
| 782 | (P) |
| 783 | parm_up_cursor cuu UP up #1 lines (P*) |
| 784 | parm_up_micro mcuu Zi Like parm_up_cursor |
| 785 | in micro mode |
| 786 | pkey_key pfkey pk program function key |
| 787 | #1 to type string #2 |
| 788 | |
| 789 | |
| 790 | pkey_local pfloc pl program function key |
| 791 | #1 to execute string |
| 792 | #2 |
| 793 | pkey_xmit pfx px program function key |
| 794 | #1 to transmit |
| 795 | string #2 |
| 796 | plab_norm pln pn program label #1 to |
| 797 | show string #2 |
| 798 | print_screen mc0 ps print contents of |
| 799 | screen |
| 800 | prtr_non mc5p pO turn on printer for |
| 801 | #1 bytes |
| 802 | prtr_off mc4 pf turn off printer |
| 803 | prtr_on mc5 po turn on printer |
| 804 | pulse pulse PU select pulse dialing |
| 805 | quick_dial qdial QD dial number #1 with- |
| 806 | out checking |
| 807 | remove_clock rmclk RC remove clock |
| 808 | repeat_char rep rp repeat char #1 #2 |
| 809 | times (P*) |
| 810 | req_for_input rfi RF send next input char |
| 811 | (for ptys) |
| 812 | reset_1string rs1 r1 reset string |
| 813 | reset_2string rs2 r2 reset string |
| 814 | reset_3string rs3 r3 reset string |
| 815 | reset_file rf rf name of reset file |
| 816 | restore_cursor rc rc restore cursor to |
| 817 | position of last |
| 818 | save_cursor |
| 819 | row_address vpa cv vertical position #1 |
| 820 | absolute (P) |
| 821 | save_cursor sc sc save current cursor |
| 822 | position (P) |
| 823 | scroll_forward ind sf scroll text up (P) |
| 824 | scroll_reverse ri sr scroll text down (P) |
| 825 | select_char_set scs Zj Select character |
| 826 | set, #1 |
| 827 | set_attributes sgr sa define video |
| 828 | attributes #1-#9 |
| 829 | (PG9) |
| 830 | set_background setb Sb Set background color |
| 831 | #1 |
| 832 | set_bottom_margin smgb Zk Set bottom margin at |
| 833 | current line |
| 834 | set_bottom_margin_parm smgbp Zl Set bottom margin at |
| 835 | line #1 or (if smgtp |
| 836 | is not given) #2 |
| 837 | lines from bottom |
| 838 | set_clock sclk SC set clock, #1 hrs #2 |
| 839 | mins #3 secs |
| 840 | set_color_pair scp sp Set current color |
| 841 | pair to #1 |
| 842 | set_foreground setf Sf Set foreground color |
| 843 | #1 |
| 844 | set_left_margin smgl ML set left soft margin |
| 845 | at current column. |
| 846 | See smgl. (ML is not |
| 847 | in BSD termcap). |
| 848 | set_left_margin_parm smglp Zm Set left (right) |
| 849 | margin at column #1 |
| 850 | set_right_margin smgr MR set right soft mar- |
| 851 | gin at current col- |
| 852 | umn |
| 853 | set_right_margin_parm smgrp Zn Set right margin at |
| 854 | column #1 |
| 855 | |
| 856 | set_tab hts st set a tab in every |
| 857 | row, current columns |
| 858 | set_top_margin smgt Zo Set top margin at |
| 859 | current line |
| 860 | set_top_margin_parm smgtp Zp Set top (bottom) |
| 861 | margin at row #1 |
| 862 | set_window wind wi current window is |
| 863 | lines #1-#2 cols |
| 864 | #3-#4 |
| 865 | start_bit_image sbim Zq Start printing bit |
| 866 | image graphics |
| 867 | start_char_set_def scsd Zr Start character set |
| 868 | definition #1, with |
| 869 | #2 characters in the |
| 870 | set |
| 871 | stop_bit_image rbim Zs Stop printing bit |
| 872 | image graphics |
| 873 | stop_char_set_def rcsd Zt End definition of |
| 874 | character set #1 |
| 875 | subscript_characters subcs Zu List of subscript- |
| 876 | able characters |
| 877 | superscript_characters supcs Zv List of superscript- |
| 878 | able characters |
| 879 | tab ht ta tab to next 8-space |
| 880 | hardware tab stop |
| 881 | these_cause_cr docr Zw Printing any of |
| 882 | these characters |
| 883 | causes CR |
| 884 | to_status_line tsl ts move to status line, |
| 885 | column #1 |
| 886 | tone tone TO select touch tone |
| 887 | dialing |
| 888 | underline_char uc uc underline char and |
| 889 | move past it |
| 890 | up_half_line hu hu half a line up |
| 891 | user0 u0 u0 User string #0 |
| 892 | user1 u1 u1 User string #1 |
| 893 | user2 u2 u2 User string #2 |
| 894 | user3 u3 u3 User string #3 |
| 895 | user4 u4 u4 User string #4 |
| 896 | user5 u5 u5 User string #5 |
| 897 | user6 u6 u6 User string #6 |
| 898 | user7 u7 u7 User string #7 |
| 899 | user8 u8 u8 User string #8 |
| 900 | user9 u9 u9 User string #9 |
| 901 | wait_tone wait WA wait for dial-tone |
| 902 | xoff_character xoffc XF XOFF character |
| 903 | xon_character xonc XN XON character |
| 904 | zero_motion zerom Zx No motion for subse- |
| 905 | quent character |
| 906 | |
| 907 | The following string capabilities are present in the |
| 908 | SVr4.0 term structure, but were originally not documented |
| 909 | in the man page. |
| 910 | |
| 911 | |
| 912 | <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> |
| 913 | <STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> |
| 914 | alt_scancode_esc scesa S8 Alternate escape |
| 915 | for scancode emu- |
| 916 | lation |
| 917 | bit_image_carriage_return bicr Yv Move to beginning |
| 918 | of same row |
| 919 | bit_image_newline binel Zz Move to next row |
| 920 | of the bit image |
| 921 | |
| 922 | bit_image_repeat birep Xy Repeat bit image |
| 923 | cell #1 #2 times |
| 924 | char_set_names csnm Zy Produce #1'th item |
| 925 | from list of char- |
| 926 | acter set names |
| 927 | code_set_init csin ci Init sequence for |
| 928 | multiple codesets |
| 929 | color_names colornm Yw Give name for |
| 930 | color #1 |
| 931 | define_bit_image_region defbi Yx Define rectan- |
| 932 | gualar bit image |
| 933 | region |
| 934 | device_type devt dv Indicate lan- |
| 935 | guage/codeset sup- |
| 936 | port |
| 937 | display_pc_char dispc S1 Display PC charac- |
| 938 | ter #1 |
| 939 | end_bit_image_region endbi Yy End a bit-image |
| 940 | region |
| 941 | enter_pc_charset_mode smpch S2 Enter PC character |
| 942 | display mode |
| 943 | enter_scancode_mode smsc S4 Enter PC scancode |
| 944 | mode |
| 945 | exit_pc_charset_mode rmpch S3 Exit PC character |
| 946 | display mode |
| 947 | exit_scancode_mode rmsc S5 Exit PC scancode |
| 948 | mode |
| 949 | get_mouse getm Gm Curses should get |
| 950 | button events, |
| 951 | parameter #1 not |
| 952 | documented. |
| 953 | key_mouse kmous Km Mouse event has |
| 954 | occurred |
| 955 | mouse_info minfo Mi Mouse status |
| 956 | information |
| 957 | pc_term_options pctrm S6 PC terminal |
| 958 | options |
| 959 | pkey_plab pfxl xl Program function |
| 960 | key #1 to type |
| 961 | string #2 and show |
| 962 | string #3 |
| 963 | req_mouse_pos reqmp RQ Request mouse |
| 964 | position |
| 965 | scancode_escape scesc S7 Escape for scan- |
| 966 | code emulation |
| 967 | set0_des_seq s0ds s0 Shift to codeset 0 |
| 968 | (EUC set 0, ASCII) |
| 969 | set1_des_seq s1ds s1 Shift to codeset 1 |
| 970 | set2_des_seq s2ds s2 Shift to codeset 2 |
| 971 | set3_des_seq s3ds s3 Shift to codeset 3 |
| 972 | set_a_background setab AB Set background |
| 973 | color to #1, using |
| 974 | ANSI escape |
| 975 | set_a_foreground setaf AF Set foreground |
| 976 | color to #1, using |
| 977 | ANSI escape |
| 978 | set_color_band setcolor Yz Change to ribbon |
| 979 | color #1 |
| 980 | set_lr_margin smglr ML Set both left and |
| 981 | right margins to |
| 982 | #1, #2. (ML is |
| 983 | not in BSD term- |
| 984 | cap). |
| 985 | set_page_length slines YZ Set page length to |
| 986 | #1 lines |
| 987 | |
| 988 | set_tb_margin smgtb MT Sets both top and |
| 989 | bottom margins to |
| 990 | #1, #2 |
| 991 | |
| 992 | The XSI Curses standard added these. They are some |
| 993 | post-4.1 versions of System V curses, e.g., Solaris 2.5 |
| 994 | and IRIX 6.x. The <STRONG>ncurses</STRONG> termcap names for them are |
| 995 | invented; according to the XSI Curses standard, they have |
| 996 | no termcap names. If your compiled terminfo entries use |
| 997 | these, they may not be binary-compatible with System V |
| 998 | terminfo entries after SVr4.1; beware! |
| 999 | |
| 1000 | |
| 1001 | <STRONG>Variable</STRONG> <STRONG>Cap-</STRONG> <STRONG>TCap</STRONG> <STRONG>Description</STRONG> |
| 1002 | <STRONG>String</STRONG> <STRONG>name</STRONG> <STRONG>Code</STRONG> |
| 1003 | enter_horizontal_hl_mode ehhlm Xh Enter horizontal |
| 1004 | highlight mode |
| 1005 | enter_left_hl_mode elhlm Xl Enter left highlight |
| 1006 | mode |
| 1007 | enter_low_hl_mode elohlm Xo Enter low highlight |
| 1008 | mode |
| 1009 | enter_right_hl_mode erhlm Xr Enter right high- |
| 1010 | light mode |
| 1011 | enter_top_hl_mode ethlm Xt Enter top highlight |
| 1012 | mode |
| 1013 | enter_vertical_hl_mode evhlm Xv Enter vertical high- |
| 1014 | light mode |
| 1015 | set_a_attributes sgr1 sA Define second set of |
| 1016 | video attributes |
| 1017 | #1-#6 |
| 1018 | set_pglen_inch slengthsL YI Set page length |
| 1019 | to #1 hundredth of |
| 1020 | an inch |
| 1021 | |
| 1022 | <STRONG>A</STRONG> <STRONG>Sample</STRONG> <STRONG>Entry</STRONG> |
| 1023 | The following entry, describing an ANSI-standard terminal, |
| 1024 | is representative of what a <STRONG>terminfo</STRONG> entry for a modern |
| 1025 | terminal typically looks like. |
| 1026 | |
| 1027 | ansi|ansi/pc-term compatible with color, |
| 1028 | mc5i, |
| 1029 | colors#8, ncv#3, pairs#64, |
| 1030 | cub=\E[%p1%dD, cud=\E[%p1%dB, cuf=\E[%p1%dC, |
| 1031 | cuu=\E[%p1%dA, dch=\E[%p1%dP, dl=\E[%p1%dM, |
| 1032 | ech=\E[%p1%dX, el1=\E[1K, hpa=\E[%p1%dG, ht=\E[I, |
| 1033 | ich=\E[%p1%d@, il=\E[%p1%dL, indn=\E[%p1%dS, .indn=\E[%p1%dT, |
| 1034 | kbs=^H, kcbt=\E[Z, kcub1=\E[D, kcud1=\E[B, |
| 1035 | kcuf1=\E[C, kcuu1=\E[A, kf1=\E[M, kf10=\E[V, |
| 1036 | kf11=\E[W, kf12=\E[X, kf2=\E[N, kf3=\E[O, kf4=\E[P, |
| 1037 | kf5=\E[Q, kf6=\E[R, kf7=\E[S, kf8=\E[T, kf9=\E[U, |
| 1038 | kich1=\E[L, mc4=\E[4i, mc5=\E[5i, nel=\r\E[S, |
| 1039 | op=\E[37;40m, rep=%p1%c\E[%p2%{1}%-%db, |
| 1040 | rin=\E[%p1%dT, s0ds=\E(B, s1ds=\E)B, s2ds=\E*B, |
| 1041 | s3ds=\E+B, setab=\E[4%p1%dm, setaf=\E[3%p1%dm, |
| 1042 | setb=\E[4%?%p1%{1}%=%t4%e%p1%{3}%=%t6%e%p1%{4}%=%t1%e%p1%{6}%=%t3%e%p1%d%;m, |
| 1043 | setf=\E[3%?%p1%{1}%=%t4%e%p1%{3}%=%t6%e%p1%{4}%=%t1%e%p1%{6}%=%t3%e%p1%d%;m, |
| 1044 | sgr=\E[0;10%?%p1%t;7%;%?%p2%t;4%;%?%p3%t;7%;%?%p4%t;5%;%?%p6%t;1%;%?%p7%t;8%;%?%p8%t;11%;%?%p9%t;12%;m, |
| 1045 | sgr0=\E[0;10m, tbc=\E[2g, u6=\E[%d;%dR, u7=\E[6n, |
| 1046 | u8=\E[?%[;0123456789]c, u9=\E[c, vpa=\E[%p1%dd, |
| 1047 | |
| 1048 | Entries may continue onto multiple lines by placing white |
| 1049 | space at the beginning of each line except the first. |
| 1050 | Comments may be included on lines beginning with ``#''. |
| 1051 | Capabilities in <EM>terminfo</EM> are of three types: Boolean capa- |
| 1052 | bilities which indicate that the terminal has some partic- |
| 1053 | ular feature, numeric capabilities giving the size of the |
| 1054 | terminal or the size of particular delays, and string |
| 1055 | capabilities, which give a sequence which can be used to |
| 1056 | perform particular terminal operations. |
| 1057 | |
| 1058 | |
| 1059 | <STRONG>Types</STRONG> <STRONG>of</STRONG> <STRONG>Capabilities</STRONG> |
| 1060 | All capabilities have names. For instance, the fact that |
| 1061 | ANSI-standard terminals have <EM>automatic</EM> <EM>margins</EM> (i.e., an |
| 1062 | automatic return and line-feed when the end of a line is |
| 1063 | reached) is indicated by the capability <STRONG>am</STRONG>. Hence the |
| 1064 | description of ansi includes <STRONG>am</STRONG>. Numeric capabilities are |
| 1065 | followed by the character `#' and then a positive value. |
| 1066 | Thus <STRONG>cols</STRONG>, which indicates the number of columns the ter- |
| 1067 | minal has, gives the value `80' for ansi. Values for |
| 1068 | numeric capabilities may be specified in decimal, octal or |
| 1069 | hexadecimal, using the C programming language conventions |
| 1070 | (e.g., 255, 0377 and 0xff or 0xFF). |
| 1071 | |
| 1072 | Finally, string valued capabilities, such as <STRONG>el</STRONG> (clear to |
| 1073 | end of line sequence) are given by the two-character code, |
| 1074 | an `=', and then a string ending at the next following |
| 1075 | `,'. |
| 1076 | |
| 1077 | A number of escape sequences are provided in the string |
| 1078 | valued capabilities for easy encoding of characters there. |
| 1079 | Both <STRONG>\E</STRONG> and <STRONG>\e</STRONG> map to an ESCAPE character, <STRONG>^x</STRONG> maps to a |
| 1080 | control-x for any appropriate x, and the sequences <STRONG>\n</STRONG> <STRONG>\l</STRONG> |
| 1081 | <STRONG>\r</STRONG> <STRONG>\t</STRONG> <STRONG>\b</STRONG> <STRONG>\f</STRONG> <STRONG>\s</STRONG> give a newline, line-feed, return, tab, |
| 1082 | backspace, form-feed, and space. Other escapes include <STRONG>\^</STRONG> |
| 1083 | for <STRONG>^</STRONG>, <STRONG>\\</STRONG> for <STRONG>\</STRONG>, <STRONG>\</STRONG>, for comma, <STRONG>\:</STRONG> for <STRONG>:</STRONG>, and <STRONG>\0</STRONG> for null. |
| 1084 | (<STRONG>\0</STRONG> will produce \200, which does not terminate a string |
| 1085 | but behaves as a null character on most terminals, provid- |
| 1086 | ing CS7 is specified. See <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>.) Finally, characters |
| 1087 | may be given as three octal digits after a <STRONG>\</STRONG>. |
| 1088 | |
| 1089 | A delay in milliseconds may appear anywhere in a string |
| 1090 | capability, enclosed in $<..> brackets, as in <STRONG>el</STRONG>=\EK$<5>, |
| 1091 | and padding characters are supplied by <EM>tputs</EM> to provide |
| 1092 | this delay. The delay must be a number with at most one |
| 1093 | decimal place of precision; it may be followed by suffixes |
| 1094 | `*' or '/' or both. A `*' indicates that the padding |
| 1095 | required is proportional to the number of lines affected |
| 1096 | by the operation, and the amount given is the per- |
| 1097 | affected-unit padding required. (In the case of insert |
| 1098 | character, the factor is still the number of <EM>lines</EM> |
| 1099 | affected.) Normally, padding is advisory if the device |
| 1100 | has the <STRONG>xon</STRONG> capability; it is used for cost computation |
| 1101 | but does not trigger delays. A `/' suffix indicates that |
| 1102 | the padding is mandatory and forces a delay of the given |
| 1103 | number of milliseconds even on devices for which <STRONG>xon</STRONG> is |
| 1104 | present to indicate flow control. |
| 1105 | |
| 1106 | Sometimes individual capabilities must be commented out. |
| 1107 | To do this, put a period before the capability name. For |
| 1108 | example, see the second <STRONG>ind</STRONG> in the example above. |
| 1109 | |
| 1110 | |
| 1111 | <STRONG>Fetching</STRONG> <STRONG>Compiled</STRONG> <STRONG>Descriptions</STRONG> |
| 1112 | If the environment variable TERMINFO is set, it is inter- |
| 1113 | preted as the pathname of a directory containing the com- |
| 1114 | piled description you are working on. Only that directory |
| 1115 | is searched. |
| 1116 | |
| 1117 | If TERMINFO is not set, the <STRONG>ncurses</STRONG> version of the ter- |
| 1118 | minfo reader code will instead look in the directory |
| 1119 | <STRONG>$HOME/.terminfo</STRONG> for a compiled description. If it fails |
| 1120 | to find one there, and the environment variable TER- |
| 1121 | MINFO_DIRS is set, it will interpret the contents of that |
| 1122 | variable as a list of colon- separated directories to be |
| 1123 | searched (an empty entry is interpreted as a command to |
| 1124 | search <EM>/usr/share/terminfo</EM>). If no description is found |
| 1125 | in any of the TERMINFO_DIRS directories, the fetch fails. |
| 1126 | |
| 1127 | If neither TERMINFO nor TERMINFO_DIRS is set, the last |
| 1128 | place tried will be the system terminfo directory, |
| 1129 | <EM>/usr/share/terminfo</EM>. |
| 1130 | |
| 1131 | (Neither the <STRONG>$HOME/.terminfo</STRONG> lookups nor TERMINFO_DIRS |
| 1132 | extensions are supported under stock System V ter- |
| 1133 | minfo/curses.) |
| 1134 | |
| 1135 | |
| 1136 | <STRONG>Preparing</STRONG> <STRONG>Descriptions</STRONG> |
| 1137 | We now outline how to prepare descriptions of terminals. |
| 1138 | The most effective way to prepare a terminal description |
| 1139 | is by imitating the description of a similar terminal in |
| 1140 | <EM>terminfo</EM> and to build up a description gradually, using |
| 1141 | partial descriptions with <EM>vi</EM> or some other screen-oriented |
| 1142 | program to check that they are correct. Be aware that a |
| 1143 | very unusual terminal may expose deficiencies in the abil- |
| 1144 | ity of the <EM>terminfo</EM> file to describe it or bugs in the |
| 1145 | screen-handling code of the test program. |
| 1146 | |
| 1147 | To get the padding for insert line right (if the terminal |
| 1148 | manufacturer did not document it) a severe test is to edit |
| 1149 | a large file at 9600 baud, delete 16 or so lines from the |
| 1150 | middle of the screen, then hit the `u' key several times |
| 1151 | quickly. If the terminal messes up, more padding is usu- |
| 1152 | ally needed. A similar test can be used for insert char- |
| 1153 | acter. |
| 1154 | |
| 1155 | |
| 1156 | <STRONG>Basic</STRONG> <STRONG>Capabilities</STRONG> |
| 1157 | The number of columns on each line for the terminal is |
| 1158 | given by the <STRONG>cols</STRONG> numeric capability. If the terminal is |
| 1159 | a CRT, then the number of lines on the screen is given by |
| 1160 | the <STRONG>lines</STRONG> capability. If the terminal wraps around to the |
| 1161 | beginning of the next line when it reaches the right mar- |
| 1162 | gin, then it should have the <STRONG>am</STRONG> capability. If the termi- |
| 1163 | nal can clear its screen, leaving the cursor in the home |
| 1164 | position, then this is given by the <STRONG>clear</STRONG> string capabil- |
| 1165 | ity. If the terminal overstrikes (rather than clearing a |
| 1166 | position when a character is struck over) then it should |
| 1167 | have the <STRONG>os</STRONG> capability. If the terminal is a printing |
| 1168 | terminal, with no soft copy unit, give it both <STRONG>hc</STRONG> and <STRONG>os</STRONG>. |
| 1169 | (<STRONG>os</STRONG> applies to storage scope terminals, such as TEKTRONIX |
| 1170 | 4010 series, as well as hard copy and APL terminals.) If |
| 1171 | there is a code to move the cursor to the left edge of the |
| 1172 | current row, give this as <STRONG>cr</STRONG>. (Normally this will be car- |
| 1173 | riage return, control M.) If there is a code to produce |
| 1174 | an audible signal (bell, beep, etc) give this as <STRONG>bel</STRONG>. |
| 1175 | |
| 1176 | If there is a code to move the cursor one position to the |
| 1177 | left (such as backspace) that capability should be given |
| 1178 | as <STRONG>cub1</STRONG>. Similarly, codes to move to the right, up, and |
| 1179 | down should be given as <STRONG>cuf1</STRONG>, <STRONG>cuu1</STRONG>, and <STRONG>cud1</STRONG>. These local |
| 1180 | cursor motions should not alter the text they pass over, |
| 1181 | for example, you would not normally use `<STRONG>cuf1</STRONG>= ' because |
| 1182 | the space would erase the character moved over. |
| 1183 | |
| 1184 | A very important point here is that the local cursor |
| 1185 | motions encoded in <EM>terminfo</EM> are undefined at the left and |
| 1186 | top edges of a CRT terminal. Programs should never |
| 1187 | attempt to backspace around the left edge, unless <STRONG>bw</STRONG> is |
| 1188 | given, and never attempt to go up locally off the top. In |
| 1189 | order to scroll text up, a program will go to the bottom |
| 1190 | left corner of the screen and send the <STRONG>ind</STRONG> (index) string. |
| 1191 | |
| 1192 | To scroll text down, a program goes to the top left corner |
| 1193 | of the screen and sends the <STRONG>ri</STRONG> (reverse index) string. |
| 1194 | The strings <STRONG>ind</STRONG> and <STRONG>ri</STRONG> are undefined when not on their |
| 1195 | respective corners of the screen. |
| 1196 | |
| 1197 | Parameterized versions of the scrolling sequences are <STRONG>indn</STRONG> |
| 1198 | and <STRONG>rin</STRONG> which have the same semantics as <STRONG>ind</STRONG> and <STRONG>ri</STRONG> except |
| 1199 | that they take one parameter, and scroll that many lines. |
| 1200 | They are also undefined except at the appropriate edge of |
| 1201 | the screen. |
| 1202 | |
| 1203 | The <STRONG>am</STRONG> capability tells whether the cursor sticks at the |
| 1204 | right edge of the screen when text is output, but this |
| 1205 | does not necessarily apply to a <STRONG>cuf1</STRONG> from the last column. |
| 1206 | The only local motion which is defined from the left edge |
| 1207 | is if <STRONG>bw</STRONG> is given, then a <STRONG>cub1</STRONG> from the left edge will |
| 1208 | move to the right edge of the previous row. If <STRONG>bw</STRONG> is not |
| 1209 | given, the effect is undefined. This is useful for draw- |
| 1210 | ing a box around the edge of the screen, for example. If |
| 1211 | the terminal has switch selectable automatic margins, the |
| 1212 | <EM>terminfo</EM> file usually assumes that this is on; i.e., <STRONG>am</STRONG>. |
| 1213 | If the terminal has a command which moves to the first |
| 1214 | column of the next line, that command can be given as <STRONG>nel</STRONG> |
| 1215 | (newline). It does not matter if the command clears the |
| 1216 | remainder of the current line, so if the terminal has no |
| 1217 | <STRONG>cr</STRONG> and <STRONG>lf</STRONG> it may still be possible to craft a working <STRONG>nel</STRONG> |
| 1218 | out of one or both of them. |
| 1219 | |
| 1220 | These capabilities suffice to describe hard-copy and |
| 1221 | "glass-tty" terminals. Thus the model 33 teletype is |
| 1222 | described as |
| 1223 | |
| 1224 | 33|tty33|tty|model 33 teletype, |
| 1225 | bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os, |
| 1226 | |
| 1227 | while the Lear Siegler ADM-3 is described as |
| 1228 | |
| 1229 | adm3|3|lsi adm3, |
| 1230 | am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J, |
| 1231 | ind=^J, lines#24, |
| 1232 | |
| 1233 | |
| 1234 | <STRONG>Parameterized</STRONG> <STRONG>Strings</STRONG> |
| 1235 | Cursor addressing and other strings requiring parameters |
| 1236 | in the terminal are described by a parameterized string |
| 1237 | capability, with <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG> like escapes <STRONG>%x</STRONG> in it. For |
| 1238 | example, to address the cursor, the <STRONG>cup</STRONG> capability is |
| 1239 | given, using two parameters: the row and column to address |
| 1240 | to. (Rows and columns are numbered from zero and refer to |
| 1241 | the physical screen visible to the user, not to any unseen |
| 1242 | memory.) If the terminal has memory relative cursor |
| 1243 | addressing, that can be indicated by <STRONG>mrcup</STRONG>. |
| 1244 | |
| 1245 | The parameter mechanism uses a stack and special <STRONG>%</STRONG> codes |
| 1246 | to manipulate it. Typically a sequence will push one of |
| 1247 | the parameters onto the stack and then print it in some |
| 1248 | format. Print (e.g., "%d") is a special case. Other |
| 1249 | operations, including "%t" pop their operand from the |
| 1250 | stack. It is noted that more complex operations are often |
| 1251 | necessary, e.g., in the <STRONG>sgr</STRONG> string. |
| 1252 | |
| 1253 | The <STRONG>%</STRONG> encodings have the following meanings: |
| 1254 | |
| 1255 | |
| 1256 | %% outputs `%' |
| 1257 | |
| 1258 | %<EM>[[</EM>:<EM>]flags][width[.precision]][</EM>doxXs<EM>]</EM> |
| 1259 | as in <STRONG>printf</STRONG>, flags are [-+#] and space. Use a `:' |
| 1260 | to allow the next character to be a `-' flag, avoid- |
| 1261 | ing interpreting "%-" as an operator. |
| 1262 | |
| 1263 | %c print pop() like %c in <STRONG>printf</STRONG> |
| 1264 | |
| 1265 | %s print pop() like %s in <STRONG>printf</STRONG> |
| 1266 | |
| 1267 | %p[1-9] |
| 1268 | push <EM>i</EM>'th parameter |
| 1269 | |
| 1270 | %P[a-z] |
| 1271 | set dynamic variable [a-z] to pop() |
| 1272 | |
| 1273 | %g[a-z] |
| 1274 | get dynamic variable [a-z] and push it |
| 1275 | |
| 1276 | %P[A-Z] |
| 1277 | set static variable [a-z] to pop() |
| 1278 | |
| 1279 | %g[A-Z] |
| 1280 | get static variable [a-z] and push it |
| 1281 | |
| 1282 | The terms "static" and "dynamic" are misleading. |
| 1283 | Historically, these are simply two different sets of |
| 1284 | variables, whose values are not reset between calls |
| 1285 | to <STRONG>tparm</STRONG>. However, that fact is not documented in |
| 1286 | other implementations. Relying on it will adversely |
| 1287 | impact portability to other implementations. |
| 1288 | |
| 1289 | %'<EM>c</EM>' char constant <EM>c</EM> |
| 1290 | |
| 1291 | %{<EM>nn</EM>} |
| 1292 | integer constant <EM>nn</EM> |
| 1293 | |
| 1294 | %l push strlen(pop) |
| 1295 | |
| 1296 | %+ %- %* %/ %m |
| 1297 | arithmetic (%m is mod): push(pop() op pop()) |
| 1298 | |
| 1299 | %& %| %^ |
| 1300 | bit operations (AND, OR and exclusive-OR): push(pop() |
| 1301 | op pop()) |
| 1302 | |
| 1303 | %= %> %< |
| 1304 | logical operations: push(pop() op pop()) |
| 1305 | |
| 1306 | %A, %O |
| 1307 | logical AND and OR operations (for conditionals) |
| 1308 | |
| 1309 | %! %~ |
| 1310 | unary operations (logical and bit complement): |
| 1311 | push(op pop()) |
| 1312 | |
| 1313 | %i add 1 to first two parameters (for ANSI terminals) |
| 1314 | |
| 1315 | %? <EM>expr</EM> %t <EM>thenpart</EM> %e <EM>elsepart</EM> %; |
| 1316 | This forms an if-then-else. The %e <EM>elsepart</EM> is |
| 1317 | optional. Usually the %? <EM>expr</EM> part pushes a value |
| 1318 | onto the stack, and %t pops it from the stack, test- |
| 1319 | ing if it is nonzero (true). If it is zero (false), |
| 1320 | control passes to the %e (else) part. |
| 1321 | |
| 1322 | It is possible to form else-if's a la Algol 68: |
| 1323 | %? c1 %t b1 %e c2 %t b2 %e c3 %t b3 %e c4 %t b4 %e %; |
| 1324 | |
| 1325 | where ci are conditions, bi are bodies. |
| 1326 | |
| 1327 | Use the <STRONG>-f</STRONG> option of <STRONG>tic</STRONG> or <STRONG>infocmp</STRONG> to see the struc- |
| 1328 | ture of if-the-else's. Some strings, e.g., <STRONG>sgr</STRONG> can |
| 1329 | be very complicated when written on one line. The <STRONG>-f</STRONG> |
| 1330 | option splits the string into lines with the parts |
| 1331 | indented. |
| 1332 | |
| 1333 | Binary operations are in postfix form with the operands in |
| 1334 | the usual order. That is, to get x-5 one would use |
| 1335 | "%gx%{5}%-". %P and %g variables are persistent across |
| 1336 | escape-string evaluations. |
| 1337 | |
| 1338 | Consider the HP2645, which, to get to row 3 and column 12, |
| 1339 | needs to be sent \E&a12c03Y padded for 6 milliseconds. |
| 1340 | Note that the order of the rows and columns is inverted |
| 1341 | here, and that the row and column are printed as two dig- |
| 1342 | its. Thus its <STRONG>cup</STRONG> capability is "cup=6\E&%p2%2dc%p1%2dY". |
| 1343 | |
| 1344 | The Microterm ACT-IV needs the current row and column sent |
| 1345 | preceded by a <STRONG>^T</STRONG>, with the row and column simply encoded |
| 1346 | in binary, "cup=^T%p1%c%p2%c". Terminals which use "%c" |
| 1347 | need to be able to backspace the cursor (<STRONG>cub1</STRONG>), and to |
| 1348 | move the cursor up one line on the screen (<STRONG>cuu1</STRONG>). This is |
| 1349 | necessary because it is not always safe to transmit <STRONG>\n</STRONG> <STRONG>^D</STRONG> |
| 1350 | and <STRONG>\r</STRONG>, as the system may change or discard them. (The |
| 1351 | library routines dealing with terminfo set tty modes so |
| 1352 | that tabs are never expanded, so \t is safe to send. This |
| 1353 | turns out to be essential for the Ann Arbor 4080.) |
| 1354 | |
| 1355 | A final example is the LSI ADM-3a, which uses row and col- |
| 1356 | umn offset by a blank character, thus "cup=\E=%p1%' |
| 1357 | '%+%c%p2%' '%+%c". After sending `\E=', this pushes the |
| 1358 | first parameter, pushes the ASCII value for a space (32), |
| 1359 | adds them (pushing the sum on the stack in place of the |
| 1360 | two previous values) and outputs that value as a charac- |
| 1361 | ter. Then the same is done for the second parameter. |
| 1362 | More complex arithmetic is possible using the stack. |
| 1363 | |
| 1364 | |
| 1365 | <STRONG>Cursor</STRONG> <STRONG>Motions</STRONG> |
| 1366 | If the terminal has a fast way to home the cursor (to very |
| 1367 | upper left corner of screen) then this can be given as |
| 1368 | <STRONG>home</STRONG>; similarly a fast way of getting to the lower left- |
| 1369 | hand corner can be given as <STRONG>ll</STRONG>; this may involve going up |
| 1370 | with <STRONG>cuu1</STRONG> from the home position, but a program should |
| 1371 | never do this itself (unless <STRONG>ll</STRONG> does) because it can make |
| 1372 | no assumption about the effect of moving up from the home |
| 1373 | position. Note that the home position is the same as |
| 1374 | addressing to (0,0): to the top left corner of the screen, |
| 1375 | not of memory. (Thus, the \EH sequence on HP terminals |
| 1376 | cannot be used for <STRONG>home</STRONG>.) |
| 1377 | |
| 1378 | If the terminal has row or column absolute cursor address- |
| 1379 | ing, these can be given as single parameter capabilities |
| 1380 | <STRONG>hpa</STRONG> (horizontal position absolute) and <STRONG>vpa</STRONG> (vertical posi- |
| 1381 | tion absolute). Sometimes these are shorter than the more |
| 1382 | general two parameter sequence (as with the hp2645) and |
| 1383 | can be used in preference to <STRONG>cup</STRONG>. If there are |
| 1384 | parameterized local motions (e.g., move <EM>n</EM> spaces to the |
| 1385 | right) these can be given as <STRONG>cud</STRONG>, <STRONG>cub</STRONG>, <STRONG>cuf</STRONG>, and <STRONG>cuu</STRONG> with a |
| 1386 | single parameter indicating how many spaces to move. |
| 1387 | These are primarily useful if the terminal does not have |
| 1388 | <STRONG>cup</STRONG>, such as the TEKTRONIX 4025. |
| 1389 | |
| 1390 | If the terminal needs to be in a special mode when running |
| 1391 | a program that uses these capabilities, the codes to enter |
| 1392 | and exit this mode can be given as <STRONG>smcup</STRONG> and <STRONG>rmcup</STRONG>. This |
| 1393 | arises, for example, from terminals like the Concept with |
| 1394 | more than one page of memory. If the terminal has only |
| 1395 | memory relative cursor addressing and not screen relative |
| 1396 | cursor addressing, a one screen-sized window must be fixed |
| 1397 | into the terminal for cursor addressing to work properly. |
| 1398 | This is also used for the TEKTRONIX 4025, where <STRONG>smcup</STRONG> sets |
| 1399 | the command character to be the one used by terminfo. If |
| 1400 | the <STRONG>smcup</STRONG> sequence will not restore the screen after an |
| 1401 | <STRONG>rmcup</STRONG> sequence is output (to the state prior to outputting |
| 1402 | <STRONG>rmcup</STRONG>), specify <STRONG>nrrmc</STRONG>. |
| 1403 | |
| 1404 | |
| 1405 | <STRONG>Area</STRONG> <STRONG>Clears</STRONG> |
| 1406 | If the terminal can clear from the current position to the |
| 1407 | end of the line, leaving the cursor where it is, this |
| 1408 | should be given as <STRONG>el</STRONG>. If the terminal can clear from the |
| 1409 | beginning of the line to the current position inclusive, |
| 1410 | leaving the cursor where it is, this should be given as |
| 1411 | <STRONG>el1</STRONG>. If the terminal can clear from the current position |
| 1412 | to the end of the display, then this should be given as |
| 1413 | <STRONG>ed</STRONG>. <STRONG>Ed</STRONG> is only defined from the first column of a line. |
| 1414 | (Thus, it can be simulated by a request to delete a large |
| 1415 | number of lines, if a true <STRONG>ed</STRONG> is not available.) |
| 1416 | |
| 1417 | |
| 1418 | <STRONG>Insert/delete</STRONG> <STRONG>line</STRONG> <STRONG>and</STRONG> <STRONG>vertical</STRONG> <STRONG>motions</STRONG> |
| 1419 | If the terminal can open a new blank line before the line |
| 1420 | where the cursor is, this should be given as <STRONG>il1</STRONG>; this is |
| 1421 | done only from the first position of a line. The cursor |
| 1422 | must then appear on the newly blank line. If the terminal |
| 1423 | can delete the line which the cursor is on, then this |
| 1424 | should be given as <STRONG>dl1</STRONG>; this is done only from the first |
| 1425 | position on the line to be deleted. Versions of <STRONG>il1</STRONG> and |
| 1426 | <STRONG>dl1</STRONG> which take a single parameter and insert or delete |
| 1427 | that many lines can be given as <STRONG>il</STRONG> and <STRONG>dl</STRONG>. |
| 1428 | |
| 1429 | If the terminal has a settable scrolling region (like the |
| 1430 | vt100) the command to set this can be described with the |
| 1431 | <STRONG>csr</STRONG> capability, which takes two parameters: the top and |
| 1432 | bottom lines of the scrolling region. The cursor position |
| 1433 | is, alas, undefined after using this command. |
| 1434 | |
| 1435 | It is possible to get the effect of insert or delete line |
| 1436 | using <STRONG>csr</STRONG> on a properly chosen region; the <STRONG>sc</STRONG> and <STRONG>rc</STRONG> (save |
| 1437 | and restore cursor) commands may be useful for ensuring |
| 1438 | that your synthesized insert/delete string does not move |
| 1439 | the cursor. (Note that the <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> library does this |
| 1440 | synthesis automatically, so you need not compose |
| 1441 | insert/delete strings for an entry with <STRONG>csr</STRONG>). |
| 1442 | |
| 1443 | Yet another way to construct insert and delete might be to |
| 1444 | use a combination of index with the memory-lock feature |
| 1445 | found on some terminals (like the HP-700/90 series, which |
| 1446 | however also has insert/delete). |
| 1447 | |
| 1448 | Inserting lines at the top or bottom of the screen can |
| 1449 | also be done using <STRONG>ri</STRONG> or <STRONG>ind</STRONG> on many terminals without a |
| 1450 | true insert/delete line, and is often faster even on ter- |
| 1451 | minals with those features. |
| 1452 | |
| 1453 | The boolean <STRONG>non_dest_scroll_region</STRONG> should be set if each |
| 1454 | scrolling window is effectively a view port on a screen- |
| 1455 | sized canvas. To test for this capability, create a |
| 1456 | scrolling region in the middle of the screen, write some- |
| 1457 | thing to the bottom line, move the cursor to the top of |
| 1458 | the region, and do <STRONG>ri</STRONG> followed by <STRONG>dl1</STRONG> or <STRONG>ind</STRONG>. If the data |
| 1459 | scrolled off the bottom of the region by the <STRONG>ri</STRONG> re- |
| 1460 | appears, then scrolling is non-destructive. System V and |
| 1461 | XSI Curses expect that <STRONG>ind</STRONG>, <STRONG>ri</STRONG>, <STRONG>indn</STRONG>, and <STRONG>rin</STRONG> will simu- |
| 1462 | late destructive scrolling; their documentation cautions |
| 1463 | you not to define <STRONG>csr</STRONG> unless this is true. This <STRONG>curses</STRONG> |
| 1464 | implementation is more liberal and will do explicit erases |
| 1465 | after scrolling if <STRONG>ndstr</STRONG> is defined. |
| 1466 | |
| 1467 | If the terminal has the ability to define a window as part |
| 1468 | of memory, which all commands affect, it should be given |
| 1469 | as the parameterized string <STRONG>wind</STRONG>. The four parameters are |
| 1470 | the starting and ending lines in memory and the starting |
| 1471 | and ending columns in memory, in that order. |
| 1472 | |
| 1473 | If the terminal can retain display memory above, then the |
| 1474 | <STRONG>da</STRONG> capability should be given; if display memory can be |
| 1475 | retained below, then <STRONG>db</STRONG> should be given. These indicate |
| 1476 | that deleting a line or scrolling may bring non-blank |
| 1477 | lines up from below or that scrolling back with <STRONG>ri</STRONG> may |
| 1478 | bring down non-blank lines. |
| 1479 | |
| 1480 | |
| 1481 | <STRONG>Insert/Delete</STRONG> <STRONG>Character</STRONG> |
| 1482 | There are two basic kinds of intelligent terminals with |
| 1483 | respect to insert/delete character which can be described |
| 1484 | using <EM>terminfo.</EM> The most common insert/delete character |
| 1485 | operations affect only the characters on the current line |
| 1486 | and shift characters off the end of the line rigidly. |
| 1487 | Other terminals, such as the Concept 100 and the Perkin |
| 1488 | Elmer Owl, make a distinction between typed and untyped |
| 1489 | blanks on the screen, shifting upon an insert or delete |
| 1490 | only to an untyped blank on the screen which is either |
| 1491 | eliminated, or expanded to two untyped blanks. You can |
| 1492 | determine the kind of terminal you have by clearing the |
| 1493 | screen and then typing text separated by cursor motions. |
| 1494 | Type "abc def" using local cursor motions (not spaces) |
| 1495 | between the "abc" and the "def". Then position the cursor |
| 1496 | before the "abc" and put the terminal in insert mode. If |
| 1497 | typing characters causes the rest of the line to shift |
| 1498 | rigidly and characters to fall off the end, then your ter- |
| 1499 | minal does not distinguish between blanks and untyped |
| 1500 | positions. If the "abc" shifts over to the "def" which |
| 1501 | then move together around the end of the current line and |
| 1502 | onto the next as you insert, you have the second type of |
| 1503 | terminal, and should give the capability <STRONG>in</STRONG>, which stands |
| 1504 | for "insert null". While these are two logically separate |
| 1505 | attributes (one line versus multi-line insert mode, and |
| 1506 | special treatment of untyped spaces) we have seen no ter- |
| 1507 | minals whose insert mode cannot be described with the sin- |
| 1508 | gle attribute. |
| 1509 | |
| 1510 | Terminfo can describe both terminals which have an insert |
| 1511 | mode, and terminals which send a simple sequence to open a |
| 1512 | blank position on the current line. Give as <STRONG>smir</STRONG> the |
| 1513 | sequence to get into insert mode. Give as <STRONG>rmir</STRONG> the |
| 1514 | sequence to leave insert mode. Now give as <STRONG>ich1</STRONG> any |
| 1515 | sequence needed to be sent just before sending the |
| 1516 | character to be inserted. Most terminals with a true |
| 1517 | insert mode will not give <STRONG>ich1</STRONG>; terminals which send a |
| 1518 | sequence to open a screen position should give it here. |
| 1519 | |
| 1520 | If your terminal has both, insert mode is usually prefer- |
| 1521 | able to <STRONG>ich1</STRONG>. Technically, you should not give both |
| 1522 | unless the terminal actually requires both to be used in |
| 1523 | combination. Accordingly, some non-curses applications |
| 1524 | get confused if both are present; the symptom is doubled |
| 1525 | characters in an update using insert. This requirement is |
| 1526 | now rare; most <STRONG>ich</STRONG> sequences do not require previous smir, |
| 1527 | and most smir insert modes do not require <STRONG>ich1</STRONG> before each |
| 1528 | character. Therefore, the new <STRONG>curses</STRONG> actually assumes |
| 1529 | this is the case and uses either <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> or <STRONG>ich</STRONG>/<STRONG>ich1</STRONG> as |
| 1530 | appropriate (but not both). If you have to write an entry |
| 1531 | to be used under new curses for a terminal old enough to |
| 1532 | need both, include the <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> sequences in <STRONG>ich1</STRONG>. |
| 1533 | |
| 1534 | If post insert padding is needed, give this as a number of |
| 1535 | milliseconds in <STRONG>ip</STRONG> (a string option). Any other sequence |
| 1536 | which may need to be sent after an insert of a single |
| 1537 | character may also be given in <STRONG>ip</STRONG>. If your terminal needs |
| 1538 | both to be placed into an `insert mode' and a special code |
| 1539 | to precede each inserted character, then both <STRONG>smir</STRONG>/<STRONG>rmir</STRONG> |
| 1540 | and <STRONG>ich1</STRONG> can be given, and both will be used. The <STRONG>ich</STRONG> |
| 1541 | capability, with one parameter, <EM>n</EM>, will repeat the effects |
| 1542 | of <STRONG>ich1</STRONG> <EM>n</EM> times. |
| 1543 | |
| 1544 | If padding is necessary between characters typed while not |
| 1545 | in insert mode, give this as a number of milliseconds |
| 1546 | padding in <STRONG>rmp</STRONG>. |
| 1547 | |
| 1548 | It is occasionally necessary to move around while in |
| 1549 | insert mode to delete characters on the same line (e.g., |
| 1550 | if there is a tab after the insertion position). If your |
| 1551 | terminal allows motion while in insert mode you can give |
| 1552 | the capability <STRONG>mir</STRONG> to speed up inserting in this case. |
| 1553 | Omitting <STRONG>mir</STRONG> will affect only speed. Some terminals |
| 1554 | (notably Datamedia's) must not have <STRONG>mir</STRONG> because of the way |
| 1555 | their insert mode works. |
| 1556 | |
| 1557 | Finally, you can specify <STRONG>dch1</STRONG> to delete a single charac- |
| 1558 | ter, <STRONG>dch</STRONG> with one parameter, <EM>n</EM>, to delete <EM>n</EM> <EM>characters,</EM> |
| 1559 | and delete mode by giving <STRONG>smdc</STRONG> and <STRONG>rmdc</STRONG> to enter and exit |
| 1560 | delete mode (any mode the terminal needs to be placed in |
| 1561 | for <STRONG>dch1</STRONG> to work). |
| 1562 | |
| 1563 | A command to erase <EM>n</EM> characters (equivalent to outputting |
| 1564 | <EM>n</EM> blanks without moving the cursor) can be given as <STRONG>ech</STRONG> |
| 1565 | with one parameter. |
| 1566 | |
| 1567 | |
| 1568 | <STRONG>Highlighting,</STRONG> <STRONG>Underlining,</STRONG> <STRONG>and</STRONG> <STRONG>Visible</STRONG> <STRONG>Bells</STRONG> |
| 1569 | If your terminal has one or more kinds of display |
| 1570 | attributes, these can be represented in a number of dif- |
| 1571 | ferent ways. You should choose one display form as <EM>stand-</EM> |
| 1572 | <EM>out</EM> <EM>mode</EM>, representing a good, high contrast, easy-on-the- |
| 1573 | eyes, format for highlighting error messages and other |
| 1574 | attention getters. (If you have a choice, reverse video |
| 1575 | plus half-bright is good, or reverse video alone.) The |
| 1576 | sequences to enter and exit standout mode are given as |
| 1577 | <STRONG>smso</STRONG> and <STRONG>rmso</STRONG>, respectively. If the code to change into |
| 1578 | or out of standout mode leaves one or even two blank |
| 1579 | spaces on the screen, as the TVI 912 and Teleray 1061 do, |
| 1580 | then <STRONG>xmc</STRONG> should be given to tell how many spaces are left. |
| 1581 | |
| 1582 | Codes to begin underlining and end underlining can be |
| 1583 | given as <STRONG>smul</STRONG> and <STRONG>rmul</STRONG> respectively. If the terminal has |
| 1584 | a code to underline the current character and move the |
| 1585 | cursor one space to the right, such as the Microterm Mime, |
| 1586 | this can be given as <STRONG>uc</STRONG>. |
| 1587 | |
| 1588 | Other capabilities to enter various highlighting modes |
| 1589 | include <STRONG>blink</STRONG> (blinking) <STRONG>bold</STRONG> (bold or extra bright) <STRONG>dim</STRONG> |
| 1590 | (dim or half-bright) <STRONG>invis</STRONG> (blanking or invisible text) |
| 1591 | <STRONG>prot</STRONG> (protected) <STRONG>rev</STRONG> (reverse video) <STRONG>sgr0</STRONG> (turn off <EM>all</EM> |
| 1592 | attribute modes) <STRONG>smacs</STRONG> (enter alternate character set |
| 1593 | mode) and <STRONG>rmacs</STRONG> (exit alternate character set mode). |
| 1594 | Turning on any of these modes singly may or may not turn |
| 1595 | off other modes. |
| 1596 | |
| 1597 | If there is a sequence to set arbitrary combinations of |
| 1598 | modes, this should be given as <STRONG>sgr</STRONG> (set attributes), tak- |
| 1599 | ing 9 parameters. Each parameter is either 0 or nonzero, |
| 1600 | as the corresponding attribute is on or off. The 9 param- |
| 1601 | eters are, in order: standout, underline, reverse, blink, |
| 1602 | dim, bold, blank, protect, alternate character set. Not |
| 1603 | all modes need be supported by <STRONG>sgr</STRONG>, only those for which |
| 1604 | corresponding separate attribute commands exist. |
| 1605 | |
| 1606 | For example, the DEC vt220 supports most of the modes: |
| 1607 | |
| 1608 | |
| 1609 | <STRONG>tparm</STRONG> <STRONG>parameter</STRONG> <STRONG>attribute</STRONG> <STRONG>escape</STRONG> <STRONG>sequence</STRONG> |
| 1610 | |
| 1611 | none none \E[0m |
| 1612 | p1 standout \E[0;1;7m |
| 1613 | p2 underline \E[0;4m |
| 1614 | p3 reverse \E[0;7m |
| 1615 | p4 blink \E[0;5m |
| 1616 | p5 dim not available |
| 1617 | p6 bold \E[0;1m |
| 1618 | p7 invis \E[0;8m |
| 1619 | p8 protect not used |
| 1620 | p9 altcharset ^O (off) ^N (on) |
| 1621 | |
| 1622 | We begin each escape sequence by turning off any existing |
| 1623 | modes, since there is no quick way to determine whether |
| 1624 | they are active. Standout is set up to be the combination |
| 1625 | of reverse and bold. The vt220 terminal has a protect |
| 1626 | mode, though it is not commonly used in sgr because it |
| 1627 | protects characters on the screen from the host's era- |
| 1628 | sures. The altcharset mode also is different in that it |
| 1629 | is either ^O or ^N, depending on whether it is off or on. |
| 1630 | If all modes are turned on, the resulting sequence is |
| 1631 | \E[0;1;4;5;7;8m^N. |
| 1632 | |
| 1633 | Some sequences are common to different modes. For exam- |
| 1634 | ple, ;7 is output when either p1 or p3 is true, that is, |
| 1635 | if either standout or reverse modes are turned on. |
| 1636 | |
| 1637 | Writing out the above sequences, along with their depen- |
| 1638 | dencies yields |
| 1639 | |
| 1640 | |
| 1641 | <STRONG>sequence</STRONG> <STRONG>when</STRONG> <STRONG>to</STRONG> <STRONG>output</STRONG> <STRONG>terminfo</STRONG> <STRONG>translation</STRONG> |
| 1642 | |
| 1643 | \E[0 always \E[0 |
| 1644 | ;1 if p1 or p6 %?%p1%p6%|%t;1%; |
| 1645 | ;4 if p2 %?%p2%|%t;4%; |
| 1646 | ;5 if p4 %?%p4%|%t;5%; |
| 1647 | |
| 1648 | ;7 if p1 or p3 %?%p1%p3%|%t;7%; |
| 1649 | ;8 if p7 %?%p7%|%t;8%; |
| 1650 | m always m |
| 1651 | ^N or ^O if p9 ^N, else ^O %?%p9%t^N%e^O%; |
| 1652 | |
| 1653 | Putting this all together into the sgr sequence gives: |
| 1654 | |
| 1655 | sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p1%p3%|%t;7%; |
| 1656 | %?%p4%t;5%;%?%p7%t;8%;m%?%p9%t\016%e\017%;, |
| 1657 | |
| 1658 | Remember that if you specify sgr, you must also specify |
| 1659 | sgr0. Also, some implementations rely on sgr being given |
| 1660 | if sgr0 is, Not all terminfo entries necessarily have an |
| 1661 | sgr string, however. Many terminfo entries are derived |
| 1662 | from termcap entries which have no sgr string. The only |
| 1663 | drawback to adding an sgr string is that termcap also |
| 1664 | assumes that sgr0 does not exit alternate character set |
| 1665 | mode. |
| 1666 | |
| 1667 | Terminals with the ``magic cookie'' glitch (<STRONG>xmc</STRONG>) deposit |
| 1668 | special ``cookies'' when they receive mode-setting |
| 1669 | sequences, which affect the display algorithm rather than |
| 1670 | having extra bits for each character. Some terminals, |
| 1671 | such as the HP 2621, automatically leave standout mode |
| 1672 | when they move to a new line or the cursor is addressed. |
| 1673 | Programs using standout mode should exit standout mode |
| 1674 | before moving the cursor or sending a newline, unless the |
| 1675 | <STRONG>msgr</STRONG> capability, asserting that it is safe to move in |
| 1676 | standout mode, is present. |
| 1677 | |
| 1678 | If the terminal has a way of flashing the screen to indi- |
| 1679 | cate an error quietly (a bell replacement) then this can |
| 1680 | be given as <STRONG>flash</STRONG>; it must not move the cursor. |
| 1681 | |
| 1682 | If the cursor needs to be made more visible than normal |
| 1683 | when it is not on the bottom line (to make, for example, a |
| 1684 | non-blinking underline into an easier to find block or |
| 1685 | blinking underline) give this sequence as <STRONG>cvvis</STRONG>. If there |
| 1686 | is a way to make the cursor completely invisible, give |
| 1687 | that as <STRONG>civis</STRONG>. The capability <STRONG>cnorm</STRONG> should be given which |
| 1688 | undoes the effects of both of these modes. |
| 1689 | |
| 1690 | If your terminal correctly generates underlined characters |
| 1691 | (with no special codes needed) even though it does not |
| 1692 | overstrike, then you should give the capability <STRONG>ul</STRONG>. If a |
| 1693 | character overstriking another leaves both characters on |
| 1694 | the screen, specify the capability <STRONG>os</STRONG>. If overstrikes are |
| 1695 | erasable with a blank, then this should be indicated by |
| 1696 | giving <STRONG>eo</STRONG>. |
| 1697 | |
| 1698 | |
| 1699 | <STRONG>Keypad</STRONG> <STRONG>and</STRONG> <STRONG>Function</STRONG> <STRONG>Keys</STRONG> |
| 1700 | If the terminal has a keypad that transmits codes when the |
| 1701 | keys are pressed, this information can be given. Note |
| 1702 | that it is not possible to handle terminals where the key- |
| 1703 | pad only works in local (this applies, for example, to the |
| 1704 | unshifted HP 2621 keys). If the keypad can be set to |
| 1705 | transmit or not transmit, give these codes as <STRONG>smkx</STRONG> and |
| 1706 | <STRONG>rmkx</STRONG>. Otherwise the keypad is assumed to always transmit. |
| 1707 | The codes sent by the left arrow, right arrow, up arrow, |
| 1708 | down arrow, and home keys can be given as <STRONG>kcub1,</STRONG> <STRONG>kcuf1,</STRONG> |
| 1709 | <STRONG>kcuu1,</STRONG> <STRONG>kcud1,</STRONG> and <STRONG>khome</STRONG> respectively. If there are func- |
| 1710 | tion keys such as f0, f1, ..., f10, the codes they send |
| 1711 | can be given as <STRONG>kf0,</STRONG> <STRONG>kf1,</STRONG> <STRONG>...,</STRONG> <STRONG>kf10</STRONG>. If these keys have |
| 1712 | labels other than the default f0 through f10, the labels |
| 1713 | can be given as <STRONG>lf0,</STRONG> <STRONG>lf1,</STRONG> <STRONG>...,</STRONG> <STRONG>lf10</STRONG>. The codes |
| 1714 | transmitted by certain other special keys can be given: |
| 1715 | <STRONG>kll</STRONG> (home down), <STRONG>kbs</STRONG> (backspace), <STRONG>ktbc</STRONG> (clear all tabs), |
| 1716 | <STRONG>kctab</STRONG> (clear the tab stop in this column), <STRONG>kclr</STRONG> (clear |
| 1717 | screen or erase key), <STRONG>kdch1</STRONG> (delete character), <STRONG>kdl1</STRONG> |
| 1718 | (delete line), <STRONG>krmir</STRONG> (exit insert mode), <STRONG>kel</STRONG> (clear to end |
| 1719 | of line), <STRONG>ked</STRONG> (clear to end of screen), <STRONG>kich1</STRONG> (insert |
| 1720 | character or enter insert mode), <STRONG>kil1</STRONG> (insert line), <STRONG>knp</STRONG> |
| 1721 | (next page), <STRONG>kpp</STRONG> (previous page), <STRONG>kind</STRONG> (scroll for- |
| 1722 | ward/down), <STRONG>kri</STRONG> (scroll backward/up), <STRONG>khts</STRONG> (set a tab stop |
| 1723 | in this column). In addition, if the keypad has a 3 by 3 |
| 1724 | array of keys including the four arrow keys, the other |
| 1725 | five keys can be given as <STRONG>ka1</STRONG>, <STRONG>ka3</STRONG>, <STRONG>kb2</STRONG>, <STRONG>kc1</STRONG>, and <STRONG>kc3</STRONG>. |
| 1726 | These keys are useful when the effects of a 3 by 3 direc- |
| 1727 | tional pad are needed. |
| 1728 | |
| 1729 | Strings to program function keys can be given as <STRONG>pfkey</STRONG>, |
| 1730 | <STRONG>pfloc</STRONG>, and <STRONG>pfx</STRONG>. A string to program screen labels should |
| 1731 | be specified as <STRONG>pln</STRONG>. Each of these strings takes two |
| 1732 | parameters: the function key number to program (from 0 to |
| 1733 | 10) and the string to program it with. Function key num- |
| 1734 | bers out of this range may program undefined keys in a |
| 1735 | terminal dependent manner. The difference between the |
| 1736 | capabilities is that <STRONG>pfkey</STRONG> causes pressing the given key |
| 1737 | to be the same as the user typing the given string; <STRONG>pfloc</STRONG> |
| 1738 | causes the string to be executed by the terminal in local; |
| 1739 | and <STRONG>pfx</STRONG> causes the string to be transmitted to the com- |
| 1740 | puter. |
| 1741 | |
| 1742 | The capabilities <STRONG>nlab</STRONG>, <STRONG>lw</STRONG> and <STRONG>lh</STRONG> define the number of pro- |
| 1743 | grammable screen labels and their width and height. If |
| 1744 | there are commands to turn the labels on and off, give |
| 1745 | them in <STRONG>smln</STRONG> and <STRONG>rmln</STRONG>. <STRONG>smln</STRONG> is normally output after one |
| 1746 | or more pln sequences to make sure that the change becomes |
| 1747 | visible. |
| 1748 | |
| 1749 | |
| 1750 | <STRONG>Tabs</STRONG> <STRONG>and</STRONG> <STRONG>Initialization</STRONG> |
| 1751 | If the terminal has hardware tabs, the command to advance |
| 1752 | to the next tab stop can be given as <STRONG>ht</STRONG> (usually control |
| 1753 | I). A ``back-tab'' command which moves leftward to the |
| 1754 | preceding tab stop can be given as <STRONG>cbt</STRONG>. By convention, if |
| 1755 | the teletype modes indicate that tabs are being expanded |
| 1756 | by the computer rather than being sent to the terminal, |
| 1757 | programs should not use <STRONG>ht</STRONG> or <STRONG>cbt</STRONG> even if they are |
| 1758 | present, since the user may not have the tab stops prop- |
| 1759 | erly set. If the terminal has hardware tabs which are |
| 1760 | initially set every <EM>n</EM> spaces when the terminal is powered |
| 1761 | up, the numeric parameter <STRONG>it</STRONG> is given, showing the number |
| 1762 | of spaces the tabs are set to. This is normally used by |
| 1763 | the <EM>tset</EM> command to determine whether to set the mode for |
| 1764 | hardware tab expansion, and whether to set the tab stops. |
| 1765 | If the terminal has tab stops that can be saved in non- |
| 1766 | volatile memory, the terminfo description can assume that |
| 1767 | they are properly set. |
| 1768 | |
| 1769 | Other capabilities include <STRONG>is1</STRONG>, <STRONG>is2</STRONG>, and <STRONG>is3</STRONG>, initializa- |
| 1770 | tion strings for the terminal, <STRONG>iprog</STRONG>, the path name of a |
| 1771 | program to be run to initialize the terminal, and <STRONG>if</STRONG>, the |
| 1772 | name of a file containing long initialization strings. |
| 1773 | These strings are expected to set the terminal into modes |
| 1774 | consistent with the rest of the terminfo description. |
| 1775 | They are normally sent to the terminal, by the <EM>init</EM> option |
| 1776 | of the <EM>tput</EM> program, each time the user logs in. They |
| 1777 | will be printed in the following order: |
| 1778 | |
| 1779 | run the program |
| 1780 | <STRONG>iprog</STRONG> |
| 1781 | |
| 1782 | output <STRONG>is1</STRONG> <STRONG>is2</STRONG> |
| 1783 | |
| 1784 | set the margins using |
| 1785 | <STRONG>mgc</STRONG>, <STRONG>smgl</STRONG> and <STRONG>smgr</STRONG> |
| 1786 | |
| 1787 | set tabs using |
| 1788 | <STRONG>tbc</STRONG> and <STRONG>hts</STRONG> |
| 1789 | |
| 1790 | print the file |
| 1791 | <STRONG>if</STRONG> |
| 1792 | |
| 1793 | and finally |
| 1794 | output <STRONG>is3</STRONG>. |
| 1795 | |
| 1796 | Most initialization is done with <STRONG>is2</STRONG>. Special terminal |
| 1797 | modes can be set up without duplicating strings by putting |
| 1798 | the common sequences in <STRONG>is2</STRONG> and special cases in <STRONG>is1</STRONG> and |
| 1799 | <STRONG>is3</STRONG>. |
| 1800 | |
| 1801 | A set of sequences that does a harder reset from a totally |
| 1802 | unknown state can be given as <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rf</STRONG> and <STRONG>rs3</STRONG>, analo- |
| 1803 | gous to <STRONG>is1</STRONG> <STRONG>,</STRONG> <STRONG>is2</STRONG> <STRONG>,</STRONG> <STRONG>if</STRONG> and <STRONG>is3</STRONG> respectively. These |
| 1804 | strings are output by the <EM>reset</EM> program, which is used |
| 1805 | when the terminal gets into a wedged state. Commands are |
| 1806 | normally placed in <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG> <STRONG>rs3</STRONG> and <STRONG>rf</STRONG> only if they pro- |
| 1807 | duce annoying effects on the screen and are not necessary |
| 1808 | when logging in. For example, the command to set the |
| 1809 | vt100 into 80-column mode would normally be part of <STRONG>is2</STRONG>, |
| 1810 | but it causes an annoying glitch of the screen and is not |
| 1811 | normally needed since the terminal is usually already in |
| 1812 | 80 column mode. |
| 1813 | |
| 1814 | The <EM>reset</EM> program writes strings including <STRONG>iprog</STRONG>, etc., in |
| 1815 | the same order as the <EM>init</EM> program, using <STRONG>rs1</STRONG>, etc., |
| 1816 | instead of <STRONG>is1</STRONG>, etc. If any of <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, or <STRONG>rf</STRONG> reset |
| 1817 | capability strings are missing, the <EM>reset</EM> program falls |
| 1818 | back upon the corresponding initialization capability |
| 1819 | string. |
| 1820 | |
| 1821 | If there are commands to set and clear tab stops, they can |
| 1822 | be given as <STRONG>tbc</STRONG> (clear all tab stops) and <STRONG>hts</STRONG> (set a tab |
| 1823 | stop in the current column of every row). If a more com- |
| 1824 | plex sequence is needed to set the tabs than can be |
| 1825 | described by this, the sequence can be placed in <STRONG>is2</STRONG> or |
| 1826 | <STRONG>if</STRONG>. |
| 1827 | |
| 1828 | <STRONG>Delays</STRONG> <STRONG>and</STRONG> <STRONG>Padding</STRONG> |
| 1829 | Many older and slower terminals do not support either |
| 1830 | XON/XOFF or DTR handshaking, including hard copy terminals |
| 1831 | and some very archaic CRTs (including, for example, DEC |
| 1832 | VT100s). These may require padding characters after cer- |
| 1833 | tain cursor motions and screen changes. |
| 1834 | |
| 1835 | If the terminal uses xon/xoff handshaking for flow control |
| 1836 | (that is, it automatically emits ^S back to the host when |
| 1837 | its input buffers are close to full), set <STRONG>xon</STRONG>. This capa- |
| 1838 | bility suppresses the emission of padding. You can also |
| 1839 | set it for memory-mapped console devices effectively that |
| 1840 | do not have a speed limit. Padding information should |
| 1841 | still be included so that routines can make better deci- |
| 1842 | sions about relative costs, but actual pad characters will |
| 1843 | not be transmitted. |
| 1844 | |
| 1845 | If <STRONG>pb</STRONG> (padding baud rate) is given, padding is suppressed |
| 1846 | at baud rates below the value of <STRONG>pb</STRONG>. If the entry has no |
| 1847 | padding baud rate, then whether padding is emitted or not |
| 1848 | is completely controlled by <STRONG>xon</STRONG>. |
| 1849 | |
| 1850 | If the terminal requires other than a null (zero) charac- |
| 1851 | ter as a pad, then this can be given as <STRONG>pad</STRONG>. Only the |
| 1852 | first character of the <STRONG>pad</STRONG> string is used. |
| 1853 | |
| 1854 | |
| 1855 | <STRONG>Status</STRONG> <STRONG>Lines</STRONG> |
| 1856 | Some terminals have an extra `status line' which is not |
| 1857 | normally used by software (and thus not counted in the |
| 1858 | terminal's <STRONG>lines</STRONG> capability). |
| 1859 | |
| 1860 | The simplest case is a status line which is cursor- |
| 1861 | addressable but not part of the main scrolling region on |
| 1862 | the screen; the Heathkit H19 has a status line of this |
| 1863 | kind, as would a 24-line VT100 with a 23-line scrolling |
| 1864 | region set up on initialization. This situation is indi- |
| 1865 | cated by the <STRONG>hs</STRONG> capability. |
| 1866 | |
| 1867 | Some terminals with status lines need special sequences to |
| 1868 | access the status line. These may be expressed as a |
| 1869 | string with single parameter <STRONG>tsl</STRONG> which takes the cursor to |
| 1870 | a given zero-origin column on the status line. The capa- |
| 1871 | bility <STRONG>fsl</STRONG> must return to the main-screen cursor positions |
| 1872 | before the last <STRONG>tsl</STRONG>. You may need to embed the string |
| 1873 | values of <STRONG>sc</STRONG> (save cursor) and <STRONG>rc</STRONG> (restore cursor) in <STRONG>tsl</STRONG> |
| 1874 | and <STRONG>fsl</STRONG> to accomplish this. |
| 1875 | |
| 1876 | The status line is normally assumed to be the same width |
| 1877 | as the width of the terminal. If this is untrue, you can |
| 1878 | specify it with the numeric capability <STRONG>wsl</STRONG>. |
| 1879 | |
| 1880 | A command to erase or blank the status line may be speci- |
| 1881 | fied as <STRONG>dsl</STRONG>. |
| 1882 | |
| 1883 | The boolean capability <STRONG>eslok</STRONG> specifies that escape |
| 1884 | sequences, tabs, etc., work ordinarily in the status line. |
| 1885 | |
| 1886 | The <STRONG>ncurses</STRONG> implementation does not yet use any of these |
| 1887 | capabilities. They are documented here in case they ever |
| 1888 | become important. |
| 1889 | |
| 1890 | |
| 1891 | <STRONG>Line</STRONG> <STRONG>Graphics</STRONG> |
| 1892 | Many terminals have alternate character sets useful for |
| 1893 | forms-drawing. Terminfo and <STRONG>curses</STRONG> build in support for |
| 1894 | the drawing characters supported by the VT100, with some |
| 1895 | characters from the AT&T 4410v1 added. This alternate |
| 1896 | character set may be specified by the <STRONG>acsc</STRONG> capability. |
| 1897 | |
| 1898 | |
| 1899 | <STRONG>Glyph</STRONG> <STRONG>ACS</STRONG> <STRONG>Ascii</STRONG> <STRONG>VT100</STRONG> |
| 1900 | <STRONG>Name</STRONG> <STRONG>Name</STRONG> <STRONG>Default</STRONG> <STRONG>Name</STRONG> |
| 1901 | UK pound sign ACS_STERLING f } |
| 1902 | arrow pointing down ACS_DARROW v . |
| 1903 | arrow pointing left ACS_LARROW < , |
| 1904 | arrow pointing right ACS_RARROW > + |
| 1905 | arrow pointing up ACS_UARROW ^ - |
| 1906 | board of squares ACS_BOARD # h |
| 1907 | bullet ACS_BULLET o ~ |
| 1908 | checker board (stipple) ACS_CKBOARD : a |
| 1909 | degree symbol ACS_DEGREE \ f |
| 1910 | diamond ACS_DIAMOND + ` |
| 1911 | greater-than-or-equal-to ACS_GEQUAL > z |
| 1912 | greek pi ACS_PI * { |
| 1913 | horizontal line ACS_HLINE - q |
| 1914 | lantern symbol ACS_LANTERN # i |
| 1915 | large plus or crossover ACS_PLUS + n |
| 1916 | less-than-or-equal-to ACS_LEQUAL < y |
| 1917 | |
| 1918 | lower left corner ACS_LLCORNER + m |
| 1919 | lower right corner ACS_LRCORNER + j |
| 1920 | not-equal ACS_NEQUAL ! | |
| 1921 | plus/minus ACS_PLMINUS # g |
| 1922 | scan line 1 ACS_S1 ~ o |
| 1923 | scan line 3 ACS_S3 - p |
| 1924 | scan line 7 ACS_S7 - r |
| 1925 | scan line 9 ACS_S9 _ s |
| 1926 | solid square block ACS_BLOCK # 0 |
| 1927 | tee pointing down ACS_TTEE + w |
| 1928 | tee pointing left ACS_RTEE + u |
| 1929 | tee pointing right ACS_LTEE + t |
| 1930 | tee pointing up ACS_BTEE + v |
| 1931 | upper left corner ACS_ULCORNER + l |
| 1932 | upper right corner ACS_URCORNER + k |
| 1933 | vertical line ACS_VLINE | x |
| 1934 | |
| 1935 | The best way to define a new device's graphics set is to |
| 1936 | add a column to a copy of this table for your terminal, |
| 1937 | giving the character which (when emitted between |
| 1938 | <STRONG>smacs</STRONG>/<STRONG>rmacs</STRONG> switches) will be rendered as the correspond- |
| 1939 | ing graphic. Then read off the VT100/your terminal char- |
| 1940 | acter pairs right to left in sequence; these become the |
| 1941 | ACSC string. |
| 1942 | |
| 1943 | |
| 1944 | <STRONG>Color</STRONG> <STRONG>Handling</STRONG> |
| 1945 | Most color terminals are either `Tektronix-like' or `HP- |
| 1946 | like'. Tektronix-like terminals have a predefined set of |
| 1947 | N colors (where N usually 8), and can set character-cell |
| 1948 | foreground and background characters independently, mixing |
| 1949 | them into N * N color-pairs. On HP-like terminals, the |
| 1950 | use must set each color pair up separately (foreground and |
| 1951 | background are not independently settable). Up to M |
| 1952 | color-pairs may be set up from 2*M different colors. |
| 1953 | ANSI-compatible terminals are Tektronix-like. |
| 1954 | |
| 1955 | Some basic color capabilities are independent of the color |
| 1956 | method. The numeric capabilities <STRONG>colors</STRONG> and <STRONG>pairs</STRONG> specify |
| 1957 | the maximum numbers of colors and color-pairs that can be |
| 1958 | displayed simultaneously. The <STRONG>op</STRONG> (original pair) string |
| 1959 | resets foreground and background colors to their default |
| 1960 | values for the terminal. The <STRONG>oc</STRONG> string resets all colors |
| 1961 | or color-pairs to their default values for the terminal. |
| 1962 | Some terminals (including many PC terminal emulators) |
| 1963 | erase screen areas with the current background color |
| 1964 | rather than the power-up default background; these should |
| 1965 | have the boolean capability <STRONG>bce</STRONG>. |
| 1966 | |
| 1967 | To change the current foreground or background color on a |
| 1968 | Tektronix-type terminal, use <STRONG>setaf</STRONG> (set ANSI foreground) |
| 1969 | and <STRONG>setab</STRONG> (set ANSI background) or <STRONG>setf</STRONG> (set foreground) |
| 1970 | and <STRONG>setb</STRONG> (set background). These take one parameter, the |
| 1971 | color number. The SVr4 documentation describes only |
| 1972 | <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>; the XPG4 draft says that "If the terminal |
| 1973 | supports ANSI escape sequences to set background and fore- |
| 1974 | ground, they should be coded as <STRONG>setaf</STRONG> and <STRONG>setab</STRONG>, respec- |
| 1975 | tively. If the terminal supports other escape sequences |
| 1976 | to set background and foreground, they should be coded as |
| 1977 | <STRONG>setf</STRONG> and <STRONG>setb</STRONG>, respectively. The <EM>vidputs()</EM> function and |
| 1978 | the refresh functions use <STRONG>setaf</STRONG> and <STRONG>setab</STRONG> if they are |
| 1979 | defined." |
| 1980 | |
| 1981 | The <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> and <STRONG>setf</STRONG>/<STRONG>setb</STRONG> capabilities take a single |
| 1982 | numeric argument each. Argument values 0-7 of <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> |
| 1983 | are portably defined as follows (the middle column is the |
| 1984 | symbolic #define available in the header for the <STRONG>curses</STRONG> or |
| 1985 | <STRONG>ncurses</STRONG> libraries). The terminal hardware is free to map |
| 1986 | these as it likes, but the RGB values indicate normal |
| 1987 | locations in color space. |
| 1988 | |
| 1989 | |
| 1990 | <STRONG>Color</STRONG> <STRONG>#define</STRONG> <STRONG>Value</STRONG> <STRONG>RGB</STRONG> |
| 1991 | black <STRONG>COLOR_BLACK</STRONG> 0 0, 0, 0 |
| 1992 | red <STRONG>COLOR_RED</STRONG> 1 max,0,0 |
| 1993 | green <STRONG>COLOR_GREEN</STRONG> 2 0,max,0 |
| 1994 | yellow <STRONG>COLOR_YELLOW</STRONG> 3 max,max,0 |
| 1995 | blue <STRONG>COLOR_BLUE</STRONG> 4 0,0,max |
| 1996 | magenta <STRONG>COLOR_MAGENTA</STRONG> 5 max,0,max |
| 1997 | cyan <STRONG>COLOR_CYAN</STRONG> 6 0,max,max |
| 1998 | white <STRONG>COLOR_WHITE</STRONG> 7 max,max,max |
| 1999 | |
| 2000 | The argument values of <STRONG>setf</STRONG>/<STRONG>setb</STRONG> historically correspond |
| 2001 | to a different mapping, i.e., |
| 2002 | |
| 2003 | <STRONG>Color</STRONG> <STRONG>#define</STRONG> <STRONG>Value</STRONG> <STRONG>RGB</STRONG> |
| 2004 | black <STRONG>COLOR_BLACK</STRONG> 0 0, 0, 0 |
| 2005 | blue <STRONG>COLOR_BLUE</STRONG> 1 0,0,max |
| 2006 | green <STRONG>COLOR_GREEN</STRONG> 2 0,max,0 |
| 2007 | cyan <STRONG>COLOR_CYAN</STRONG> 3 0,max,max |
| 2008 | red <STRONG>COLOR_RED</STRONG> 4 max,0,0 |
| 2009 | magenta <STRONG>COLOR_MAGENTA</STRONG> 5 max,0,max |
| 2010 | yellow <STRONG>COLOR_YELLOW</STRONG> 6 max,max,0 |
| 2011 | white <STRONG>COLOR_WHITE</STRONG> 7 max,max,max |
| 2012 | It is important to not confuse the two sets of color capa- |
| 2013 | bilities; otherwise red/blue will be interchanged on the |
| 2014 | display. |
| 2015 | |
| 2016 | On an HP-like terminal, use <STRONG>scp</STRONG> with a color-pair number |
| 2017 | parameter to set which color pair is current. |
| 2018 | |
| 2019 | On a Tektronix-like terminal, the capability <STRONG>ccc</STRONG> may be |
| 2020 | present to indicate that colors can be modified. If so, |
| 2021 | the <STRONG>initc</STRONG> capability will take a color number (0 to <STRONG>colors</STRONG> |
| 2022 | - 1)and three more parameters which describe the color. |
| 2023 | These three parameters default to being interpreted as RGB |
| 2024 | (Red, Green, Blue) values. If the boolean capability <STRONG>hls</STRONG> |
| 2025 | is present, they are instead as HLS (Hue, Lightness, Satu- |
| 2026 | ration) indices. The ranges are terminal-dependent. |
| 2027 | |
| 2028 | On an HP-like terminal, <STRONG>initp</STRONG> may give a capability for |
| 2029 | changing a color-pair value. It will take seven parame- |
| 2030 | ters; a color-pair number (0 to <STRONG>max_pairs</STRONG> - 1), and two |
| 2031 | triples describing first background and then foreground |
| 2032 | colors. These parameters must be (Red, Green, Blue) or |
| 2033 | (Hue, Lightness, Saturation) depending on <STRONG>hls</STRONG>. |
| 2034 | |
| 2035 | On some color terminals, colors collide with highlights. |
| 2036 | You can register these collisions with the <STRONG>ncv</STRONG> capability. |
| 2037 | This is a bit-mask of attributes not to be used when col- |
| 2038 | ors are enabled. The correspondence with the attributes |
| 2039 | understood by <STRONG>curses</STRONG> is as follows: |
| 2040 | |
| 2041 | |
| 2042 | <STRONG>Attribute</STRONG> <STRONG>Bit</STRONG> <STRONG>Decimal</STRONG> |
| 2043 | A_STANDOUT 0 1 |
| 2044 | A_UNDERLINE 1 2 |
| 2045 | A_REVERSE 2 4 |
| 2046 | A_BLINK 3 8 |
| 2047 | A_DIM 4 16 |
| 2048 | A_BOLD 5 32 |
| 2049 | A_INVIS 6 64 |
| 2050 | A_PROTECT 7 128 |
| 2051 | A_ALTCHARSET 8 256 |
| 2052 | |
| 2053 | For example, on many IBM PC consoles, the underline |
| 2054 | attribute collides with the foreground color blue and is |
| 2055 | not available in color mode. These should have an <STRONG>ncv</STRONG> |
| 2056 | capability of 2. |
| 2057 | |
| 2058 | SVr4 curses does nothing with <STRONG>ncv</STRONG>, ncurses recognizes it |
| 2059 | and optimizes the output in favor of colors. |
| 2060 | |
| 2061 | |
| 2062 | <STRONG>Miscellaneous</STRONG> |
| 2063 | If the terminal requires other than a null (zero) charac- |
| 2064 | ter as a pad, then this can be given as pad. Only the |
| 2065 | first character of the pad string is used. If the termi- |
| 2066 | nal does not have a pad character, specify npc. Note that |
| 2067 | ncurses implements the termcap-compatible <STRONG>PC</STRONG> variable; |
| 2068 | though the application may set this value to something |
| 2069 | other than a null, ncurses will test <STRONG>npc</STRONG> first and use |
| 2070 | napms if the terminal has no pad character. |
| 2071 | |
| 2072 | If the terminal can move up or down half a line, this can |
| 2073 | be indicated with <STRONG>hu</STRONG> (half-line up) and <STRONG>hd</STRONG> (half-line |
| 2074 | down). This is primarily useful for superscripts and sub- |
| 2075 | scripts on hard-copy terminals. If a hard-copy terminal |
| 2076 | can eject to the next page (form feed), give this as <STRONG>ff</STRONG> |
| 2077 | (usually control L). |
| 2078 | |
| 2079 | If there is a command to repeat a given character a given |
| 2080 | number of times (to save time transmitting a large number |
| 2081 | of identical characters) this can be indicated with the |
| 2082 | parameterized string <STRONG>rep</STRONG>. The first parameter is the |
| 2083 | character to be repeated and the second is the number of |
| 2084 | times to repeat it. Thus, tparm(repeat_char, 'x', 10) is |
| 2085 | the same as `xxxxxxxxxx'. |
| 2086 | |
| 2087 | If the terminal has a settable command character, such as |
| 2088 | the TEKTRONIX 4025, this can be indicated with <STRONG>cmdch</STRONG>. A |
| 2089 | prototype command character is chosen which is used in all |
| 2090 | capabilities. This character is given in the <STRONG>cmdch</STRONG> capa- |
| 2091 | bility to identify it. The following convention is sup- |
| 2092 | ported on some UNIX systems: The environment is to be |
| 2093 | searched for a <STRONG>CC</STRONG> variable, and if found, all occurrences |
| 2094 | of the prototype character are replaced with the character |
| 2095 | in the environment variable. |
| 2096 | |
| 2097 | Terminal descriptions that do not represent a specific |
| 2098 | kind of known terminal, such as <EM>switch</EM>, <EM>dialup</EM>, <EM>patch</EM>, and |
| 2099 | <EM>network</EM>, should include the <STRONG>gn</STRONG> (generic) capability so |
| 2100 | that programs can complain that they do not know how to |
| 2101 | talk to the terminal. (This capability does not apply to |
| 2102 | <EM>virtual</EM> terminal descriptions for which the escape |
| 2103 | sequences are known.) |
| 2104 | |
| 2105 | If the terminal has a ``meta key'' which acts as a shift |
| 2106 | key, setting the 8th bit of any character transmitted, |
| 2107 | this fact can be indicated with <STRONG>km</STRONG>. Otherwise, software |
| 2108 | will assume that the 8th bit is parity and it will usually |
| 2109 | be cleared. If strings exist to turn this ``meta mode'' |
| 2110 | on and off, they can be given as <STRONG>smm</STRONG> and <STRONG>rmm</STRONG>. |
| 2111 | |
| 2112 | If the terminal has more lines of memory than will fit on |
| 2113 | the screen at once, the number of lines of memory can be |
| 2114 | indicated with <STRONG>lm</STRONG>. A value of <STRONG>lm</STRONG>#0 indicates that the |
| 2115 | number of lines is not fixed, but that there is still more |
| 2116 | memory than fits on the screen. |
| 2117 | |
| 2118 | If the terminal is one of those supported by the UNIX vir- |
| 2119 | tual terminal protocol, the terminal number can be given |
| 2120 | as <STRONG>vt</STRONG>. |
| 2121 | |
| 2122 | Media copy strings which control an auxiliary printer con- |
| 2123 | nected to the terminal can be given as <STRONG>mc0</STRONG>: print the con- |
| 2124 | tents of the screen, <STRONG>mc4</STRONG>: turn off the printer, and <STRONG>mc5</STRONG>: |
| 2125 | turn on the printer. When the printer is on, all text |
| 2126 | sent to the terminal will be sent to the printer. It is |
| 2127 | undefined whether the text is also displayed on the termi- |
| 2128 | nal screen when the printer is on. A variation <STRONG>mc5p</STRONG> takes |
| 2129 | one parameter, and leaves the printer on for as many char- |
| 2130 | acters as the value of the parameter, then turns the |
| 2131 | printer off. The parameter should not exceed 255. All |
| 2132 | text, including <STRONG>mc4</STRONG>, is transparently passed to the |
| 2133 | printer while an <STRONG>mc5p</STRONG> is in effect. |
| 2134 | |
| 2135 | |
| 2136 | <STRONG>Glitches</STRONG> <STRONG>and</STRONG> <STRONG>Braindamage</STRONG> |
| 2137 | Hazeltine terminals, which do not allow `~' characters to |
| 2138 | be displayed should indicate <STRONG>hz</STRONG>. |
| 2139 | |
| 2140 | Terminals which ignore a line-feed immediately after an <STRONG>am</STRONG> |
| 2141 | wrap, such as the Concept and vt100, should indicate <STRONG>xenl</STRONG>. |
| 2142 | |
| 2143 | If <STRONG>el</STRONG> is required to get rid of standout (instead of |
| 2144 | merely writing normal text on top of it), <STRONG>xhp</STRONG> should be |
| 2145 | given. |
| 2146 | |
| 2147 | Teleray terminals, where tabs turn all characters moved |
| 2148 | over to blanks, should indicate <STRONG>xt</STRONG> (destructive tabs). |
| 2149 | Note: the variable indicating this is now |
| 2150 | `dest_tabs_magic_smso'; in older versions, it was tel- |
| 2151 | eray_glitch. This glitch is also taken to mean that it is |
| 2152 | not possible to position the cursor on top of a ``magic |
| 2153 | cookie'', that to erase standout mode it is instead neces- |
| 2154 | sary to use delete and insert line. The ncurses implemen- |
| 2155 | tation ignores this glitch. |
| 2156 | |
| 2157 | The Beehive Superbee, which is unable to correctly trans- |
| 2158 | mit the escape or control C characters, has <STRONG>xsb</STRONG>, indicat- |
| 2159 | ing that the f1 key is used for escape and f2 for control |
| 2160 | C. (Only certain Superbees have this problem, depending |
| 2161 | on the ROM.) Note that in older terminfo versions, this |
| 2162 | capability was called `beehive_glitch'; it is now |
| 2163 | `no_esc_ctl_c'. |
| 2164 | |
| 2165 | Other specific terminal problems may be corrected by |
| 2166 | adding more capabilities of the form <STRONG>x</STRONG><EM>x</EM>. |
| 2167 | |
| 2168 | |
| 2169 | <STRONG>Similar</STRONG> <STRONG>Terminals</STRONG> |
| 2170 | If there are two very similar terminals, one (the variant) |
| 2171 | can be defined as being just like the other (the base) |
| 2172 | with certain exceptions. In the definition of the vari- |
| 2173 | ant, the string capability <STRONG>use</STRONG> can be given with the name |
| 2174 | of the base terminal. The capabilities given before <STRONG>use</STRONG> |
| 2175 | override those in the base type named by <STRONG>use</STRONG>. If there |
| 2176 | are multiple <STRONG>use</STRONG> capabilities, they are merged in reverse |
| 2177 | order. That is, the rightmost <STRONG>use</STRONG> reference is processed |
| 2178 | first, then the one to its left, and so forth. Capabili- |
| 2179 | ties given explicitly in the entry override those brought |
| 2180 | in by <STRONG>use</STRONG> references. |
| 2181 | |
| 2182 | A capability can be canceled by placing <STRONG>xx@</STRONG> to the left of |
| 2183 | the use reference that imports it, where <EM>xx</EM> is the capa- |
| 2184 | bility. For example, the entry |
| 2185 | |
| 2186 | 2621-nl, smkx@, rmkx@, use=2621, |
| 2187 | |
| 2188 | defines a 2621-nl that does not have the <STRONG>smkx</STRONG> or <STRONG>rmkx</STRONG> |
| 2189 | capabilities, and hence does not turn on the function key |
| 2190 | labels when in visual mode. This is useful for different |
| 2191 | modes for a terminal, or for different user preferences. |
| 2192 | |
| 2193 | |
| 2194 | <STRONG>Pitfalls</STRONG> <STRONG>of</STRONG> <STRONG>Long</STRONG> <STRONG>Entries</STRONG> |
| 2195 | Long terminfo entries are unlikely to be a problem; to |
| 2196 | date, no entry has even approached terminfo's 4096-byte |
| 2197 | string-table maximum. Unfortunately, the termcap transla- |
| 2198 | tions are much more strictly limited (to 1023 bytes), thus |
| 2199 | termcap translations of long terminfo entries can cause |
| 2200 | problems. |
| 2201 | |
| 2202 | The man pages for 4.3BSD and older versions of <STRONG>tgetent()</STRONG> |
| 2203 | instruct the user to allocate a 1024-byte buffer for the |
| 2204 | termcap entry. The entry gets null-terminated by the |
| 2205 | termcap library, so that makes the maximum safe length for |
| 2206 | a termcap entry 1k-1 (1023) bytes. Depending on what the |
| 2207 | application and the termcap library being used does, and |
| 2208 | where in the termcap file the terminal type that <STRONG>tgetent()</STRONG> |
| 2209 | is searching for is, several bad things can happen. |
| 2210 | |
| 2211 | Some termcap libraries print a warning message or exit if |
| 2212 | they find an entry that's longer than 1023 bytes; others |
| 2213 | do not; others truncate the entries to 1023 bytes. Some |
| 2214 | application programs allocate more than the recommended 1K |
| 2215 | for the termcap entry; others do not. |
| 2216 | |
| 2217 | Each termcap entry has two important sizes associated with |
| 2218 | it: before "tc" expansion, and after "tc" expansion. "tc" |
| 2219 | is the capability that tacks on another termcap entry to |
| 2220 | the end of the current one, to add on its capabilities. |
| 2221 | If a termcap entry does not use the "tc" capability, then |
| 2222 | of course the two lengths are the same. |
| 2223 | |
| 2224 | The "before tc expansion" length is the most important |
| 2225 | one, because it affects more than just users of that par- |
| 2226 | ticular terminal. This is the length of the entry as it |
| 2227 | exists in /etc/termcap, minus the backslash-newline pairs, |
| 2228 | which <STRONG>tgetent()</STRONG> strips out while reading it. Some termcap |
| 2229 | libraries strip off the final newline, too (GNU termcap |
| 2230 | does not). Now suppose: |
| 2231 | |
| 2232 | * a termcap entry before expansion is more than 1023 |
| 2233 | bytes long, |
| 2234 | |
| 2235 | * and the application has only allocated a 1k buffer, |
| 2236 | |
| 2237 | * and the termcap library (like the one in BSD/OS 1.1 |
| 2238 | and GNU) reads the whole entry into the buffer, no |
| 2239 | matter what its length, to see if it is the entry it |
| 2240 | wants, |
| 2241 | |
| 2242 | * and <STRONG>tgetent()</STRONG> is searching for a terminal type that |
| 2243 | either is the long entry, appears in the termcap file |
| 2244 | after the long entry, or does not appear in the file |
| 2245 | at all (so that <STRONG>tgetent()</STRONG> has to search the whole |
| 2246 | termcap file). |
| 2247 | |
| 2248 | Then <STRONG>tgetent()</STRONG> will overwrite memory, perhaps its stack, |
| 2249 | and probably core dump the program. Programs like telnet |
| 2250 | are particularly vulnerable; modern telnets pass along |
| 2251 | values like the terminal type automatically. The results |
| 2252 | are almost as undesirable with a termcap library, like |
| 2253 | SunOS 4.1.3 and Ultrix 4.4, that prints warning messages |
| 2254 | when it reads an overly long termcap entry. If a termcap |
| 2255 | library truncates long entries, like OSF/1 3.0, it is |
| 2256 | immune to dying here but will return incorrect data for |
| 2257 | the terminal. |
| 2258 | |
| 2259 | The "after tc expansion" length will have a similar effect |
| 2260 | to the above, but only for people who actually set TERM to |
| 2261 | that terminal type, since <STRONG>tgetent()</STRONG> only does "tc" expan- |
| 2262 | sion once it is found the terminal type it was looking |
| 2263 | for, not while searching. |
| 2264 | |
| 2265 | In summary, a termcap entry that is longer than 1023 bytes |
| 2266 | can cause, on various combinations of termcap libraries |
| 2267 | and applications, a core dump, warnings, or incorrect |
| 2268 | operation. If it is too long even before "tc" expansion, |
| 2269 | it will have this effect even for users of some other ter- |
| 2270 | minal types and users whose TERM variable does not have a |
| 2271 | termcap entry. |
| 2272 | |
| 2273 | When in -C (translate to termcap) mode, the <STRONG>ncurses</STRONG> imple- |
| 2274 | mentation of <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG> issues warning messages when the pre- |
| 2275 | tc length of a termcap translation is too long. The -c |
| 2276 | (check) option also checks resolved (after tc expansion) |
| 2277 | lengths. |
| 2278 | |
| 2279 | <STRONG>Binary</STRONG> <STRONG>Compatibility</STRONG> |
| 2280 | It is not wise to count on portability of binary terminfo |
| 2281 | entries between commercial UNIX versions. The problem is |
| 2282 | that there are at least two versions of terminfo (under |
| 2283 | HP-UX and AIX) which diverged from System V terminfo after |
| 2284 | SVr1, and have added extension capabilities to the string |
| 2285 | table that (in the binary format) collide with System V |
| 2286 | and XSI Curses extensions. |
| 2287 | |
| 2288 | |
| 2289 | </PRE> |
| 2290 | <H2>EXTENSIONS</H2><PRE> |
| 2291 | Some SVr4 <STRONG>curses</STRONG> implementations, and all previous to |
| 2292 | SVr4, do not interpret the %A and %O operators in parame- |
| 2293 | ter strings. |
| 2294 | |
| 2295 | SVr4/XPG4 do not specify whether <STRONG>msgr</STRONG> licenses movement |
| 2296 | while in an alternate-character-set mode (such modes may, |
| 2297 | among other things, map CR and NL to characters that do |
| 2298 | not trigger local motions). The <STRONG>ncurses</STRONG> implementation |
| 2299 | ignores <STRONG>msgr</STRONG> in <STRONG>ALTCHARSET</STRONG> mode. This raises the possi- |
| 2300 | bility that an XPG4 implementation making the opposite |
| 2301 | interpretation may need terminfo entries made for <STRONG>ncurses</STRONG> |
| 2302 | to have <STRONG>msgr</STRONG> turned off. |
| 2303 | |
| 2304 | The <STRONG>ncurses</STRONG> library handles insert-character and insert- |
| 2305 | character modes in a slightly non-standard way to get bet- |
| 2306 | ter update efficiency. See the <STRONG>Insert/Delete</STRONG> <STRONG>Character</STRONG> |
| 2307 | subsection above. |
| 2308 | |
| 2309 | The parameter substitutions for <STRONG>set_clock</STRONG> and <STRONG>dis-</STRONG> |
| 2310 | <STRONG>play_clock</STRONG> are not documented in SVr4 or the XSI Curses |
| 2311 | standard. They are deduced from the documentation for the |
| 2312 | AT&T 505 terminal. |
| 2313 | |
| 2314 | Be careful assigning the <STRONG>kmous</STRONG> capability. The <STRONG>ncurses</STRONG> |
| 2315 | wants to interpret it as <STRONG>KEY_MOUSE</STRONG>, for use by terminals |
| 2316 | and emulators like xterm that can return mouse-tracking |
| 2317 | information in the keyboard-input stream. |
| 2318 | |
| 2319 | Different commercial ports of terminfo and curses support |
| 2320 | different subsets of the XSI Curses standard and (in some |
| 2321 | cases) different extension sets. Here is a summary, accu- |
| 2322 | rate as of October 1995: |
| 2323 | |
| 2324 | <STRONG>SVR4,</STRONG> <STRONG>Solaris,</STRONG> <STRONG>ncurses</STRONG> -- These support all SVr4 capabili- |
| 2325 | ties. |
| 2326 | |
| 2327 | <STRONG>SGI</STRONG> -- Supports the SVr4 set, adds one undocumented |
| 2328 | extended string capability (<STRONG>set_pglen</STRONG>). |
| 2329 | |
| 2330 | <STRONG>SVr1,</STRONG> <STRONG>Ultrix</STRONG> -- These support a restricted subset of ter- |
| 2331 | minfo capabilities. The booleans end with <STRONG>xon_xoff</STRONG>; the |
| 2332 | numerics with <STRONG>width_status_line</STRONG>; and the strings with |
| 2333 | <STRONG>prtr_non</STRONG>. |
| 2334 | |
| 2335 | <STRONG>HP/UX</STRONG> -- Supports the SVr1 subset, plus the SVr[234] |
| 2336 | numerics <STRONG>num_labels</STRONG>, <STRONG>label_height</STRONG>, <STRONG>label_width</STRONG>, plus func- |
| 2337 | tion keys 11 through 63, plus <STRONG>plab_norm</STRONG>, <STRONG>label_on</STRONG>, and |
| 2338 | <STRONG>label_off</STRONG>, plus some incompatible extensions in the string |
| 2339 | table. |
| 2340 | |
| 2341 | <STRONG>AIX</STRONG> -- Supports the SVr1 subset, plus function keys 11 |
| 2342 | through 63, plus a number of incompatible string table |
| 2343 | extensions. |
| 2344 | |
| 2345 | <STRONG>OSF</STRONG> -- Supports both the SVr4 set and the AIX extensions. |
| 2346 | |
| 2347 | |
| 2348 | </PRE> |
| 2349 | <H2>FILES</H2><PRE> |
| 2350 | /usr/share/terminfo/?/* files containing terminal |
| 2351 | descriptions |
| 2352 | |
| 2353 | |
| 2354 | </PRE> |
| 2355 | <H2>SEE ALSO</H2><PRE> |
| 2356 | <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>, <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="printf.3.html">printf(3)</A></STRONG>, <STRONG><A HREF="term.5.html">term(5)</A></STRONG>. |
| 2357 | |
| 2358 | |
| 2359 | </PRE> |
| 2360 | <H2>AUTHORS</H2><PRE> |
| 2361 | Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. |
| 2362 | Based on pcurses by Pavel Curtis. |
| 2363 | |
| 2364 | |
| 2365 | |
| 2366 | <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> |
| 2367 | </PRE> |
| 2368 | <HR> |
| 2369 | <ADDRESS> |
| 2370 | Man(1) output converted with |
| 2371 | <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> |
| 2372 | </ADDRESS> |
| 2373 | </BODY> |
| 2374 | </HTML> |