share/termcap/termcap.5

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