1.\" Copyright (c) 1985, 1991, 1993, 1994 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)termcap.5 8.3 (Berkeley) 4/16/94 33.\" 34.\" /*************************************************************************** 35.\" * COPYRIGHT NOTICE * 36.\" **************************************************************************** 37.\" * ncurses is copyright (C) 1992-1995 * 38.\" * Zeyd M. Ben-Halim * 39.\" * zmbenhal@netcom.com * 40.\" * Eric S. Raymond * 41.\" * esr@snark.thyrsus.com * 42.\" * * 43.\" * Permission is hereby granted to reproduce and distribute ncurses * 44.\" * by any means and for any fee, whether alone or as part of a * 45.\" * larger distribution, in source or in binary form, PROVIDED * 46.\" * this notice is included with any such distribution, and is not * 47.\" * removed from any of its header files. Mention of ncurses in any * 48.\" * applications linked with it is highly appreciated. * 49.\" * * 50.\" * ncurses comes AS IS with no warranty, implied or expressed. * 51.\" * * 52.\" ***************************************************************************/ 53.\" 54.\" $FreeBSD$ 55.\" 56.Dd April 16, 1994 57.Dt TERMCAP 5 58.Os 59.Sh NAME 60.Nm termcap 61.Nd terminal capability data base 62.Sh SYNOPSIS 63.Nm 64.Sh DESCRIPTION 65The 66.Nm 67file 68is a data base describing terminals, 69used, 70for example, 71by 72.Xr \&vi 1 73and 74.Xr ncurses 3 . 75Terminals are described in 76.Nm 77by giving a set of capabilities that they have and by describing 78how operations are performed. 79Padding requirements and initialization sequences 80are included in 81.Nm . 82.Pp 83Entries in 84.Nm 85consist of a number of `:'-separated fields. 86The first entry for each terminal gives the names that are known for the 87terminal, separated by `|' characters. 88The first name given is the most common abbreviation for the terminal. 89The last name given should be a long name fully identifying the terminal, 90and all others are understood as synonyms for the terminal name. 91All names but the last should be in lower case and contain no blanks; 92the last name may well contain upper case characters and blanks for 93readability. 94.Pp 95Terminal names (except for the last, verbose entry) 96should be chosen using the following conventions. 97The particular piece of hardware making up the terminal 98should have a root name chosen, thus 99.Dq hp2621 100This name should not contain hyphens. 101Modes that the hardware can be in 102or user preferences 103should be indicated by appending a hyphen and an indicator of the mode. 104Therefore, a 105.Dq vt100 106in 132-column mode would be 107.Dq vt100-w . 108The following suffixes should be used where possible: 109.Pp 110.Bl -column indent "With automatic margins (usually default)xx" -offset indent 111.Sy "Suffix Meaning Example" 112-w Wide mode (more than 80 columns) vt100-w 113-am With automatic margins (usually default) vt100-am 114-nam Without automatic margins vt100-nam 115.Pf \- Ar n Ta No "Number of lines on screen aaa-60" 116-na No arrow keys (leave them in local) concept100-na 117.Pf \- Ar \&np Ta No "Number of pages of memory concept100-4p" 118-rv Reverse video concept100-rv 119.El 120.Sh CAPABILITIES 121The description field attempts to convey the semantics of the 122capability. 123You may find some codes in the description field: 124.Pp 125.Bl -tag -width #[1-9] 126.It (P) 127indicates that padding may be specified. 128.It #[1-9] 129in the description field indicates that the string is passed through 130.Xr tparm 131or 132.Xr tgoto 133with parms as given (#\fIi\fP). 134.It (P*) 135indicates that padding may vary in proportion to the number of 136lines affected. 137.It (#\d\fIi\fP\u) 138indicates the \fIi\fP\uth\d parameter. 139.El 140.Pp 141These are the boolean capabilities: 142.Bd -literal 143\fBBoolean TCap Description\fR 144\fBVariables Code\fR 145auto_left_margin bw cursor_left wraps from column 0 to last 146 column 147auto_right_margin am terminal has automatic margins 148no_esc_ctlc xb beehive (f1=escape, f2=ctrl C) 149ceol_standout_glitch xs standout not erased by overwriting (hp) 150eat_newline_glitch xn newline ignored after 80 cols (concept) 151erase_overstrike eo can erase overstrikes with a blank 152generic_type gn generic line type 153hard_copy hc hardcopy terminal 154has_meta_key km Has a meta key, sets msb high 155has_status_line hs has extra status line 156insert_null_glitch in insert mode distinguishes nulls 157memory_above da display may be retained above the screen 158memory_below db display may be retained below the screen 159move_insert_mode mi safe to move while in insert mode 160move_standout_mode ms safe to move while in standout mode 161over_strike os terminal can overstrike 162status_line_esc_ok es escape can be used on the status line 163dest_tabs_magic_smso xt tabs destructive, magic so char (t1061) 164tilde_glitch hz can't print ~'s (hazeltine) 165transparent_underline ul underline character overstrikes 166xon_xoff xo terminal uses xon/xoff handshaking 167needs_xon_xoff nx padding won't work, xon/xoff required 168prtr_silent 5i printer won't echo on screen 169hard_cursor HC cursor is hard to see 170non_rev_rmcup NR enter_ca_mode does not reverse exit_ca_mode 171no_pad_char NP pad character does not exist 172non_dest_scroll_region ND scrolling region is non-destructive 173can_change cc terminal can re-define existing colors 174back_color_erase ut screen erased with background color 175hue_lightness_saturation hl terminal uses only HLS color 176 notation (tektronix) 177col_addr_glitch YA only positive motion for column address and 178 micro_column_address caps 179cr_cancels_micro_mode YB using cr turns off micro mode 180has_print_wheel YC printer needs operator to change character 181 set 182row_addr_glitch YD only positive motion for row_address and 183 micro_row_address caps 184semi_auto_right_margin YE printing in last column causes cr 185cpi_changes_res YF changing character pitch changes resolution 186lpi_changes_res YG changing line pitch changes resolution 187.Ed 188.Pp 189These are the numeric capabilities: 190.Bd -literal 191\fBNumeric TCap Description\fR 192\fBVariables Code\fR 193columns co number of columns in aline 194init_tabs it tabs initially every # spaces 195lines li number of lines on screen or page 196lines_of_memory lm lines of memory if > line. 0 => varies 197magic_cookie_glitch sg number of blank chars left by 198 enter_standout_mode or exit_standout_mode 199padding_baud_rate pb lowest baud rate where padding needed 200virtual_terminal vt virtual terminal number (CB/unix) 201width_status_line ws columns in status line 202num_labels Nl number of labels on screen 203label_height lh rows in each label 204label_width lw columns in each label 205max_attributes ma maximum combined attributes terminal can 206 handle 207maximum_windows MW maximum number of definable windows 208magic_cookie_glitch_ul ug number of blanks left by underline 209# 210# These came in with SVr4's color support 211# 212max_colors Co maximum numbers of colors on screen 213max_pairs pa maximum number of color-pairs on the screen 214no_color_video NC video attributes that can't be used with 215 colors 216# 217# The following numeric capabilities are present in the SVr4.0 term 218# structure, but are not yet documented in the man page. 219# They came in with SVr4's printer support. 220# 221buffer_capacity Ya numbers of bytes buffered before printing 222dot_vert_spacing Yb spacing of pins vertically in pins per inch 223dot_horz_spacing Yc spacing of dots horizontally in dots per 224 inch 225max_micro_address Yd maximum value in micro_..._address 226max_micro_jump Ye maximum value in parm_..._micro 227micro_char_size Yf character size when in micro mode 228micro_line_size Yg line size when in micro mode 229number_of_pins Yh numbers of pins in print-head 230output_res_char Yi horizontal resolution in units per line 231output_res_line Yj vertical resolution in units per line 232output_res_horz_inch Yk horizontal resolution in units per inch 233output_res_vert_inch Yl vertical resolution in units per inch 234print_rate Ym print rate in chars per second 235wide_char_size Yn character step size when in double wide 236 mode 237buttons BT number of buttons on mouse 238bit_image_entwining Yo number of passed for each bit-image row 239bit_image_type Yp type of bit-image device 240.Ed 241.Pp 242These are the string capabilities: 243.Bd -literal 244\fBString TCap Description\fR 245\fBVariables Code\fR 246back_tab bt back tab (P) 247bell bl audible signal (bell) (P) 248carriage_return cr carriage return (P*) 249change_scroll_region cs change region to line #1 to line #2 (P) 250clear_all_tabs ct clear all tab stops (P) 251clear_screen cl clear screen and home cursor (P*) 252clr_eol ce clear to end of line (P) 253clr_eos cd clear to end of screen (P*) 254column_address ch horizontal position #1, absolute (P) 255command_character CC terminal settable cmd character in 256 prototype 257cursor_address cm move to row #1 columns #2 258cursor_down do down one line 259cursor_home ho home cursor 260cursor_invisible vi make cursor invisible 261cursor_left le move left one space 262cursor_mem_address CM memory relative cursor addressing 263cursor_normal ve make cursor appear normal (undo 264 cursor_invisible/cursor_visible) 265cursor_right nd move right one space 266cursor_to_ll ll last line, first column 267cursor_up up up one line 268cursor_visible vs make cursor very visible 269delete_character dc delete character (P*) 270delete_line dl delete line (P*) 271dis_status_line ds disable status line 272down_half_line hd half a line down 273enter_alt_charset_mode as start alternate character set (P) 274enter_blink_mode mb turn on blinking 275enter_bold_mode md turn on bold (extra bright) mode 276enter_ca_mode ti string to start programs using 277 cursor_address 278enter_delete_mode dm enter delete mode 279enter_dim_mode mh turn on half-bright mode 280enter_insert_mode im enter insert mode 281enter_secure_mode mk turn on blank mode (characters invisible) 282enter_protected_mode mp turn on protected mode 283enter_reverse_mode mr turn on reverse video mode 284enter_standout_mode so begin standout mode 285enter_underline_mode us begin underline mode 286erase_chars ec erase #1 characters (P) 287exit_alt_charset_mode ae end alternate character set (P) 288exit_attribute_mode me turn off all attributes 289exit_ca_mode te strings to end programs using cup 290exit_delete_mode ed end delete mode 291exit_insert_mode ei exit insert mode 292exit_standout_mode se exit standout mode 293exit_underline_mode ue exit underline mode 294flash_screen vb visible bell (may not move cursor) 295form_feed ff hardcopy terminal page eject (P*) 296from_status_line fs return from status line 297init_1string i1 initialization string 298init_2string is initialization string 299init_3string i3 initialization string 300init_file if name of initialization file 301insert_character ic insert character (P) 302insert_line al insert line (P*) 303insert_padding ip insert padding after inserted character 304key_backspace kb backspace key 305key_catab ka clear-all-tabs key 306key_clear kC clear-screen or erase key 307key_ctab kt clear-tab key 308key_dc kD delete-character key 309key_dl kL delete-line key 310key_down kd down-arrow key 311key_eic kM sent by rmir or smir in insert mode 312key_eol kE clear-to-end-of-line key 313key_eos kS clear-to-end-of-screen key 314key_f0 k0 F0 function key 315key_f1 k1 F1 function key 316key_f10 k; F10 function key 317key_f2 k2 F2 function key 318key_f3 k3 F3 function key 319key_f4 k4 F4 function key 320key_f5 k5 F5 function key 321key_f6 k6 F6 function key 322key_f7 k7 F7 function key 323key_f8 k8 F8 function key 324key_f9 k9 F9 function key 325key_home kh home key 326key_ic kI insert-character key 327key_il kA insert-line key 328key_left kl left-arrow key 329key_ll kH last-line key 330key_npage kN next-page key 331key_ppage kP prev-page key 332key_right kr right-arrow key 333key_sf kF scroll-forward key 334key_sr kR scroll-backward key 335key_stab kT set-tab key 336key_up ku up-arrow key 337keypad_local ke leave 'keyboard_transmit' mode 338keypad_xmit ks enter 'keyboard_transmit' mode 339lab_f0 l0 label on function key f0 if not f0 340lab_f1 l1 label on function key f1 if not f1 341lab_f10 la label on function key f10 if not f10 342lab_f2 l2 label on function key f2 if not f2 343lab_f3 l3 label on function key f3 if not f3 344lab_f4 l4 label on function key f4 if not f4 345lab_f5 l5 label on function key f5 if not f5 346lab_f6 l6 label on function key f6 if not f6 347lab_f7 l7 label on function key f7 if not f7 348lab_f8 l8 label on function key f8 if not f8 349lab_f9 l9 label on function key f9 if not f9 350meta_off mo turn off meta mode 351meta_on mm turn on meta mode (8th-bit on) 352newline nw newline (behave like cr followed by lf) 353pad_char pc padding char (instead of null) 354parm_dch DC delete #1 chars (P*) 355parm_delete_line DL delete #1 lines (P*) 356parm_down_cursor DO down #1 lines (P*) 357parm_ich IC insert #1 chars (P*) 358parm_index SF scroll forward #1 lines (P) 359parm_insert_line AL insert #1 lines (P*) 360parm_left_cursor LE move #1 chars to the left (P) 361parm_right_cursor RI move #1 chars to the right (P*) 362parm_rindex SR scroll back #1 lines (P) 363parm_up_cursor UP up #1 lines (P*) 364pkey_key pk program function key #1 to type string #2 365pkey_local pl program function key #1 to execute 366 string #2 367pkey_xmit px program function key #1 to transmit 368 string #2 369print_screen ps print contents of screen 370prtr_off pf turn off printer 371prtr_on po turn on printer 372repeat_char rp repeat char #1 #2 times (P*) 373reset_1string r1 reset string 374reset_2string r2 reset string 375reset_3string r3 reset string 376reset_file rf name of reset file 377restore_cursor rc restore cursor to last position of 378 save_cursor 379row_address cv vertical position #1 absolute (P) 380save_cursor sc save current cursor position (P) 381scroll_forward sf scroll text up (P) 382scroll_reverse sr scroll text down (P) 383set_attributes sa define video attributes #1-#9 (PG9) 384set_tab st set a tab in every row, current columns 385set_window wi current window is lines #1-#2 cols #3-#4 386tab ta tab to next 8-space hardware tab stop 387to_status_line ts move to status line 388underline_char uc underline char and move past it 389up_half_line hu half a line up 390init_prog iP path name of program for initialization 391key_a1 K1 upper left of keypad 392key_a3 K3 upper right of keypad 393key_b2 K2 center of keypad 394key_c1 K4 lower left of keypad 395key_c3 K5 lower right of keypad 396prtr_non pO turn on printer for #1 bytes 397termcap_init2 i2 secondary initialization string 398termcap_reset rs terminal reset string 399# 400# SVr1 capabilities stop here. IBM's version of terminfo is the same as 401# SVr4 up to this point, but has a different set afterwards. 402# 403char_padding rP like insert_padding but when in insert mode 404acs_chars ac graphics charset pairs - def=vt100 405plab_norm pn program label #1 to show string #2 406key_btab kB back-tab key 407enter_xon_mode SX turn on xon/xoff handshaking 408exit_xon_mode RX turn off xon/xoff handshaking 409enter_am_mode SA turn on automatic margins 410exit_am_mode RA turn off automatic margins 411xon_character XN XON character 412xoff_character XF XOFF character 413ena_acs eA enable alternate char set 414label_on LO turn on soft labels 415label_off LF turn off soft labels 416key_beg @1 begin key 417key_cancel @2 cancel key 418key_close @3 close key 419key_command @4 command key 420key_copy @5 copy key 421key_create @6 create key 422key_end @7 end key 423key_enter @8 enter/send key 424key_exit @9 exit key 425key_find @0 find key 426key_help %1 help key 427key_mark %2 mark key 428key_message %3 message key 429key_move %4 move key 430key_next %5 next key 431key_open %6 open key 432key_options %7 options key 433key_previous %8 previous key 434key_print %9 print key 435key_redo %0 redo key 436key_reference &1 reference key 437key_refresh &2 refresh key 438key_replace &3 replace key 439key_restart &4 restart key 440key_resume &5 resume key 441key_save &6 save key 442key_suspend &7 suspend key 443key_undo &8 undo key 444key_sbeg &9 shifted key 445key_scancel &0 shifted key 446key_scommand *1 shifted key 447key_scopy *2 shifted key 448key_screate *3 shifted key 449key_sdc *4 shifted key 450key_sdl *5 shifted key 451key_select *6 select key 452key_send *7 shifted key 453key_seol *8 shifted key 454key_sexit *9 shifted key 455key_sfind *0 shifted key 456key_shelp #1 shifted key 457key_shome #2 shifted key 458key_sic #3 shifted key 459key_sleft #4 shifted key 460key_smessage %a shifted key 461key_smove %b shifted key 462key_snext %c shifted key 463key_soptions %d shifted key 464key_sprevious %e shifted key 465key_sprint %f shifted key 466key_sredo %g shifted key 467key_sreplace %h shifted key 468key_sright %i shifted key 469key_srsume %j shifted key 470key_ssave !1 shifted key 471key_ssuspend !2 shifted key 472key_sundo !3 shifted key 473req_for_input RF send next input char (for ptys) 474key_f11 F1 F11 function key 475key_f12 F2 F12 function key 476key_f13 F3 F13 function key 477key_f14 F4 F14 function key 478key_f15 F5 F15 function key 479key_f16 F6 F16 function key 480key_f17 F7 F17 function key 481key_f18 F8 F18 function key 482key_f19 F9 F19 function key 483key_f20 FA F20 function key 484key_f21 FB F21 function key 485key_f22 FC F22 function key 486key_f23 FD F23 function key 487key_f24 FE F24 function key 488key_f25 FF F25 function key 489key_f26 FG F26 function key 490key_f27 FH F27 function key 491key_f28 FI F28 function key 492key_f29 FJ F29 function key 493key_f30 FK F30 function key 494key_f31 FL F31 function key 495key_f32 FM F32 function key 496key_f33 FN F33 function key 497key_f34 FO F34 function key 498key_f35 FP F35 function key 499key_f36 FQ F36 function key 500key_f37 FR F37 function key 501key_f38 FS F38 function key 502key_f39 FT F39 function key 503key_f40 FU F40 function key 504key_f41 FV F41 function key 505key_f42 FW F42 function key 506key_f43 FX F43 function key 507key_f44 FY F44 function key 508key_f45 FZ F45 function key 509key_f46 Fa F46 function key 510key_f47 Fb F47 function key 511key_f48 Fc F48 function key 512key_f49 Fd F49 function key 513key_f50 Fe F50 function key 514key_f51 Ff F51 function key 515key_f52 Fg F52 function key 516key_f53 Fh F53 function key 517key_f54 Fi F54 function key 518key_f55 Fj F55 function key 519key_f56 Fk F56 function key 520key_f57 Fl F57 function key 521key_f58 Fm F58 function key 522key_f59 Fn F59 function key 523key_f60 Fo F60 function key 524key_f61 Fp F61 function key 525key_f62 Fq F62 function key 526key_f63 Fr F63 function key 527clr_bol cb Clear to beginning of line 528clear_margins MC clear right and left soft margins 529set_left_margin ML set left soft margin 530set_right_margin MR set right soft margin 531label_format Lf label format 532set_clock SC set clock, #1 hrs #2 mins #3 secs 533display_clock DK display clock at (#1,#2) 534remove_clock RC remove clock 535create_window CW define a window #1 from #2, #3 to #4, #5 536goto_window WG go to window #1 537hangup HU hang-up phone 538dial_phone DI dial number #1 539quick_dial QD dial number #1 without checking 540tone TO select touch tone dialing 541pulse PU select pulse dialling 542flash_hook fh flash switch hook 543fixed_pause PA pause for 2-3 seconds 544wait_tone WA wait for dial-tone 545user0 u0 User string #0 546user1 u1 User string #1 547user2 u2 User string #2 548user3 u3 User string #3 549user4 u4 User string #4 550user5 u5 User string #5 551user6 u6 User string #6 552user7 u7 User string #7 553user8 u8 User string #8 554user9 u9 User string #9 555# 556# SVr4 added these capabilities to support color 557# 558orig_pair op Set default pair to its original value 559orig_colors oc Set all color pairs to the original ones 560initialize_color Ic initialize color #1 to (#2,#3,#4) 561initialize_pair Ip Initialize color pair #1 to fg=(#2,#3,#4), 562 bg=(#5,#6,#7) 563set_color_pair sp Set current color pair to #1 564set_foreground Sf Set foreground color #1 565set_background Sb Set background color #1 566# 567# SVr4 added these capabilities to support printers 568# 569change_char_pitch ZA Change number of characters per inch 570change_line_pitch ZB Change number of lines per inch 571change_res_horz ZC Change horizontal resolution 572change_res_vert ZD Change vertical resolution 573define_char ZE Define a character 574enter_doublewide_mode ZF Enter double-wide mode 575enter_draft_quality ZG Enter draft-quality mode 576enter_italics_mode ZH Enter italic mode 577enter_leftward_mode ZI Start leftward carriage motion 578enter_micro_mode ZJ Start micro-motion mode 579enter_near_letter_quality ZK Enter NLQ mode 580enter_normal_quality ZL Enter normal-quality mode 581enter_shadow_mode ZM Enter shadow-print mode 582enter_subscript_mode ZN Enter subscript mode 583enter_superscript_mode ZO Enter superscript mode 584enter_upward_mode ZP Start upward carriage motion 585exit_doublewide_mode ZQ End double-wide mode 586exit_italics_mode ZR End italic mode 587exit_leftward_mode ZS End left-motion mode 588exit_micro_mode ZT End micro-motion mode 589exit_shadow_mode ZU End shadow-print mode 590exit_subscript_mode ZV End subscript mode 591exit_superscript_mode ZW End superscript mode 592exit_upward_mode ZX End reverse character motion 593micro_column_address ZY Like column_address in micro mode 594micro_down ZZ Like cursor_down in micro mode 595micro_left Za Like cursor_left in micro mode 596micro_right Zb Like cursor_right in micro mode 597micro_row_address Zc Like row_address in micro mode 598micro_up Zd Like cursor_up in micro mode 599order_of_pins Ze Match software bits to print-head pins 600parm_down_micro Zf Like parm_down_cursor in micro mode 601parm_left_micro Zg Like parm_left_cursor in micro mode 602parm_right_micro Zh Like parm_right_cursor in micro mode 603parm_up_micro Zi Like parm_up_cursor in micro mode 604select_char_set Zj Select character set 605set_bottom_margin Zk Set bottom margin at current line 606set_bottom_margin_parm Zl Set bottom margin at line #1 or #2 lines 607 from bottom 608set_left_margin_parm Zm Set left (right) margin at column #1 (#2) 609set_right_margin_parm Zn Set right margin at column #1 610set_top_margin Zo Set top margin at current line 611set_top_margin_parm Zp Set top (bottom) margin at row #1 (#2) 612start_bit_image Zq Start printing bit image graphics 613start_char_set_def Zr Start character set definition 614stop_bit_image Zs Stop printing bit image graphics 615stop_char_set_def Zt End definition of character aet 616subscript_characters Zu List of subscriptible characters 617superscript_characters Zv List of superscriptible characters 618these_cause_cr Zw Printing any of these chars causes CR 619zero_motion Zx No motion for subsequent character 620# 621# The following string capabilities are present in the SVr4.0 term 622# structure, but are not documented in the man page. 623# 624char_set_names Zy List of character set names 625key_mouse Km Mouse event has occurred 626mouse_info Mi Mouse status information 627req_mouse_pos RQ Request mouse position 628get_mouse Gm Curses should get button events 629set_a_foreground AF Set ANSI foreground color 630set_a_background AB Set ANSI background color 631pkey_plab xl Program function key #1 to type string #2 632 and show string #3 633device_type dv Indicate language/codeset support 634code_set_init ci Init sequence for multiple codesets 635set0_des_seq s0 Shift to code set 0 (EUC set 0, ASCII) 636set1_des_seq s1 Shift to code set 1 637set2_des_seq s2 Shift to code set 2 638set3_des_seq s3 Shift to code set 3 639set_lr_margin ML Set both left and right margins to #1, #2 640set_tb_margin MT Sets both top and bottom margins to #1, #2 641bit_image_repeat Xy Repeat bit image cell #1 #2 times 642bit_image_newline Zz Move to next row of the bit image 643bit_image_carriage_return Yv Move to beginning of same row 644color_names Yw Give name for color #1 645define_bit_image_region Yx Define rectangular bit image region 646end_bit_image_region Yy End a bit-image region 647set_color_band Yz Change to ribbon color #1 648set_page_length YZ Set page length to #1 lines 649# 650# SVr4 added these capabilities for direct PC-clone support 651# 652display_pc_char S1 Display PC character 653enter_pc_charset_mode S2 Enter PC character display mode 654exit_pc_charset_mode S3 Exit PC character display mode 655enter_scancode_mode S4 Enter PC scancode mode 656exit_scancode_mode S5 Exit PC scancode mode 657pc_term_options S6 PC terminal options 658scancode_escape S7 Escape for scancode emulation 659alt_scancode_esc S8 Alternate escape for scancode emulation 660# 661# The XSI Curses standard added these. 662# 663enter_horizontal_hl_mode Xh Enter horizontal highlight mode 664enter_left_hl_mode Xl Enter left highlight mode 665enter_low_hl_mode Xo Enter low highlight mode 666enter_right_hl_mode Xr Enter right highlight mode 667enter_top_hl_mode Xt Enter top highlight mode 668enter_vertical_hl_mode Xv Enter vertical highlight mode 669.Ed 670.Pp 671Obsolete termcap capabilities. 672New software should not rely on them at all. 673.Bd -literal 674\fBBoolean TCap Description\fR 675\fBVariables Code\fR 676linefeed_is_newline NL move down with ^J 677even_parity EP terminal requires even parity 678odd_parity OP terminal requires odd parity 679half_duplex HD terminal is half-duplex 680lower_case_only LC terminal has only lower case 681upper_case_only UC terminal has only upper case 682has_hardware_tabs pt has 8-char tabs invoked with ^I 683return_does_clr_eol xr return clears the line 684tek_4025_insert_line xx Tektronix 4025 insert-line glitch 685backspaces_with_bs bs uses ^H to move left 686crt_no_scrolling ns crt cannot scroll 687no_correctly_working_cr nc no way to go to start of line 688.Ed 689.Bd -literal 690\fBNumber TCap Description\fR 691\fBVariables Code\fR 692backspace_delay dB padding required for ^H 693form_feed_delay dF padding required for ^L 694horizontal_tab_delay dT padding required for ^I 695vertical_tab_delay dV padding required for ^V 696number_of_function_keys kn count of function keys 697carriage_return_delay dC pad needed for CR 698new_line_delay dN pad needed for LF 699.Ed 700.Bd -literal 701\fBString TCap Description\fR 702\fBVariables Code\fR 703other_non_function_keys ko list of self-mapped keycaps 704arrow_key_map ma map arrow keys 705memory_lock_above ml lock visible screen memory above the 706 current line 707memory_unlock mu unlock visible screen memory above the 708 current line 709linefeed_if_not_lf nl use to move down 710backspace_if_not_bs bc move left, if not ^H 711.Ed 712.Ss A Sample Entry 713The following entry, which describes the Concept\-100, is among the more 714complex entries in the 715.Nm 716file as of this writing. 717.Pp 718.Bd -literal 719ca\||\|concept100\||\|c100\||\|concept\||\|c104\||\|concept100-4p\||\|HDS Concept\-100:\e 720 :al=3*\eE^R:am:bl=^G:cd=16*\eE^C:ce=16\eE^U:cl=2*^L:cm=\eEa%+ %+ :\e 721 :co#80:.cr=9^M:db:dc=16\eE^A:dl=3*\eE^B:do=^J:ei=\eE\e200:eo:im=\eE^P:in:\e 722 :ip=16*:is=\eEU\eEf\eE7\eE5\eE8\eEl\eENH\eEK\eE\e200\eEo&\e200\eEo\e47\eE:k1=\eE5:\e 723 :k2=\eE6:k3=\eE7:kb=^h:kd=\eE<:ke=\eEx:kh=\eE?:kl=\eE>:kr=\eE=:ks=\eEX:\e 724 :ku=\eE;:le=^H:li#24:mb=\eEC:me=\eEN\e200:mh=\eEE:mi:mk=\eEH:mp=\eEI:\e 725 :mr=\eED:nd=\eE=:pb#9600:rp=0.2*\eEr%.%+ :se=\eEd\eEe:sf=^J:so=\eEE\eED:\e 726 :.ta=8\et:te=\eEv \e200\e200\e200\e200\e200\e200\eEp\er\en:\e 727 :ti=\eEU\eEv 8p\eEp\er:ue=\eEg:ul:up=\eE;:us=\eEG:\e 728 :vb=\eEk\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\e200\eEK:\e 729 :ve=\eEw:vs=\eEW:vt#8:xn:\e 730 :bs:cr=^M:dC#9:dT#8:nl=^J:ta=^I:pt: 731.Ed 732.Pp 733Entries may continue onto multiple lines by giving a \e as the last 734character of a line, and empty fields 735may be included for readability (here between the last field on a line 736and the first field on the next). 737Comments may be included on lines beginning with 738.Dq # . 739.Ss Types of Capabilities 740Capabilities in 741.Nm 742are of three types: Boolean capabilities, 743which indicate particular features that the terminal has; 744numeric capabilities, 745giving the size of the display or the size of other attributes; 746and string capabilities, 747which give character sequences that can be used to perform particular 748terminal operations. 749All capabilities have two-letter codes. 750For instance, the fact that 751the Concept has 752.Em automatic margins 753(an automatic return and linefeed 754when the end of a line is reached) is indicated by the Boolean capability 755.Sy \&am . 756Hence the description of the Concept includes 757.Sy \&am . 758.Pp 759Numeric capabilities are followed by the character `#' then the value. 760In the example above 761.Sy \&co , 762which indicates the number of columns the display has, 763gives the value `80' for the Concept. 764.Pp 765Finally, string-valued capabilities, such as 766.Sy \&ce 767(clear-to-end-of-line 768sequence) are given by the two-letter code, an `=', then a string 769ending at the next following `:'. 770A delay in milliseconds may appear after 771the `=' in such a capability, 772which causes padding characters to be supplied by 773.Xr tputs 774after the remainder of the string is sent to provide this delay. 775The delay can be either a number, 776such as `20', or a number followed by 777an `*', 778such as `3*'. 779An `*' indicates that the padding required is proportional 780to the number of lines affected by the operation, and the amount given is 781the per-affected-line padding required. 782(In the case of insert-character, 783the factor is still the number of 784.Em lines 785affected; 786this is always 1 unless the terminal has 787.Sy \&in 788and the software uses it.) 789When an `*' is specified, it is sometimes useful to give a delay of the form 790`3.5' to specify a delay per line to tenths of milliseconds. 791(Only one decimal place is allowed.) 792.Pp 793A number of escape sequences are provided in the string-valued capabilities 794for easy encoding of control characters there. 795.Sy \&\eE 796maps to an 797.Dv ESC 798character, 799.Sy \&^X 800maps to a control-X for any appropriate X, 801and the sequences 802.Sy \&\en 803.Sy \&\er 804.Sy \&\et 805.Sy \&\eb 806.Sy \&\ef 807map to linefeed, return, tab, backspace, and formfeed, respectively. 808Finally, characters may be given as three octal digits after a 809.Sy \&\e , 810and the characters 811.Sy \&^ 812and 813.Sy \&\e 814may be given as 815.Sy \&\e^ 816and 817.Sy \&\e\e . 818If it is necessary to place a 819.Sy \&: 820in a capability it must be escaped in 821octal as 822.Sy \&\e072 . 823If it is necessary to place a 824.Dv NUL 825character in a string capability it 826must be encoded as 827.Sy \&\e200 . 828(The routines that deal with 829.Nm 830use C strings and strip the high bits of the output very late, so that 831a 832.Sy \&\e200 833comes out as a 834.Sy \&\e000 835would.) 836.Pp 837Sometimes individual capabilities must be commented out. 838To do this, put a period before the capability name. 839For example, see the first 840.Sy \&cr 841and 842.Sy \&ta 843in the example above. 844.Ss Preparing Descriptions 845The most effective way to prepare a terminal description is by imitating 846the description of a similar terminal in 847.Nm 848and to build up a description gradually, using partial descriptions 849with 850.Xr \&vi 851to check that they are correct. 852Be aware that a very unusual terminal may expose deficiencies in 853the ability of the 854.Nm 855file to describe it 856or bugs in 857.Xr \&vi . 858To easily test a new terminal description you are working on 859you can put it in your home directory in a file called 860.Pa .termcap 861and programs will look there before looking in 862.Pa /usr/share/misc/termcap . 863You can also set the environment variable 864.Ev TERMPATH 865to a list of absolute file pathnames (separated by spaces or colons), 866one of which contains the description you are working on, 867and programs will search them in the order listed, and nowhere else. 868See 869.Xr termcap 3 . 870The 871.Ev TERMCAP 872environment variable is usually set to the 873.Nm 874entry itself 875to avoid reading files when starting up a program. 876.Pp 877To get the padding for insert-line right 878(if the terminal manufacturer did not document it), 879a severe test is to use 880.Xr \&vi 881to edit 882.Pa /etc/passwd 883at 9600 baud, delete roughly 16 lines from the middle of the screen, 884then hit the `u' key several times quickly. 885If the display messes up, more padding is usually needed. 886A similar test can be used for insert-character. 887.Ss Basic Capabilities 888The number of columns on each line of the display is given by the 889.Sy \&co 890numeric capability. 891If the display is a 892.Tn CRT , 893then the 894number of lines on the screen is given by the 895.Sy \&li 896capability. 897If the display wraps around to the beginning of the next line when 898the cursor reaches the right margin, then it should have the 899.Sy \&am 900capability. 901If the terminal can clear its screen, 902the code to do this is given by the 903.Sy \&cl 904string capability. 905If the terminal overstrikes 906(rather than clearing the position when a character is overwritten), 907it should have the 908.Sy \&os 909capability. 910If the terminal is a printing terminal, 911with no soft copy unit, 912give it both 913.Sy \&hc 914and 915.Sy \&os . 916.Pf ( Sy \&os 917applies to storage scope terminals, 918such as the Tektronix 4010 series, 919as well as to hard copy and 920.Tn APL 921terminals.) 922If there is a code to move the cursor to the left edge of the current row, 923give this as 924.Sy \&cr . 925(Normally this will be carriage-return, 926.Sy \&^M . ) 927If there is a code to produce an audible signal (bell, beep, 928etc.), 929give this as 930.Sy \&bl . 931.Pp 932If there is a code (such as backspace) 933to move the cursor one position to the left, 934that capability should be given as 935.Sy \&le . 936Similarly, 937codes to move to the right, up, and down 938should be given as 939.Sy \&nd , 940.Sy \&up , 941and 942.Sy \&do , 943respectively. 944These 945.Em local cursor motions 946should not alter the text they pass over; 947for example, you would not normally use 948.Dq nd=\ \& 949unless the terminal has the 950.Sy \&os 951capability, 952because the space would erase the character moved over. 953.Pp 954A very important point here is that the local cursor motions encoded 955in 956.Nm 957have undefined behavior at the left and top edges of a 958.Tn CRT 959display. 960Programs should never attempt to backspace around the left edge, 961unless 962.Sy \&bw 963is given, and never attempt to go up off the top 964using local cursor motions. 965.Pp 966In order to scroll text up, 967a program goes to the bottom left corner of the screen and sends the 968.Sy \&sf 969(index) string. 970To scroll text down, 971a program goes to the top left corner of the screen and sends the 972.Sy \&sr 973(reverse index) string. 974The strings 975.Sy \&sf 976and 977.Sy \&sr 978have undefined behavior 979when not on their respective corners of the screen. 980Parameterized versions of the scrolling sequences are 981.Sy \&SF 982and 983.Sy \&SR , 984which have the same semantics as 985.Sy \&sf 986and 987.Sy \&sr 988except that they take one parameter 989and scroll that many lines. 990They also have undefined behavior 991except at the appropriate corner of the screen. 992.Pp 993The 994.Sy \&am 995capability tells whether the cursor sticks at the right 996edge of the screen when text is output there, 997but this does not necessarily apply to 998.Sy \&nd 999from the last column. 1000Leftward local motion is defined from the left edge only when 1001.Sy \&bw 1002is given; then an 1003.Sy \&le 1004from the left edge will move to the right edge of the previous row. 1005This is useful for drawing a box around the edge of the screen, 1006for example. 1007If the terminal has switch-selectable automatic margins, 1008the 1009.Nm 1010description usually assumes that this feature is on, 1011.Em i.e . , 1012.Sy \&am . 1013If the terminal has a command 1014that moves to the first column of the next line, 1015that command can be given as 1016.Sy \&nw 1017(newline). 1018It is permissible for this to clear the remainder of the current line, 1019so if the terminal has no correctly-working 1020.Tn \&CR 1021and 1022.Tn \&LF 1023it may still be possible to craft a working 1024.Sy \&nw 1025out of one or both of them. 1026.Pp 1027These capabilities suffice to describe hardcopy and 1028.Dq glass-tty 1029terminals. 1030Thus the Teletype model 33 is described as 1031.Bd -literal -offset indent 1032T3\||\|tty33\||\|33\||\|tty\||\|Teletype model 33:\e 1033 :bl=^G:co#72:cr=^M:do=^J:hc:os: 1034.Ed 1035.Pp 1036and the Lear Siegler 1037.Tn ADM Ns \-3 1038is described as 1039.Bd -literal -offset indent 1040l3\||\|adm3\||\|3\||\|LSI \s-1ADM\s0-3:\e 1041:am:bl=^G:cl=^Z:co#80:cr=^M:do=^J:le=^H:li#24:sf=^J: 1042.Ed 1043.Ss Parameterized Strings 1044Cursor addressing and other strings requiring parameters 1045are described by a 1046parameterized string capability, with 1047.Xr printf 3 Ns \-like 1048escapes 1049.Sy \&%x 1050in it, 1051while other characters are passed through unchanged. 1052For example, to address the cursor the 1053.Sy \&cm 1054capability is given, using two parameters: the row and column to move to. 1055(Rows and columns are numbered from zero and refer to the physical screen 1056visible to the user, not to any unseen memory. 1057If the terminal has memory-relative cursor addressing, 1058that can be indicated by an analogous 1059.Sy \&CM 1060capability.) 1061.Pp 1062The 1063.Sy \&% 1064encodings have the following meanings: 1065.Bl -column xxxxx 1066.It "%% output `%'" 1067.It "%d output value as in" 1068.Xr printf 1069%d 1070.It "%2 output value as in" 1071.Xr printf 1072%2d 1073.It "%3 output value as in" 1074.Xr printf 1075%3d 1076.It "%. output value as in" 1077.Xr printf 1078%c 1079.It "%+" Ns Em x Ta No add 1080.Em x 1081to value, then do %. 1082.It "%>" Ns Em \&xy Ta No if 1083value > 1084.Em x 1085then add 1086.Em y , 1087no output 1088.It "%r reverse order of two parameters, no output" 1089.It "%i increment by one, no output" 1090.It "%n exclusive-or all parameters with 0140 (Datamedia 2500)" 1091.It "\&%B" Ta Tn BCD No "(16*(value/10)) + (value%10), no output" 1092.It "%D Reverse coding (value \- 2*(value%16)), no output (Delta Data)." 1093.El 1094.Pp 1095Consider the Hewlett-Packard 2645, which, to get to row 3 and column 12, needs 1096to be sent 1097.Dq \eE&a12c03Y 1098padded for 6 milliseconds. 1099Note that the order 1100of the row and column coordinates is reversed here 1101and that the row and column 1102are sent as two-digit integers. 1103Thus its 1104.Sy \&cm 1105capability is 1106.Dq Li cm=6\eE&%r%2c%2Y . 1107.Pp 1108The Datamedia 2500 needs the current row and column sent 1109encoded in binary using 1110.Dq \&%. . 1111Terminals that use 1112.Dq %.\& 1113need to be able to 1114backspace the cursor 1115.Pq Sy \&le 1116and to move the cursor up one line on the screen 1117.Pq Sy \&up . 1118This is necessary because it is not always safe to transmit 1119.Sy \&\en , 1120.Sy \&^D , 1121and 1122.Sy \&\er , 1123as the system may change or discard them. 1124(Programs using 1125.Nm 1126must set terminal modes so that tabs are not expanded, so 1127.Sy \&\et 1128is safe to send. 1129This turns out to be essential for the Ann Arbor 4080.) 1130.Pp 1131A final example is the Lear Siegler 1132.Tn ADM Ns \-3a , 1133which offsets row and column 1134by a blank character, thus 1135.Dq Li cm=\eE=%+ %+\ \& . 1136.Pp 1137Row or column absolute cursor addressing 1138can be given as single parameter capabilities 1139.Sy \&ch 1140(horizontal position absolute) and 1141.Sy \&cv 1142(vertical position absolute). 1143Sometimes these are shorter than the more general two-parameter sequence 1144(as with the Hewlett-Packard 2645) and can be used in preference to 1145.Sy \&cm . 1146If there are parameterized local motions 1147.Pf ( Em e.g . , 1148move 1149.Ar n 1150positions to the right) 1151these can be given as 1152.Sy \&DO , 1153.Sy \&LE , 1154.Sy \&RI , 1155and 1156.Sy \&UP 1157with a single parameter indicating how many positions to move. 1158These are primarily useful if the terminal does not have 1159.Sy \&cm , 1160such as the Tektronix 4025. 1161.Ss Cursor Motions 1162.Pp 1163If the terminal has a fast way to home the cursor 1164(to the very upper left corner of the screen), this can be given as 1165.Sy \&ho . 1166Similarly, a fast way of getting to the lower left-hand corner 1167can be given as 1168.Sy \&ll ; 1169this may involve going up with 1170.Sy \&up 1171from the home position, 1172but a program should never do this itself (unless 1173.Sy \&ll 1174does), because it can 1175make no assumption about the effect of moving up from the home position. 1176Note that the home position is the same as 1177cursor address (0,0): to the top left corner of the screen, not of memory. 1178(Therefore, the 1179.Dq \eEH 1180sequence on Hewlett-Packard terminals 1181cannot be used for 1182.Sy \&ho . ) 1183.Ss Area Clears 1184If the terminal can clear from the current position to the end of the 1185line, leaving the cursor where it is, this should be given as 1186.Sy \&ce . 1187If the terminal can clear from the current position to the end of the 1188display, this should be given as 1189.Sy \&cd . 1190.Sy \&cd 1191must only be invoked from the first column of a line. 1192(Therefore, 1193it can be simulated by a request to delete a large number of lines, 1194if a true 1195.Sy \&cd 1196is not available.) 1197.Ss Insert/Delete Line 1198If the terminal can open a new blank line 1199before the line containing the cursor, 1200this should be given as 1201.Sy \&al ; 1202this must be invoked only from the first 1203position of a line. 1204The cursor must then appear at the left of the newly blank line. 1205If the terminal can delete the line that the cursor is on, this 1206should be given as 1207.Sy \&dl ; 1208this must only be used from the first position on 1209the line to be deleted. 1210Versions of 1211.Sy \&al 1212and 1213.Sy \&dl 1214which take a single parameter 1215and insert or delete that many lines 1216can be given as 1217.Sy \&AL 1218and 1219.Sy \&DL . 1220If the terminal has a settable scrolling region 1221(like the VT100), 1222the command to set this can be described with the 1223.Sy \&cs 1224capability, 1225which takes two parameters: the top and bottom lines of the scrolling region. 1226The cursor position is, alas, undefined after using this command. 1227It is possible to get the effect of insert or delete line 1228using this command \(em the 1229.Sy \&sc 1230and 1231.Sy \&rc 1232(save and restore cursor) commands are also useful. 1233Inserting lines at the top or bottom of the screen can also be done using 1234.Sy \&sr 1235or 1236.Sy \&sf 1237on many terminals without a true insert/delete line, 1238and is often faster even on terminals with those features. 1239.Pp 1240If the terminal has the ability to define a window as part of memory 1241which all commands affect, it should be given as the parameterized string 1242.Sy \&wi . 1243The four parameters are the starting and ending lines in memory 1244and the starting and ending columns in memory, in that order. 1245(This 1246.Xr terminfo 5 1247capability is described for completeness. 1248It is unlikely that any 1249.Nm Ns \-using 1250program will support it.) 1251.Pp 1252If the terminal can retain display memory above the screen, then the 1253.Sy \&da 1254capability should be given; 1255if display memory can be retained 1256below, then 1257.Sy \&db 1258should be given. 1259These indicate 1260that deleting a line or scrolling may bring non-blank lines up from below 1261or that scrolling back with 1262.Sy \&sr 1263may bring down non-blank lines. 1264.Ss Insert/Delete Character 1265There are two basic kinds of intelligent terminals with respect to 1266insert/delete character that can be described using 1267.Nm . 1268The most common insert/delete character operations affect only the characters 1269on the current line and shift characters off the end of the line rigidly. 1270Other terminals, such as the Concept\-100 and the Perkin Elmer Owl, make 1271a distinction between typed and untyped blanks on the screen, shifting 1272upon an insert or delete only to an untyped blank on the screen which is 1273either eliminated or expanded to two untyped blanks. 1274You can determine 1275the kind of terminal you have by clearing the screen then typing 1276text separated by cursor motions. 1277Type 1278.Dq Li abc\ \ \ \ def 1279using local 1280cursor motions (not spaces) between the 1281.Dq abc 1282and the 1283.Dq def . 1284Then position the cursor before the 1285.Dq abc 1286and put the terminal in insert 1287mode. 1288If typing characters causes the rest of the line to shift 1289rigidly and characters to fall off the end, then your terminal does 1290not distinguish between blanks and untyped positions. 1291If the 1292.Dq abc 1293shifts over to the 1294.Dq def 1295which then move together around the end of the 1296current line and onto the next as you insert, then you have the second type of 1297terminal and should give the capability 1298.Sy \&in , 1299which stands for 1300.Dq insert null . 1301While these are two logically separate attributes 1302(one line 1303.Em \&vs . 1304multi-line insert mode, 1305and special treatment of untyped spaces), 1306we have seen no terminals whose insert 1307mode cannot be described with the single attribute. 1308.Pp 1309The 1310.Nm 1311entries can describe both terminals that have an insert mode and terminals 1312that send a simple sequence to open a blank position on the current line. 1313Give as 1314.Sy \&im 1315the sequence to get into insert mode. 1316Give as 1317.Sy \&ei 1318the sequence to leave insert mode. 1319Now give as 1320.Sy \&ic 1321any sequence that needs to be sent just before 1322each character to be inserted. 1323Most terminals with a true insert mode 1324will not give 1325.Sy \&ic ; 1326terminals that use a sequence to open a screen 1327position should give it here. 1328(If your terminal has both, 1329insert mode is usually preferable to 1330.Sy \&ic . 1331Do not give both unless the terminal actually requires both to be used 1332in combination.) 1333If post-insert padding is needed, give this as a number of milliseconds 1334in 1335.Sy \&ip 1336(a string option). 1337Any other sequence that may need to be 1338sent after insertion of a single character can also be given in 1339.Sy \&ip . 1340If your terminal needs to be placed into an `insert mode' 1341and needs a special code preceding each inserted character, 1342then both 1343.Sy \&im Ns / Sy \&ei 1344and 1345.Sy \&ic 1346can be given, and both will be used. 1347The 1348.Sy \&IC 1349capability, with one parameter 1350.Em n , 1351will repeat the effects of 1352.Sy \&ic 1353.Em n 1354times. 1355.Pp 1356It is occasionally necessary to move around while in insert mode 1357to delete characters on the same line 1358.Pf ( Em e.g . , 1359if there is a tab after 1360the insertion position). 1361If your terminal allows motion while in 1362insert mode, you can give the capability 1363.Sy \&mi 1364to speed up inserting 1365in this case. 1366Omitting 1367.Sy \&mi 1368will affect only speed. 1369Some terminals 1370(notably Datamedia's) must not have 1371.Sy \&mi 1372because of the way their 1373insert mode works. 1374.Pp 1375Finally, you can specify 1376.Sy \&dc 1377to delete a single character, 1378.Sy \&DC 1379with one parameter 1380.Em n 1381to delete 1382.Em n 1383characters, 1384and delete mode by giving 1385.Sy \&dm 1386and 1387.Sy \&ed 1388to enter and exit delete mode 1389(which is any mode the terminal needs to be placed in for 1390.Sy \&dc 1391to work). 1392.Ss Highlighting, Underlining, and Visible Bells 1393If your terminal has one or more kinds of display attributes, 1394these can be represented in a number of different ways. 1395You should choose one display form as 1396.Em standout mode , 1397representing a good high-contrast, easy-on-the-eyes format 1398for highlighting error messages and other attention getters. 1399(If you have a choice, reverse video plus half-bright is good, 1400or reverse video alone.) 1401The sequences to enter and exit standout mode 1402are given as 1403.Sy \&so 1404and 1405.Sy \&se , 1406respectively. 1407If the code to change into or out of standout 1408mode leaves one or even two blank spaces or garbage characters on the screen, 1409as the 1410.Tn TVI 1411912 and Teleray 1061 do, 1412then 1413.Sy \&sg 1414should be given to tell how many characters are left. 1415.Pp 1416Codes to begin underlining and end underlining can be given as 1417.Sy \&us 1418and 1419.Sy \&ue , 1420respectively. 1421Underline mode change garbage is specified by 1422.Sy \&ug , 1423similar to 1424.Sy \&sg . 1425If the terminal has a code to underline the current character and move 1426the cursor one position to the right, 1427such as the Microterm Mime, 1428this can be given as 1429.Sy \&uc . 1430.Pp 1431Other capabilities to enter various highlighting modes include 1432.Sy \&mb 1433(blinking), 1434.Sy \&md 1435(bold or extra bright), 1436.Sy \&mh 1437(dim or half-bright), 1438.Sy \&mk 1439(blanking or invisible text), 1440.Sy \&mp 1441(protected), 1442.Sy \&mr 1443(reverse video), 1444.Sy \&me 1445(turn off 1446.Em all 1447attribute modes), 1448.Sy \&as 1449(enter alternate character set mode), and 1450.Sy \&ae 1451(exit alternate character set mode). 1452Turning on any of these modes singly may or may not turn off other modes. 1453.Pp 1454If there is a sequence to set arbitrary combinations of mode, 1455this should be given as 1456.Sy \&sa 1457(set attributes), taking 9 parameters. 1458Each parameter is either 0 or 1, 1459as the corresponding attributes is on or off. 1460The 9 parameters are, in order: standout, underline, reverse, blink, 1461dim, bold, blank, protect, and alternate character set. 1462Not all modes need be supported by 1463.Sy \&sa , 1464only those for which corresponding attribute commands exist. 1465(It is unlikely that a 1466.Nm Ns \-using 1467program will support this capability, which is defined for compatibility 1468with 1469.Xr terminfo 5 . ) 1470.Pp 1471Terminals with the 1472.Dq magic cookie 1473glitches 1474.Pf ( Sy \&sg 1475and 1476.Sy \&ug ) , 1477rather than maintaining extra attribute bits for each character cell, 1478instead deposit special 1479.Dq cookies , 1480or 1481.Dq garbage characters , 1482when they receive mode-setting sequences, 1483which affect the display algorithm. 1484.Pp 1485Some terminals, 1486such as the Hewlett-Packard 2621, 1487automatically leave standout 1488mode when they move to a new line or when the cursor is addressed. 1489Programs using standout mode 1490should exit standout mode on such terminals 1491before moving the cursor or sending a newline. 1492On terminals where this is not a problem, 1493the 1494.Sy \&ms 1495capability should be present 1496to say that this overhead is unnecessary. 1497.Pp 1498If the terminal has 1499a way of flashing the screen to indicate an error quietly 1500(a bell replacement), 1501this can be given as 1502.Sy \&vb ; 1503it must not move the cursor. 1504.Pp 1505If the cursor needs to be made more visible than normal 1506when it is not on the bottom line 1507(to change, for example, a non-blinking underline into an easier-to-find 1508block or blinking underline), 1509give this sequence as 1510.Sy \&vs . 1511If there is a way to make the cursor completely invisible, give that as 1512.Sy \&vi . 1513The capability 1514.Sy \&ve , 1515which undoes the effects of both of these modes, 1516should also be given. 1517.Pp 1518If your terminal correctly displays underlined characters 1519(with no special codes needed) 1520even though it does not overstrike, 1521then you should give the capability 1522.Sy \&ul . 1523If overstrikes are erasable with a blank, 1524this should be indicated by giving 1525.Sy \&eo . 1526.Ss Keypad 1527If the terminal has a keypad that transmits codes when the keys are pressed, 1528this information can be given. 1529Note that it is not possible to handle 1530terminals where the keypad only works in local mode 1531(this applies, for example, to the unshifted Hewlett-Packard 2621 keys). 1532If the keypad can be set to transmit or not transmit, 1533give these codes as 1534.Sy \&ks 1535and 1536.Sy \&ke . 1537Otherwise the keypad is assumed to always transmit. 1538The codes sent by the left-arrow, right-arrow, up-arrow, down-arrow, 1539and home keys can be given as 1540.Sy \&kl , 1541.Sy \&kr , 1542.Sy \&ku , 1543.Sy \&kd , 1544and 1545.Sy \&kh , 1546respectively. 1547If there are function keys such as f0, f1, ..., f9, the codes they send 1548can be given as 1549.Sy \&k0 , 1550.Sy \&k1 , 1551\&..., 1552.Sy \&k9 . 1553If these keys have labels other than the default f0 through f9, the labels 1554can be given as 1555.Sy \&l0 , 1556.Sy \&l1 , 1557\&..., 1558.Sy \&l9 . 1559The codes transmitted by certain other special keys can be given: 1560.Sy \&kH 1561(home down), 1562.Sy \&kb 1563(backspace), 1564.Sy \&ka 1565(clear all tabs), 1566.Sy \&kt 1567(clear the tab stop in this column), 1568.Sy \&kC 1569(clear screen or erase), 1570.Sy \&kD 1571(delete character), 1572.Sy \&kL 1573(delete line), 1574.Sy \&kM 1575(exit insert mode), 1576.Sy \&kE 1577(clear to end of line), 1578.Sy \&kS 1579(clear to end of screen), 1580.Sy \&kI 1581(insert character or enter insert mode), 1582.Sy \&kA 1583(insert line), 1584.Sy \&kN 1585(next page), 1586.Sy \&kP 1587(previous page), 1588.Sy \&kF 1589(scroll forward/down), 1590.Sy \&kR 1591(scroll backward/up), and 1592.Sy \&kT 1593(set a tab stop in this column). 1594In addition, if the keypad has a 3 by 3 array of keys 1595including the four arrow keys, then the other five keys can be given as 1596.Sy \&K1 , 1597.Sy \&K2 , 1598.Sy \&K3 , 1599.Sy \&K4 , 1600and 1601.Sy \&K5 . 1602These keys are useful when the effects of a 3 by 3 directional pad are needed. 1603The obsolete 1604.Sy \&ko 1605capability formerly used to describe 1606.Dq other 1607function keys has been 1608completely supplanted by the above capabilities. 1609.Pp 1610The 1611.Sy \&ma 1612entry is also used to indicate arrow keys on terminals that have 1613single-character arrow keys. 1614It is obsolete but still in use in 1615version 2 of 1616.Sy \&vi 1617which must be run on some minicomputers due to 1618memory limitations. 1619This field is redundant with 1620.Sy \&kl , 1621.Sy \&kr , 1622.Sy \&ku , 1623.Sy \&kd , 1624and 1625.Sy \&kh . 1626It consists of groups of two characters. 1627In each group, the first character is what an arrow key sends, and the 1628second character is the corresponding 1629.Sy \&vi 1630command. 1631These commands are 1632.Ar h 1633for 1634.Sy \&kl , 1635.Ar j 1636for 1637.Sy \&kd , 1638.Ar k 1639for 1640.Sy \&ku , 1641.Ar l 1642for 1643.Sy \&kr , 1644and 1645.Ar H 1646for 1647.Sy \&kh . 1648For example, the Mime would have 1649.Dq Li ma=^Hh^Kj^Zk^Xl 1650indicating arrow keys left (^H), down (^K), up (^Z), and right (^X). 1651(There is no home key on the Mime.) 1652.Ss Tabs and Initialization 1653If the terminal needs to be in a special mode when running 1654a program that uses these capabilities, 1655the codes to enter and exit this mode can be given as 1656.Sy \&ti 1657and 1658.Sy \&te . 1659This arises, for example, from terminals like the Concept with more than 1660one page of memory. 1661If the terminal has only memory-relative cursor addressing and not 1662screen-relative cursor addressing, 1663a screen-sized window must be fixed into 1664the display for cursor addressing to work properly. 1665This is also used for the Tektronix 4025, where 1666.Sy \&ti 1667sets the command character to be the one used by 1668.Nm . 1669.Pp 1670Other capabilities 1671include 1672.Sy \&is , 1673an initialization string for the terminal, 1674and 1675.Sy \&if , 1676the name of a file containing long initialization strings. 1677These strings are expected to set the terminal into modes 1678consistent with the rest of the 1679.Nm 1680description. 1681They are normally sent to the terminal by the 1682.Xr tset 1683program each time the user logs in. 1684They will be printed in the following order: 1685.Sy \&is ; 1686setting tabs using 1687.Sy \&ct 1688and 1689.Sy \&st ; 1690and finally 1691.Sy \&if . 1692.Pf ( Xr Terminfo 1693uses 1694.Sy \&i\&1-i2 1695instead of 1696.Sy \&is 1697and runs the program 1698.Sy \&iP 1699and prints 1700.Sy "\&i\&3" 1701after the other initializations.) 1702A pair of sequences that does a harder reset from a totally unknown state 1703can be analogously given as 1704.Sy \&rs 1705and 1706.Sy \&if . 1707These strings are output by the 1708.Xr reset 1709program, which is used when the terminal gets into a wedged state. 1710.Pf ( Xr Terminfo 1711uses 1712.Sy "\&r1-r3" 1713instead of 1714.Sy \&rs . ) 1715Commands are normally placed in 1716.Sy \&rs 1717and 1718.Sy \&rf 1719only if they produce annoying effects on the screen and are not necessary 1720when logging in. 1721For example, the command to set the VT100 into 80-column mode 1722would normally be part of 1723.Sy \&is , 1724but it causes an annoying glitch of the screen and is not normally needed 1725since the terminal is usually already in 80-column mode. 1726.Pp 1727If the terminal has hardware tabs, 1728the command to advance to the next tab stop can be given as 1729.Sy \&ta 1730(usually 1731.Sy \&^I ) . 1732A 1733.Dq backtab 1734command which moves leftward to the previous tab stop 1735can be given as 1736.Sy \&bt . 1737By convention, 1738if the terminal driver modes indicate that tab stops are being expanded 1739by the computer rather than being sent to the terminal, 1740programs should not use 1741.Sy \&ta 1742or 1743.Sy \&bt 1744even if they are present, 1745since the user may not have the tab stops properly set. 1746If the terminal has hardware tabs that are initially set every 1747.Ar n 1748positions when the terminal is powered up, then the numeric parameter 1749.Sy \&it 1750is given, showing the number of positions between tab stops. 1751This is normally used by the 1752.Xr tset 1753command to determine whether to set the driver mode for hardware tab 1754expansion, and whether to set the tab stops. 1755If the terminal has tab stops that can be saved in nonvolatile memory, the 1756.Nm 1757description can assume that they are properly set. 1758.Pp 1759If there are commands to set and clear tab stops, they can be given as 1760.Sy \&ct 1761(clear all tab stops) and 1762.Sy \&st 1763(set a tab stop in the current column of every row). 1764If a more complex sequence is needed to set the tabs than can be 1765described by this, the sequence can be placed in 1766.Sy \&is 1767or 1768.Sy \&if . 1769.Ss Delays 1770Certain capabilities control padding in the terminal driver. 1771These are primarily needed by hardcopy terminals and are used by the 1772.Xr tset 1773program to set terminal driver modes appropriately. 1774Delays embedded in the capabilities 1775.Sy \&cr , 1776.Sy \&sf , 1777.Sy \&le , 1778.Sy \&ff , 1779and 1780.Sy \&ta 1781will cause the appropriate delay bits to be set in the terminal driver. 1782If 1783.Sy \&pb 1784(padding baud rate) is given, these values can be ignored at baud rates 1785below the value of 1786.Sy \&pb . 1787For 1788.Bx 4.2 1789.Xr tset , 1790the delays are given as numeric capabilities 1791.Sy \&dC , 1792.Sy \&dN , 1793.Sy \&dB , 1794.Sy \&dF , 1795and 1796.Sy \&dT 1797instead. 1798.Ss Miscellaneous 1799If the terminal requires other than a 1800.Dv NUL 1801(zero) character as a pad, 1802this can be given as 1803.Sy \&pc . 1804Only the first character of the 1805.Sy \&pc 1806string is used. 1807.Pp 1808If the terminal has commands to save and restore the position of the 1809cursor, give them as 1810.Sy \&sc 1811and 1812.Sy \&rc . 1813.Pp 1814If the terminal has an extra 1815.Dq status line 1816that is not normally used by 1817software, this fact can be indicated. 1818If the status line is viewed as an extra line below the bottom line, 1819then the capability 1820.Sy \&hs 1821should be given. 1822Special strings to go to a position in the status line and to return 1823from the status line can be given as 1824.Sy \&ts 1825and 1826.Sy \&fs . 1827.Pf ( Xr \&fs 1828must leave the cursor position in the same place that it was before 1829.Sy \&ts . 1830If necessary, the 1831.Sy \&sc 1832and 1833.Sy \&rc 1834strings can be included in 1835.Sy \&ts 1836and 1837.Sy \&fs 1838to get this effect.) 1839The capability 1840.Sy \&ts 1841takes one parameter, which is the column number of the status line 1842to which the cursor is to be moved. 1843If escape sequences and other special commands such as tab work while in 1844the status line, the flag 1845.Sy \&es 1846can be given. 1847A string that turns off the status line (or otherwise erases its contents) 1848should be given as 1849.Sy \&ds . 1850The status line is normally assumed to be the same width as the 1851rest of the screen, 1852.Em i.e . , 1853.Sy \&co . 1854If the status line is a different width (possibly because the terminal 1855does not allow an entire line to be loaded), then its width in columns 1856can be indicated with the numeric parameter 1857.Sy \&ws . 1858.Pp 1859If the terminal can move up or down half a line, this can be 1860indicated with 1861.Sy \&hu 1862(half-line up) and 1863.Sy \&hd 1864(half-line down). 1865This is primarily useful for superscripts and subscripts on hardcopy 1866terminals. 1867If a hardcopy terminal can eject to the next page (form feed), 1868give this as 1869.Sy \&ff 1870(usually 1871.Sy \&^L ) . 1872.Pp 1873If there is a command to repeat a given character a given number of times 1874(to save time transmitting a large number of identical characters), 1875this can be indicated with the parameterized string 1876.Sy \&rp . 1877The first parameter is the character to be repeated and the second is 1878the number of times to repeat it. 1879(This is a 1880.Xr terminfo 5 1881feature that is unlikely to be supported by a program that uses 1882.Nm . ) 1883.Pp 1884If the terminal has a settable command character, such as the 1885Tektronix 4025, this can be indicated with 1886.Sy \&CC . 1887A prototype command character is chosen which is used in all capabilities. 1888This character is given in the 1889.Sy \&CC 1890capability to identify it. 1891The following convention is supported on some 1892.Ux 1893systems: 1894The environment is to be searched for a 1895.Ev \&CC 1896variable, 1897and if found, 1898all occurrences of the prototype character are replaced by the character 1899in the environment variable. 1900This use of the 1901.Ev \&CC 1902environment variable 1903is a very bad idea, as it conflicts with 1904.Xr make 1 . 1905.Pp 1906Terminal descriptions that do not represent a specific kind of known 1907terminal, such as 1908.Em switch , 1909.Em dialup , 1910.Em patch , 1911and 1912.Xr network , 1913should include the 1914.Sy \&gn 1915(generic) capability so that programs can complain that they do not know 1916how to talk to the terminal. 1917(This capability does not apply to 1918.Em virtual 1919terminal descriptions for which the escape sequences are known.) 1920.Pp 1921If the terminal uses xoff/xon 1922.Pq Tn DC3 Ns / Ns Tn DC1 1923handshaking for flow control, give 1924.Sy \&xo . 1925Padding information should still be included so that routines can make 1926better decisions about costs, but actual pad characters will not be 1927transmitted. 1928.Pp 1929If the terminal has a 1930.Dq meta key 1931which acts as a shift key, setting the 19328th bit of any character transmitted, then this fact can be indicated with 1933.Sy \&km . 1934Otherwise, software will assume that the 8th bit is parity and it will 1935usually be cleared. 1936If strings exist to turn this 1937.Dq meta mode 1938on and off, they can be given as 1939.Sy \&mm 1940and 1941.Sy \&mo . 1942.Pp 1943If the terminal has more lines of memory than will fit on the screen at once, 1944the number of lines of memory can be indicated with 1945.Sy \&lm . 1946An explicit value of 0 indicates that the number of lines is not fixed, 1947but that there is still more memory than fits on the screen. 1948.Pp 1949If the terminal is one of those supported by the 1950.Ux 1951system virtual 1952terminal protocol, the terminal number can be given as 1953.Sy \&vt . 1954.Pp 1955Media copy strings which control an auxiliary printer 1956connected to the terminal can be given as 1957.Sy \&ps : 1958print the contents of the screen; 1959.Sy \&pf : 1960turn off the printer; and 1961.Sy \&po : 1962turn on the printer. 1963When the printer is on, all text sent to the terminal will be sent to the 1964printer. 1965It is undefined whether the text is also displayed on the terminal screen 1966when the printer is on. 1967A variation 1968.Sy \&pO 1969takes one parameter and leaves the printer on for as many characters as the 1970value of the parameter, then turns the printer off. 1971The parameter should not exceed 255. 1972All text, including 1973.Sy \&pf , 1974is transparently passed to the printer while 1975.Sy \&pO 1976is in effect. 1977.Pp 1978Strings to program function keys can be given as 1979.Sy \&pk , 1980.Sy \&pl , 1981and 1982.Sy \&px . 1983Each of these strings takes two parameters: the function key number 1984to program (from 0 to 9) and the string to program it with. 1985Function key numbers out of this range may program undefined keys 1986in a terminal-dependent manner. 1987The differences among the capabilities are that 1988.Sy \&pk 1989causes pressing the given key to be the same as the user typing the given 1990string; 1991.Sy \&pl 1992causes the string to be executed by the terminal in local mode; 1993and 1994.Sy \&px 1995causes the string to be transmitted to the computer. 1996Unfortunately, due to lack of a definition for string parameters in 1997.Nm , 1998only 1999.Xr terminfo 5 2000supports these capabilities. 2001.Ss Glitches and Braindamage 2002Hazeltine terminals, which do not allow `~' characters to be displayed, 2003should indicate 2004.Sy \&hz . 2005.Pp 2006The 2007.Sy \&nc 2008capability, now obsolete, formerly indicated Datamedia terminals, 2009which echo 2010.Sy \&\er \en 2011for 2012carriage return then ignore a following linefeed. 2013.Pp 2014Terminals that ignore a linefeed immediately after an 2015.Sy \&am 2016wrap, such as the Concept, should indicate 2017.Sy \&xn . 2018.Pp 2019If 2020.Sy \&ce 2021is required to get rid of standout 2022(instead of merely writing normal text on top of it), 2023.Sy \&xs 2024should be given. 2025.Pp 2026Teleray terminals, where tabs turn all characters moved over to blanks, 2027should indicate 2028.Sy \&xt 2029(destructive tabs). 2030This glitch is also taken to mean that it is not possible 2031to position the cursor on top of a 2032.Dq magic cookie , 2033and that 2034to erase standout mode it is necessary to use delete and insert line. 2035.Pp 2036The Beehive Superbee, which is unable to correctly transmit the 2037.Dv ESC 2038or 2039.Sy \&^C 2040characters, has 2041.Sy \&xb , 2042indicating that the 2043.Dq \&f\&1 2044key is used for 2045.Dv ESC 2046and 2047.Dq \&f\&2 2048for ^C. 2049(Only certain Superbees have this problem, depending on the 2050.Tn ROM . ) 2051.Pp 2052Other specific terminal problems may be corrected by adding more 2053capabilities of the form 2054.Sy x Em x . 2055.Ss Similar Terminals 2056If there are two very similar terminals, 2057one can be defined as being just like the other with certain exceptions. 2058The string capability 2059.Sy \&tc 2060can be given 2061with the name of the similar terminal. 2062This capability must be 2063.Em last , 2064and the combined length of the entries 2065must not exceed 1024. 2066The capabilities given before 2067.Sy \&tc 2068override those in the terminal type invoked by 2069.Sy \&tc . 2070A capability can be canceled by placing 2071.Sy \&xx@ 2072to the left of the 2073.Sy \&tc 2074invocation, where 2075.Sy \&xx 2076is the capability. 2077For example, the entry 2078.Bd -literal -offset indent 2079hn\||\|2621\-nl:ks@:ke@:tc=2621: 2080.Ed 2081.Pp 2082defines a 2083.Dq 2621\-nl 2084that does not have the 2085.Sy \&ks 2086or 2087.Sy \&ke 2088capabilities, 2089hence does not turn on the function key labels when in visual mode. 2090This is useful for different modes for a terminal, or for different 2091user preferences. 2092.Sh FILES 2093.Bl -tag -width /usr/share/misc/termcap.db -compact 2094.It Pa /usr/share/misc/termcap 2095File containing terminal descriptions. 2096.It Pa /usr/share/misc/termcap.db 2097Hash database file containing terminal descriptions (see 2098.Xr cap_mkdb 1 ) . 2099.El 2100.Sh SEE ALSO 2101.Xr cap_mkdb 1 , 2102.Xr ex 1 , 2103.Xr more 1 , 2104.Xr tset 1 , 2105.Xr ul 1 , 2106.Xr vi 1 , 2107.Xr ncurses 3 , 2108.Xr printf 3 , 2109.Xr termcap 3 , 2110.Xr term 5 2111.Sh CAVEATS AND BUGS 2112The 2113.Em Note : 2114.Nm 2115functions 2116were replaced by 2117.Xr terminfo 5 2118in 2119.At V 2120Release 2.0. 2121The transition will be relatively painless if capabilities flagged as 2122.Dq obsolete 2123are avoided. 2124.Pp 2125Lines and columns are now stored by the kernel as well as in the termcap 2126entry. 2127Most programs now use the kernel information primarily; the information 2128in this file is used only if the kernel does not have any information. 2129.Pp 2130The 2131.Xr \&vi 1 2132program allows only 256 characters for string capabilities, and the routines 2133in 2134.Xr termlib 3 2135do not check for overflow of this buffer. 2136The total length of a single entry (excluding only escaped newlines) 2137may not exceed 1024. 2138.Pp 2139Not all programs support all entries. 2140.Sh HISTORY 2141The 2142.Nm 2143file format appeared in 2144.Bx 3 . 2145