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