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