ncurses 6.2 - patch 20211016
[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.108 2021/10/09 23:13:23 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 20211016).
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.     (ML is
962                                                        not in BSD termcap).
963           set_left_margin_parm        smglp     Zm     Set left (right)
964                                                        margin at column #1
965           set_right_margin            smgr      MR     set right soft
966                                                        margin at current
967                                                        column
968           set_right_margin_parm       smgrp     Zn     Set right margin at
969                                                        column #1
970           set_tab                     hts       st     set a tab in every
971                                                        row, current columns
972           set_top_margin              smgt      Zo     Set top margin at
973                                                        current line
974           set_top_margin_parm         smgtp     Zp     Set top (bottom)
975                                                        margin at row #1
976           set_window                  wind      wi     current window is
977                                                        lines #1-#2 cols
978                                                        #3-#4
979           start_bit_image             sbim      Zq     Start printing bit
980                                                        image graphics
981           start_char_set_def          scsd      Zr     Start character set
982                                                        definition #1, with
983                                                        #2 characters in the
984                                                        set
985           stop_bit_image              rbim      Zs     Stop printing bit
986                                                        image graphics
987           stop_char_set_def           rcsd      Zt     End definition of
988                                                        character set #1
989           subscript_characters        subcs     Zu     List of
990                                                        subscriptable
991                                                        characters
992           superscript_characters      supcs     Zv     List of
993                                                        superscriptable
994                                                        characters
995           tab                         ht        ta     tab to next 8-space
996                                                        hardware tab stop
997           these_cause_cr              docr      Zw     Printing any of
998                                                        these characters
999                                                        causes CR
1000           to_status_line              tsl       ts     move to status line,
1001                                                        column #1
1002           tone                        tone      TO     select touch tone
1003                                                        dialing
1004           underline_char              uc        uc     underline char and
1005                                                        move past it
1006           up_half_line                hu        hu     half a line up
1007           user0                       u0        u0     User string #0
1008           user1                       u1        u1     User string #1
1009           user2                       u2        u2     User string #2
1010           user3                       u3        u3     User string #3
1011           user4                       u4        u4     User string #4
1012           user5                       u5        u5     User string #5
1013           user6                       u6        u6     User string #6
1014
1015           user7                       u7        u7     User string #7
1016           user8                       u8        u8     User string #8
1017           user9                       u9        u9     User string #9
1018           wait_tone                   wait      WA     wait for dial-tone
1019           xoff_character              xoffc     XF     XOFF character
1020           xon_character               xonc      XN     XON character
1021           zero_motion                 zerom     Zx     No motion for
1022                                                        subsequent character
1023
1024        The following string  capabilities  are  present  in  the  SVr4.0  term
1025        structure, but were originally not documented in the man page.
1026
1027
1028                   <STRONG>Variable</STRONG>            <STRONG>Cap-</STRONG>       <STRONG>TCap</STRONG>      <STRONG>Description</STRONG>
1029                    <STRONG>String</STRONG>             <STRONG>name</STRONG>       <STRONG>Code</STRONG>
1030           alt_scancode_esc            scesa      S8     Alternate escape
1031                                                         for scancode
1032                                                         emulation
1033           bit_image_carriage_return   bicr       Yv     Move to beginning
1034                                                         of same row
1035           bit_image_newline           binel      Zz     Move to next row
1036                                                         of the bit image
1037           bit_image_repeat            birep      Xy     Repeat bit image
1038                                                         cell #1 #2 times
1039           char_set_names              csnm       Zy     Produce #1'th item
1040                                                         from list of
1041                                                         character set
1042                                                         names
1043           code_set_init               csin       ci     Init sequence for
1044                                                         multiple codesets
1045           color_names                 colornm    Yw     Give name for
1046                                                         color #1
1047           define_bit_image_region     defbi      Yx     Define rectangular
1048                                                         bit image region
1049           device_type                 devt       dv     Indicate
1050                                                         language/codeset
1051                                                         support
1052           display_pc_char             dispc      S1     Display PC
1053                                                         character #1
1054           end_bit_image_region        endbi      Yy     End a bit-image
1055                                                         region
1056           enter_pc_charset_mode       smpch      S2     Enter PC character
1057                                                         display mode
1058           enter_scancode_mode         smsc       S4     Enter PC scancode
1059                                                         mode
1060           exit_pc_charset_mode        rmpch      S3     Exit PC character
1061                                                         display mode
1062           exit_scancode_mode          rmsc       S5     Exit PC scancode
1063                                                         mode
1064           get_mouse                   getm       Gm     Curses should get
1065                                                         button events,
1066                                                         parameter #1 not
1067                                                         documented.
1068           key_mouse                   kmous      Km     Mouse event has
1069                                                         occurred
1070           mouse_info                  minfo      Mi     Mouse status
1071                                                         information
1072           pc_term_options             pctrm      S6     PC terminal
1073                                                         options
1074           pkey_plab                   pfxl       xl     Program function
1075                                                         key #1 to type
1076                                                         string #2 and show
1077                                                         string #3
1078           req_mouse_pos               reqmp      RQ     Request mouse
1079                                                         position
1080
1081           scancode_escape             scesc      S7     Escape for
1082                                                         scancode emulation
1083           set0_des_seq                s0ds       s0     Shift to codeset 0
1084                                                         (EUC set 0, ASCII)
1085           set1_des_seq                s1ds       s1     Shift to codeset 1
1086           set2_des_seq                s2ds       s2     Shift to codeset 2
1087           set3_des_seq                s3ds       s3     Shift to codeset 3
1088           set_a_background            setab      AB     Set background
1089                                                         color to #1, using
1090                                                         ANSI escape
1091           set_a_foreground            setaf      AF     Set foreground
1092                                                         color to #1, using
1093                                                         ANSI escape
1094           set_color_band              setcolor   Yz     Change to ribbon
1095                                                         color #1
1096           set_lr_margin               smglr      ML     Set both left and
1097                                                         right margins to
1098                                                         #1, #2.  (ML is
1099                                                         not in BSD
1100                                                         termcap).
1101           set_page_length             slines     YZ     Set page length to
1102                                                         #1 lines
1103           set_tb_margin               smgtb      MT     Sets both top and
1104                                                         bottom margins to
1105                                                         #1, #2
1106
1107         The XSI Curses standard added these hardcopy capabilities.  They  were
1108         used  in  some post-4.1 versions of System V curses, e.g., Solaris 2.5
1109         and IRIX 6.x.  Except for <STRONG>YI</STRONG>, the <STRONG>ncurses</STRONG> termcap names for  them  are
1110         invented.   According to the XSI Curses standard, they have no termcap
1111         names.  If your compiled terminfo entries use these, they may  not  be
1112         binary-compatible with System V terminfo entries after SVr4.1; beware!
1113
1114
1115                   <STRONG>Variable</STRONG>            <STRONG>Cap-</STRONG>      <STRONG>TCap</STRONG>       <STRONG>Description</STRONG>
1116                    <STRONG>String</STRONG>             <STRONG>name</STRONG>      <STRONG>Code</STRONG>
1117           enter_horizontal_hl_mode    ehhlm     Xh     Enter horizontal
1118                                                        highlight mode
1119           enter_left_hl_mode          elhlm     Xl     Enter left highlight
1120                                                        mode
1121           enter_low_hl_mode           elohlm    Xo     Enter low highlight
1122                                                        mode
1123           enter_right_hl_mode         erhlm     Xr     Enter right
1124                                                        highlight mode
1125           enter_top_hl_mode           ethlm     Xt     Enter top highlight
1126                                                        mode
1127           enter_vertical_hl_mode      evhlm     Xv     Enter vertical
1128                                                        highlight mode
1129           set_a_attributes            sgr1      sA     Define second set of
1130                                                        video attributes
1131                                                        #1-#6
1132           set_pglen_inch              slength   YI     Set page length to
1133                                                        #1 hundredth of an
1134                                                        inch (some
1135                                                        implementations use
1136                                                        sL for termcap).
1137
1138
1139 </PRE><H3><a name="h3-User-Defined-Capabilities">User-Defined Capabilities</a></H3><PRE>
1140        The  preceding  section  listed the <EM>predefined</EM> capabilities.  They deal
1141        with some special features for terminals no longer (or possibly  never)
1142        produced.   Occasionally  there are special features of newer terminals
1143        which are awkward or impossible to represent by reusing the  predefined
1144        capabilities.
1145
1146        <STRONG>ncurses</STRONG>    addresses   this   limitation   by   allowing   user-defined
1147        capabilities.  The <STRONG>tic</STRONG> and <STRONG>infocmp</STRONG> programs provide the <STRONG>-x</STRONG>  option  for
1148        this purpose.  When <STRONG>-x</STRONG> is set, <STRONG>tic</STRONG> treats unknown capabilities as user-
1149        defined.  That is, if <STRONG>tic</STRONG> encounters a capability name  which  it  does
1150        not  recognize, it infers its type (boolean, number or string) from the
1151        syntax and makes an extended table  entry  for  that  capability.   The
1152        <STRONG><A HREF="curs_extend.3x.html">use_extended_names(3x)</A></STRONG>  function  makes  this information conditionally
1153        available to applications.   The  ncurses  library  provides  the  data
1154        leaving most of the behavior to applications:
1155
1156        <STRONG>o</STRONG>   User-defined  capability  strings  whose  name  begins with "k" are
1157            treated as function keys.
1158
1159        <STRONG>o</STRONG>   The types (boolean,  number,  string)  determined  by  <STRONG>tic</STRONG>  can  be
1160            inferred by successful calls on <STRONG>tigetflag</STRONG>, etc.
1161
1162        <STRONG>o</STRONG>   If the capability name happens to be two characters, the capability
1163            is also available through the termcap interface.
1164
1165        While termcap is said to be  extensible  because  it  does  not  use  a
1166        predefined  set of capabilities, in practice it has been limited to the
1167        capabilities defined by terminfo implementations.   As  a  rule,  user-
1168        defined capabilities intended for use by termcap applications should be
1169        limited to booleans and numbers to avoid running  past  the  1023  byte
1170        limit  assumed  by  termcap implementations and their applications.  In
1171        particular, providing extended sets  of  function  keys  (past  the  60
1172        numbered keys and the handful of special named keys) is best done using
1173        the longer names available using terminfo.
1174
1175
1176 </PRE><H3><a name="h3-A-Sample-Entry">A Sample Entry</a></H3><PRE>
1177        The  following  entry,  describing  an   ANSI-standard   terminal,   is
1178        representative of what a <STRONG>terminfo</STRONG> entry for a modern terminal typically
1179        looks like.
1180
1181        ansi|ansi/pc-term compatible with color,
1182                am, mc5i, mir, msgr,
1183                colors#8, cols#80, it#8, lines#24, ncv#3, pairs#64,
1184                acsc=+\020\,\021-\030.^Y0\333`\004a\261f\370g\361h\260
1185                     j\331k\277l\332m\300n\305o~p\304q\304r\304s_t\303
1186                     u\264v\301w\302x\263y\363z\362{\343|\330}\234~\376,
1187                bel=^G, blink=\E[5m, bold=\E[1m, cbt=\E[Z, clear=\E[H\E[J,
1188                cr=^M, cub=\E[%p1%dD, cub1=\E[D, cud=\E[%p1%dB, cud1=\E[B,
1189                cuf=\E[%p1%dC, cuf1=\E[C, cup=\E[%i%p1%d;%p2%dH,
1190                cuu=\E[%p1%dA, cuu1=\E[A, dch=\E[%p1%dP, dch1=\E[P,
1191                dl=\E[%p1%dM, dl1=\E[M, ech=\E[%p1%dX, ed=\E[J, el=\E[K,
1192                el1=\E[1K, home=\E[H, hpa=\E[%i%p1%dG, ht=\E[I, hts=\EH,
1193                ich=\E[%p1%d@, il=\E[%p1%dL, il1=\E[L, ind=^J,
1194                indn=\E[%p1%dS, invis=\E[8m, kbs=^H, kcbt=\E[Z, kcub1=\E[D,
1195                kcud1=\E[B, kcuf1=\E[C, kcuu1=\E[A, khome=\E[H, kich1=\E[L,
1196                mc4=\E[4i, mc5=\E[5i, nel=\r\E[S, op=\E[39;49m,
1197                rep=%p1%c\E[%p2%{1}%-%db, rev=\E[7m, rin=\E[%p1%dT,
1198                rmacs=\E[10m, rmpch=\E[10m, rmso=\E[m, rmul=\E[m,
1199                s0ds=\E(B, s1ds=\E)B, s2ds=\E*B, s3ds=\E+B,
1200                setab=\E[4%p1%dm, setaf=\E[3%p1%dm,
1201                sgr=\E[0;10%?%p1%t;7%;
1202                           %?%p2%t;4%;
1203                           %?%p3%t;7%;
1204                           %?%p4%t;5%;
1205                           %?%p6%t;1%;
1206                           %?%p7%t;8%;
1207                           %?%p9%t;11%;m,
1208                sgr0=\E[0;10m, smacs=\E[11m, smpch=\E[11m, smso=\E[7m,
1209                smul=\E[4m, tbc=\E[3g, u6=\E[%i%d;%dR, u7=\E[6n,
1210                u8=\E[?%[;0123456789]c, u9=\E[c, vpa=\E[%i%p1%dd,
1211
1212        Entries may continue onto multiple lines by placing white space at  the
1213        beginning  of  each line except the first.  Comments may be included on
1214        lines beginning with "#".  Capabilities in <EM>terminfo</EM> are of three types:
1215
1216        <STRONG>o</STRONG>   Boolean capabilities which indicate  that  the  terminal  has  some
1217            particular feature,
1218
1219        <STRONG>o</STRONG>   numeric capabilities giving the size of the terminal or the size of
1220            particular delays, and
1221
1222        <STRONG>o</STRONG>   string capabilities, which give a sequence which  can  be  used  to
1223            perform particular terminal operations.
1224
1225
1226 </PRE><H3><a name="h3-Types-of-Capabilities">Types of Capabilities</a></H3><PRE>
1227        All capabilities have names.  For instance, the fact that ANSI-standard
1228        terminals have <EM>automatic</EM> <EM>margins</EM> (i.e., an automatic return  and  line-
1229        feed  when the end of a line is reached) is indicated by the capability
1230        <STRONG>am</STRONG>.  Hence the description of ansi includes <STRONG>am</STRONG>.   Numeric  capabilities
1231        are  followed  by  the  character  "#" and then a positive value.  Thus
1232        <STRONG>cols</STRONG>, which indicates the number of columns the terminal has, gives the
1233        value  "80" for ansi.  Values for numeric capabilities may be specified
1234        in decimal, octal or hexadecimal,  using  the  C  programming  language
1235        conventions (e.g., 255, 0377 and 0xff or 0xFF).
1236
1237        Finally,  string  valued capabilities, such as <STRONG>el</STRONG> (clear to end of line
1238        sequence) are given by the two-character  code,  an  "=",  and  then  a
1239        string ending at the next following ",".
1240
1241        A  number  of  escape  sequences  are  provided  in  the  string valued
1242        capabilities for easy encoding of characters there:
1243
1244        <STRONG>o</STRONG>   Both <STRONG>\E</STRONG> and <STRONG>\e</STRONG> map to an ESCAPE character,
1245
1246        <STRONG>o</STRONG>   <STRONG>^x</STRONG> maps to a control-x for any appropriate <EM>x</EM>, and
1247
1248        <STRONG>o</STRONG>   the sequences
1249
1250              <STRONG>\n</STRONG>, <STRONG>\l</STRONG>, <STRONG>\r</STRONG>, <STRONG>\t</STRONG>, <STRONG>\b</STRONG>, <STRONG>\f</STRONG>, and <STRONG>\s</STRONG>
1251
1252            produce
1253
1254              <EM>newline</EM>, <EM>line-feed</EM>, <EM>return</EM>, <EM>tab</EM>, <EM>backspace</EM>, <EM>form-feed</EM>, and <EM>space</EM>,
1255
1256            respectively.
1257
1258        X/Open Curses does not say what "appropriate <EM>x</EM>" might be.  In practice,
1259        that  is a printable ASCII graphic character.  The special case "^?" is
1260        interpreted as DEL (127).  In all other cases, the character  value  is
1261        AND'd  with 0x1f, mapping to ASCII control codes in the range 0 through
1262        31.
1263
1264        Other escapes include
1265
1266        <STRONG>o</STRONG>   <STRONG>\^</STRONG> for <STRONG>^</STRONG>,
1267
1268        <STRONG>o</STRONG>   <STRONG>\\</STRONG> for <STRONG>\</STRONG>,
1269
1270        <STRONG>o</STRONG>   <STRONG>\</STRONG>, for comma,
1271
1272        <STRONG>o</STRONG>   <STRONG>\:</STRONG> for <STRONG>:</STRONG>,
1273
1274        <STRONG>o</STRONG>   and <STRONG>\0</STRONG> for null.
1275
1276            <STRONG>\0</STRONG> will produce \200, which does not terminate a string but behaves
1277            as  a null character on most terminals, providing CS7 is specified.
1278            See <STRONG>stty(1)</STRONG>.
1279
1280            The reason for this quirk is to maintain  binary  compatibility  of
1281            the  compiled  terminfo files with other implementations, e.g., the
1282            SVr4 systems, which document this.   Compiled  terminfo  files  use
1283            null-terminated  strings,  with  no  lengths.  Modifying this would
1284            require a new binary  format,  which  would  not  work  with  other
1285            implementations.
1286
1287        Finally, characters may be given as three octal digits after a <STRONG>\</STRONG>.
1288
1289        A  delay  in  milliseconds  may appear anywhere in a string capability,
1290        enclosed in $&lt;..&gt; brackets, as in <STRONG>el</STRONG>=\EK$&lt;5&gt;,  and  padding  characters
1291        are supplied by <STRONG><A HREF="curs_terminfo.3x.html">tputs(3x)</A></STRONG> to provide this delay.
1292
1293        <STRONG>o</STRONG>   The  delay  must  be  a  number  with  at most one decimal place of
1294            precision; it may be followed by suffixes "*" or "/" or both.
1295
1296        <STRONG>o</STRONG>   A "*" indicates that the padding required is  proportional  to  the
1297            number  of lines affected by the operation, and the amount given is
1298            the per-affected-unit padding required.  (In  the  case  of  insert
1299            character, the factor is still the number of <EM>lines</EM> affected.)
1300
1301            Normally, padding is advisory if the device has the <STRONG>xon</STRONG> capability;
1302            it is used for cost computation but does not trigger delays.
1303
1304        <STRONG>o</STRONG>   A "/" suffix indicates that the padding is mandatory and  forces  a
1305            delay of the given number of milliseconds even on devices for which
1306            <STRONG>xon</STRONG> is present to indicate flow control.
1307
1308        Sometimes individual capabilities must be commented out.  To  do  this,
1309        put  a  period before the capability name.  For example, see the second
1310        <STRONG>ind</STRONG> in the example above.
1311
1312
1313 </PRE><H3><a name="h3-Fetching-Compiled-Descriptions">Fetching Compiled Descriptions</a></H3><PRE>
1314        The <STRONG>ncurses</STRONG> library  searches  for  terminal  descriptions  in  several
1315        places.   It  uses only the first description found.  The library has a
1316        compiled-in list of  places  to  search  which  can  be  overridden  by
1317        environment  variables.   Before starting to search, <STRONG>ncurses</STRONG> eliminates
1318        duplicates in its search list.
1319
1320        <STRONG>o</STRONG>   If the environment variable TERMINFO is set, it is  interpreted  as
1321            the pathname of a directory containing the compiled description you
1322            are working on.  Only that directory is searched.
1323
1324        <STRONG>o</STRONG>   If TERMINFO is not set, <STRONG>ncurses</STRONG> will instead look in the  directory
1325            <STRONG>$HOME/.terminfo</STRONG> for a compiled description.
1326
1327        <STRONG>o</STRONG>   Next,  if  the  environment  variable TERMINFO_DIRS is set, <STRONG>ncurses</STRONG>
1328            will interpret the contents of that variable as a  list  of  colon-
1329            separated directories (or database files) to be searched.
1330
1331            An  empty directory name (i.e., if the variable begins or ends with
1332            a colon, or contains adjacent colons) is interpreted as the  system
1333            location <EM>/usr/share/terminfo</EM>.
1334
1335        <STRONG>o</STRONG>   Finally, <STRONG>ncurses</STRONG> searches these compiled-in locations:
1336
1337            <STRONG>o</STRONG>   a list of directories (no default value), and
1338
1339            <STRONG>o</STRONG>   the   system   terminfo   directory,  <EM>/usr/share/terminfo</EM>  (the
1340                compiled-in default).
1341
1342
1343 </PRE><H3><a name="h3-Preparing-Descriptions">Preparing Descriptions</a></H3><PRE>
1344        We now outline how to prepare  descriptions  of  terminals.   The  most
1345        effective  way  to  prepare  a terminal description is by imitating the
1346        description of a similar  terminal  in  <EM>terminfo</EM>  and  to  build  up  a
1347        description gradually, using partial descriptions with <EM>vi</EM> or some other
1348        screen-oriented program to check that they are correct.  Be aware  that
1349        a  very  unusual terminal may expose deficiencies in the ability of the
1350        <EM>terminfo</EM> file to describe it or bugs in the screen-handling code of the
1351        test program.
1352
1353        To  get the padding for insert line right (if the terminal manufacturer
1354        did not document it) a severe test is to edit  a  large  file  at  9600
1355        baud, delete 16 or so lines from the middle of the screen, then hit the
1356        "u" key several times quickly.  If the terminal messes up, more padding
1357        is usually needed.  A similar test can be used for insert character.
1358
1359
1360 </PRE><H3><a name="h3-Basic-Capabilities">Basic Capabilities</a></H3><PRE>
1361        The  number  of  columns  on each line for the terminal is given by the
1362        <STRONG>cols</STRONG> numeric capability.  If the terminal is a CRT, then the number  of
1363        lines  on the screen is given by the <STRONG>lines</STRONG> capability.  If the terminal
1364        wraps around to the beginning of the next  line  when  it  reaches  the
1365        right  margin,  then it should have the <STRONG>am</STRONG> capability.  If the terminal
1366        can clear its screen, leaving the cursor in  the  home  position,  then
1367        this  is  given  by  the  <STRONG>clear</STRONG>  string  capability.   If  the terminal
1368        overstrikes (rather than clearing a position when a character is struck
1369        over)  then  it  should  have  the <STRONG>os</STRONG> capability.  If the terminal is a
1370        printing terminal, with no soft copy unit, give it both <STRONG>hc</STRONG> and <STRONG>os</STRONG>.  (<STRONG>os</STRONG>
1371        applies  to  storage scope terminals, such as TEKTRONIX 4010 series, as
1372        well as hard copy and APL terminals.)  If there is a code to  move  the
1373        cursor to the left edge of the current row, give this as <STRONG>cr</STRONG>.  (Normally
1374        this will be carriage return,  control/M.)   If  there  is  a  code  to
1375        produce an audible signal (bell, beep, etc) give this as <STRONG>bel</STRONG>.
1376
1377        If there is a code to move the cursor one position to the left (such as
1378        backspace) that capability should be given as <STRONG>cub1</STRONG>.   Similarly,  codes
1379        to  move  to the right, up, and down should be given as <STRONG>cuf1</STRONG>, <STRONG>cuu1</STRONG>, and
1380        <STRONG>cud1</STRONG>.  These local cursor motions should not alter the text  they  pass
1381        over,  for  example,  you  would  not normally use "<STRONG>cuf1</STRONG>= " because the
1382        space would erase the character moved over.
1383
1384        A very important point here is that the local cursor motions encoded in
1385        <EM>terminfo</EM>  are  undefined  at  the left and top edges of a CRT terminal.
1386        Programs should never attempt to backspace around the left edge, unless
1387        <STRONG>bw</STRONG>  is given, and never attempt to go up locally off the top.  In order
1388        to scroll text up, a program will go to the bottom left corner  of  the
1389        screen and send the <STRONG>ind</STRONG> (index) string.
1390
1391        To  scroll  text  down,  a  program  goes to the top left corner of the
1392        screen and sends the <STRONG>ri</STRONG> (reverse index) string.  The strings <STRONG>ind</STRONG> and <STRONG>ri</STRONG>
1393        are undefined when not on their respective corners of the screen.
1394
1395        Parameterized  versions  of  the  scrolling  sequences are <STRONG>indn</STRONG> and <STRONG>rin</STRONG>
1396        which have the same semantics as <STRONG>ind</STRONG> and <STRONG>ri</STRONG> except that they  take  one
1397        parameter,  and scroll that many lines.  They are also undefined except
1398        at the appropriate edge of the screen.
1399
1400        The <STRONG>am</STRONG> capability tells whether the cursor sticks at the right edge  of
1401        the  screen when text is output, but this does not necessarily apply to
1402        a <STRONG>cuf1</STRONG> from the last column.  The only local motion  which  is  defined
1403        from  the  left  edge is if <STRONG>bw</STRONG> is given, then a <STRONG>cub1</STRONG> from the left edge
1404        will move to the right edge of the previous row.  If <STRONG>bw</STRONG> is  not  given,
1405        the  effect  is undefined.  This is useful for drawing a box around the
1406        edge of the screen, for example.  If the terminal has switch selectable
1407        automatic  margins,  the <EM>terminfo</EM> file usually assumes that this is on;
1408        i.e., <STRONG>am</STRONG>.  If the terminal has a  command  which  moves  to  the  first
1409        column  of  the  next line, that command can be given as <STRONG>nel</STRONG> (newline).
1410        It does not matter if the command clears the remainder of  the  current
1411        line,  so  if the terminal has no <STRONG>cr</STRONG> and <STRONG>lf</STRONG> it may still be possible to
1412        craft a working <STRONG>nel</STRONG> out of one or both of them.
1413
1414        These  capabilities  suffice  to  describe  hard-copy  and  "glass-tty"
1415        terminals.  Thus the model 33 teletype is described as
1416
1417        33|tty33|tty|model 33 teletype,
1418                bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os,
1419
1420        while the Lear Siegler ADM-3 is described as
1421
1422        adm3|3|lsi adm3,
1423                am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J,
1424                ind=^J, lines#24,
1425
1426
1427 </PRE><H3><a name="h3-Parameterized-Strings">Parameterized Strings</a></H3><PRE>
1428        Cursor  addressing  and  other  strings  requiring  parameters  in  the
1429        terminal are described  by  a  parameterized  string  capability,  with
1430        <EM>printf</EM>-like  escapes  such  as  <EM>%x</EM>  in it.  For example, to address the
1431        cursor, the <STRONG>cup</STRONG> capability is given, using two parameters: the row  and
1432        column  to  address  to.   (Rows and columns are numbered from zero and
1433        refer to the physical screen visible to the user,  not  to  any  unseen
1434        memory.)   If  the terminal has memory relative cursor addressing, that
1435        can be indicated by <STRONG>mrcup</STRONG>.
1436
1437        The parameter mechanism uses a stack and special <STRONG>%</STRONG> codes to  manipulate
1438        it.   Typically  a  sequence  will  push one of the parameters onto the
1439        stack and then print it in  some  format.   Print  (e.g.,  "%d")  is  a
1440        special  case.  Other operations, including "%t" pop their operand from
1441        the stack.   It  is  noted  that  more  complex  operations  are  often
1442        necessary, e.g., in the <STRONG>sgr</STRONG> string.
1443
1444        The <STRONG>%</STRONG> encodings have the following meanings:
1445
1446        <STRONG>%%</STRONG>   outputs "%"
1447
1448        <STRONG>%</STRONG><EM>[[</EM>:<EM>]flags][width[.precision]][</EM><STRONG>doxXs</STRONG><EM>]</EM>
1449             as  in  <STRONG>printf(3)</STRONG>,  flags are <EM>[-+#]</EM> and <EM>space</EM>.  Use a ":" to allow
1450             the next character to be a "-" flag, avoiding interpreting "%-" as
1451             an operator.
1452
1453        %c   print <EM>pop()</EM> like %c in <STRONG>printf</STRONG>
1454
1455        <STRONG>%s</STRONG>   print <EM>pop()</EM> like %s in <STRONG>printf</STRONG>
1456
1457        <STRONG>%p</STRONG><EM>[1-9]</EM>
1458             push <EM>i</EM>'th parameter
1459
1460        <STRONG>%P</STRONG><EM>[a-z]</EM>
1461             set dynamic variable <EM>[a-z]</EM> to <EM>pop()</EM>
1462
1463        <STRONG>%g</STRONG><EM>[a-z]/</EM>
1464             get dynamic variable <EM>[a-z]</EM> and push it
1465
1466        <STRONG>%P</STRONG><EM>[A-Z]</EM>
1467             set static variable <EM>[a-z]</EM> to <EM>pop()</EM>
1468
1469        <STRONG>%g</STRONG><EM>[A-Z]</EM>
1470             get static variable <EM>[a-z]</EM> and push it
1471
1472             The  terms  "static"  and "dynamic" are misleading.  Historically,
1473             these are simply two different sets of variables, whose values are
1474             not  reset  between calls to <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG>.  However, that fact is not
1475             documented in other implementations.  Relying on it will adversely
1476             impact portability to other implementations:
1477
1478             <STRONG>o</STRONG>   SVr2  curses  supported <EM>dynamic</EM> variables.  Those are set only
1479                 by a <STRONG>%P</STRONG> operator.  A <STRONG>%g</STRONG> for a  given  variable  without  first
1480                 setting  it  with  <STRONG>%P</STRONG> will give unpredictable results, because
1481                 dynamic variables are an  uninitialized  local  array  on  the
1482                 stack in the <STRONG>tparm</STRONG> function.
1483
1484             <STRONG>o</STRONG>   SVr3.2  curses supported <EM>static</EM> variables.  Those are an array
1485                 in the <STRONG>TERMINAL</STRONG> structure (declared in <STRONG>term.h</STRONG>), and are zeroed
1486                 automatically when the <STRONG>setupterm</STRONG> function allocates the data.
1487
1488             <STRONG>o</STRONG>   SVr4 curses made no further improvements to the <EM>dynamic/static</EM>
1489                 variable feature.
1490
1491             <STRONG>o</STRONG>   Solaris XPG4 curses does not distinguish between  <EM>dynamic</EM>  and
1492                 <EM>static</EM>  variables.  They are the same.  Like SVr4 curses, XPG4
1493                 curses does not initialize these explicitly.
1494
1495             <STRONG>o</STRONG>   Before version 6.3, ncurses stores  both  <EM>dynamic</EM>  and  <EM>static</EM>
1496                 variables in persistent storage, initialized to zeros.
1497
1498             <STRONG>o</STRONG>   Beginning  with version 6.3, ncurses stores <EM>static</EM> and <EM>dynamic</EM>
1499                 variables  in  the  same  manner  as   SVr4.    Unlike   other
1500                 implementations,  ncurses  zeros  dynamic variables before the
1501                 first <STRONG>%g</STRONG> or <STRONG>%P</STRONG> operator.
1502
1503        <STRONG>%'</STRONG><EM>c</EM><STRONG>'</STRONG> char constant <EM>c</EM>
1504
1505        <STRONG>%{</STRONG><EM>nn</EM><STRONG>}</STRONG>
1506             integer constant <EM>nn</EM>
1507
1508        <STRONG>%l</STRONG>   push strlen(pop)
1509
1510        <STRONG>%+</STRONG>, <STRONG>%-</STRONG>, <STRONG>%*</STRONG>, <STRONG>%/</STRONG>, <STRONG>%m</STRONG>
1511             arithmetic (%m is <EM>mod</EM>): <EM>push(pop()</EM> <EM>op</EM> <EM>pop())</EM>
1512
1513        <STRONG>%&amp;</STRONG>, <STRONG>%|</STRONG>, <STRONG>%^</STRONG>
1514             bit operations (AND, OR and exclusive-OR): <EM>push(pop()</EM> <EM>op</EM> <EM>pop())</EM>
1515
1516        <STRONG>%=</STRONG>, <STRONG>%&gt;</STRONG>, <STRONG>%&lt;</STRONG>
1517             logical operations: <EM>push(pop()</EM> <EM>op</EM> <EM>pop())</EM>
1518
1519        <STRONG>%A</STRONG>, <STRONG>%O</STRONG>
1520             logical AND and OR operations (for conditionals)
1521
1522        <STRONG>%!</STRONG>, <STRONG>%~</STRONG>
1523             unary operations (logical and bit complement): <EM>push(op</EM> <EM>pop())</EM>
1524
1525        <STRONG>%i</STRONG>   add 1 to first two parameters (for ANSI terminals)
1526
1527        <STRONG>%?</STRONG> <EM>expr</EM> <STRONG>%t</STRONG> <EM>thenpart</EM> <STRONG>%e</STRONG> <EM>elsepart</EM> <STRONG>%;</STRONG>
1528             This forms an if-then-else.  The <STRONG>%e</STRONG> <EM>elsepart</EM> is optional.  Usually
1529             the  <STRONG>%?</STRONG>  <EM>expr</EM>  part  pushes a value onto the stack, and <STRONG>%t</STRONG> pops it
1530             from the stack, testing if it is nonzero (true).  If  it  is  zero
1531             (false), control passes to the <STRONG>%e</STRONG> (else) part.
1532
1533             It is possible to form else-if's a la Algol 68:
1534             <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>
1535
1536             where ci are conditions, bi are bodies.
1537
1538             Use  the  <STRONG>-f</STRONG>  option of <STRONG>tic</STRONG> or <STRONG>infocmp</STRONG> to see the structure of if-
1539             then-else's.  Some strings, e.g., <STRONG>sgr</STRONG> can be very complicated when
1540             written  on  one line.  The <STRONG>-f</STRONG> option splits the string into lines
1541             with the parts indented.
1542
1543        Binary operations are in postfix form with the operands  in  the  usual
1544        order.   That  is,  to  get  x-5  one would use "%gx%{5}%-".  <STRONG>%P</STRONG> and <STRONG>%g</STRONG>
1545        variables are persistent across escape-string evaluations.
1546
1547        Consider the HP2645, which, to get to row 3 and column 12, needs to  be
1548        sent  \E&amp;a12c03Y padded for 6 milliseconds.  Note that the order of the
1549        rows and columns is inverted here, and that  the  row  and  column  are
1550        printed    as    two    digits.     Thus    its   <STRONG>cup</STRONG>   capability   is
1551        "cup=6\E&amp;%p2%2dc%p1%2dY".
1552
1553        The Microterm ACT-IV needs the current row and column sent preceded  by
1554        a   <STRONG>^T</STRONG>,   with   the   row   and   column  simply  encoded  in  binary,
1555        "cup=^T%p1%c%p2%c".  Terminals which  use  "%c"  need  to  be  able  to
1556        backspace  the cursor (<STRONG>cub1</STRONG>), and to move the cursor up one line on the
1557        screen (<STRONG>cuu1</STRONG>).  This is necessary because it  is  not  always  safe  to
1558        transmit  <STRONG>\n</STRONG> <STRONG>^D</STRONG> and <STRONG>\r</STRONG>, as the system may change or discard them.  (The
1559        library routines dealing with terminfo set tty modes so that  tabs  are
1560        never  expanded, so \t is safe to send.  This turns out to be essential
1561        for the Ann Arbor 4080.)
1562
1563        A final example is the LSI ADM-3a, which uses row and column offset  by
1564        a blank character, thus "cup=\E=%p1%' '%+%c%p2%' '%+%c".  After sending
1565        "\E=", this pushes the first parameter, pushes the ASCII  value  for  a
1566        space (32), adds them (pushing the sum on the stack in place of the two
1567        previous values) and outputs that value as a character.  Then the  same
1568        is  done for the second parameter.  More complex arithmetic is possible
1569        using the stack.
1570
1571
1572 </PRE><H3><a name="h3-Cursor-Motions">Cursor Motions</a></H3><PRE>
1573        If the terminal has a fast way to home the cursor (to very  upper  left
1574        corner  of screen) then this can be given as <STRONG>home</STRONG>; similarly a fast way
1575        of getting to the lower left-hand corner can be given as <STRONG>ll</STRONG>;  this  may
1576        involve going up with <STRONG>cuu1</STRONG> from the home position, but a program should
1577        never do this itself (unless <STRONG>ll</STRONG> does) because it can make no assumption
1578        about  the  effect  of moving up from the home position.  Note that the
1579        home position is the same as addressing  to  (0,0):  to  the  top  left
1580        corner  of  the  screen,  not of memory.  (Thus, the \EH sequence on HP
1581        terminals cannot be used for <STRONG>home</STRONG>.)
1582
1583        If the terminal has row or column absolute cursor addressing, these can
1584        be  given  as  single  parameter  capabilities <STRONG>hpa</STRONG> (horizontal position
1585        absolute) and <STRONG>vpa</STRONG> (vertical position absolute).   Sometimes  these  are
1586        shorter  than  the  more  general  two  parameter sequence (as with the
1587        hp2645)  and  can  be  used  in  preference  to  <STRONG>cup</STRONG>.   If  there   are
1588        parameterized  local  motions  (e.g., move <EM>n</EM> spaces to the right) these
1589        can be given as  <STRONG>cud</STRONG>,  <STRONG>cub</STRONG>,  <STRONG>cuf</STRONG>,  and  <STRONG>cuu</STRONG>  with  a  single  parameter
1590        indicating  how many spaces to move.  These are primarily useful if the
1591        terminal does not have <STRONG>cup</STRONG>, such as the TEKTRONIX 4025.
1592
1593        If the terminal needs to be in a special mode when  running  a  program
1594        that uses these capabilities, the codes to enter and exit this mode can
1595        be given as <STRONG>smcup</STRONG> and <STRONG>rmcup</STRONG>.  This arises, for example, from  terminals
1596        like  the  Concept  with more than one page of memory.  If the terminal
1597        has only memory relative cursor  addressing  and  not  screen  relative
1598        cursor  addressing,  a  one  screen-sized window must be fixed into the
1599        terminal for cursor addressing to work properly.  This is also used for
1600        the  TEKTRONIX  4025,  where <STRONG>smcup</STRONG> sets the command character to be the
1601        one used by terminfo.  If the  <STRONG>smcup</STRONG>  sequence  will  not  restore  the
1602        screen  after  an  <STRONG>rmcup</STRONG>  sequence  is  output  (to  the state prior to
1603        outputting <STRONG>rmcup</STRONG>), specify <STRONG>nrrmc</STRONG>.
1604
1605
1606 </PRE><H3><a name="h3-Margins">Margins</a></H3><PRE>
1607        SVr4 (and X/Open Curses) list several string capabilities  for  setting
1608        margins.   Two  were  intended  for use with terminals, and another six
1609        were intended for use with printers.
1610
1611        <STRONG>o</STRONG>   The two terminal capabilities assume that the terminal may have the
1612            capability  of  setting the left and/or right margin at the current
1613            cursor column position.
1614
1615        <STRONG>o</STRONG>   The printer capabilities assume that the printer may have two types
1616            of capability:
1617
1618            <STRONG>o</STRONG>   the ability to set a top and/or bottom margin using the current
1619                line position, and
1620
1621            <STRONG>o</STRONG>   parameterized capabilities for setting the top,  bottom,  left,
1622                right margins given the number of rows or columns.
1623
1624        In  practice,  the  categorization into "terminal" and "printer" is not
1625        suitable:
1626
1627        <STRONG>o</STRONG>   The AT&amp;T SVr4 terminal database uses  <STRONG>smgl</STRONG>  four  times,  for  AT&amp;T
1628            hardware.
1629
1630            Three  of  the  four  are  printers.   They lack the ability to set
1631            left/right margins by specifying the column.
1632
1633        <STRONG>o</STRONG>   Other (non-AT&amp;T) terminals may support margins but using  different
1634            assumptions from AT&amp;T.
1635
1636            For  instance,  the DEC VT420 supports left/right margins, but only
1637            using a column parameter.  As an added complication, the VT420 uses
1638            two  settings to fully enable left/right margins (left/right margin
1639            mode, and origin mode).  The  former  enables  the  margins,  which
1640            causes  printed  text  to  wrap  within  margins, but the latter is
1641            needed to prevent cursor-addressing outside those margins.
1642
1643        <STRONG>o</STRONG>   Both DEC VT420 left/right margins are set  with  a  single  control
1644            sequence.  If either is omitted, the corresponding margin is set to
1645            the left or right edge of the  display  (rather  than  leaving  the
1646            margin unmodified).
1647
1648        These are the margin-related capabilities:
1649
1650                 <STRONG>Name</STRONG>       <STRONG>Description</STRONG>
1651                 ------------------------------------------------------
1652                 smgl       Set left margin at current column
1653                 smgr       Set right margin at current column
1654                 smgb       Set bottom margin at current line
1655                 smgt       Set top margin at current line
1656                 smgbp      Set bottom margin at line <EM>N</EM>
1657                 smglp      Set left margin at column <EM>N</EM>
1658                 smgrp      Set right margin at column <EM>N</EM>
1659                 smgtp      Set top margin at line <EM>N</EM>
1660                 smglr      Set both left and right margins to <EM>L</EM> and <EM>R</EM>
1661                 smgtb      Set both top and bottom margins to <EM>T</EM> and <EM>B</EM>
1662
1663        When  writing  an  application that uses these string capabilities, the
1664        pairs should be first checked to see if each capability in the pair  is
1665        set or only one is set:
1666
1667        <STRONG>o</STRONG>   If  both  <STRONG>smglp</STRONG>  and  <STRONG>smgrp</STRONG>  are  set,  each  is used with a single
1668            argument, <EM>N</EM>, that gives the column number of  the  left  and  right
1669            margin, respectively.
1670
1671        <STRONG>o</STRONG>   If  both  <STRONG>smgtp</STRONG>  and <STRONG>smgbp</STRONG> are set, each is used to set the top and
1672            bottom margin, respectively:
1673
1674            <STRONG>o</STRONG>   <STRONG>smgtp</STRONG> is used with a single argument, <EM>N</EM>, the line number of the
1675                top margin.
1676
1677            <STRONG>o</STRONG>   <STRONG>smgbp</STRONG>  is  used with two arguments, <EM>N</EM> and <EM>M</EM>, that give the line
1678                number of the bottom margin, the first counting from the top of
1679                the  page  and  the  second  counting  from  the  bottom.  This
1680                accommodates the two styles of specifying the bottom margin  in
1681                different manufacturers' printers.
1682
1683            When  designing  a terminfo entry for a printer that has a settable
1684            bottom margin, only the first or second argument  should  be  used,
1685            depending on the printer.  When developing an application that uses
1686            <STRONG>smgbp</STRONG> to set the bottom margin, both arguments must be given.
1687
1688        Conversely, when only one capability in the pair is set:
1689
1690        <STRONG>o</STRONG>   If only one of <STRONG>smglp</STRONG> and <STRONG>smgrp</STRONG> is set, then it  is  used  with  two
1691            arguments, the column number of the left and right margins, in that
1692            order.
1693
1694        <STRONG>o</STRONG>   Likewise, if only one of <STRONG>smgtp</STRONG> and <STRONG>smgbp</STRONG> is set, then  it  is  used
1695            with  two  arguments  that give the top and bottom margins, in that
1696            order, counting from the top of the page.
1697
1698            When designing a terminfo entry for a printer that requires setting
1699            both  left and right or top and bottom margins simultaneously, only
1700            one capability in the pairs <STRONG>smglp</STRONG> and  <STRONG>smgrp</STRONG>  or  <STRONG>smgtp</STRONG>  and  <STRONG>smgbp</STRONG>
1701            should be defined, leaving the other unset.
1702
1703        Except  for  very  old terminal descriptions, e.g., those developed for
1704        SVr4, the scheme just described  should  be  considered  obsolete.   An
1705        improved set of capabilities was added late in the SVr4 releases (<STRONG>smglr</STRONG>
1706        and <STRONG>smgtb</STRONG>),  which  explicitly  use  two  parameters  for  setting  the
1707        left/right or top/bottom margins.
1708
1709        When setting margins, the line- and column-values are zero-based.
1710
1711        The  <STRONG>mgc</STRONG>  string  capability  should  be defined.  Applications such as
1712        <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG> rely upon this to reset all margins.
1713
1714
1715 </PRE><H3><a name="h3-Area-Clears">Area Clears</a></H3><PRE>
1716        If the terminal can clear from the current position to the end  of  the
1717        line,  leaving  the cursor where it is, this should be given as <STRONG>el</STRONG>.  If
1718        the terminal can clear from the beginning of the line  to  the  current
1719        position  inclusive,  leaving  the  cursor  where it is, this should be
1720        given as <STRONG>el1</STRONG>.  If the terminal can clear from the current  position  to
1721        the  end  of  the display, then this should be given as <STRONG>ed</STRONG>.  <STRONG>Ed</STRONG> is only
1722        defined from the first column of a line.  (Thus, it can be simulated by
1723        a  request  to  delete  a  large  number  of lines, if a true <STRONG>ed</STRONG> is not
1724        available.)
1725
1726
1727 </PRE><H3><a name="h3-Insert_delete-line-and-vertical-motions">Insert/delete line and vertical motions</a></H3><PRE>
1728        If the terminal can open a new blank line before  the  line  where  the
1729        cursor  is,  this  should  be  given as <STRONG>il1</STRONG>; this is done only from the
1730        first position of a line.  The cursor must then  appear  on  the  newly
1731        blank  line.   If  the terminal can delete the line which the cursor is
1732        on, then this should be given as <STRONG>dl1</STRONG>; this is done only from the  first
1733        position on the line to be deleted.  Versions of <STRONG>il1</STRONG> and <STRONG>dl1</STRONG> which take
1734        a single parameter and insert or delete that many lines can be given as
1735        <STRONG>il</STRONG> and <STRONG>dl</STRONG>.
1736
1737        If  the  terminal  has a settable scrolling region (like the vt100) the
1738        command to set this can be described with  the  <STRONG>csr</STRONG>  capability,  which
1739        takes two parameters: the top and bottom lines of the scrolling region.
1740        The cursor position is, alas, undefined after using this command.
1741
1742        It is possible to get the effect of insert or delete line using <STRONG>csr</STRONG>  on
1743        a  properly  chosen  region;  the  <STRONG>sc</STRONG>  and <STRONG>rc</STRONG> (save and restore cursor)
1744        commands may be useful for ensuring that your synthesized insert/delete
1745        string  does  not  move the cursor.  (Note that the <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> library
1746        does  this  synthesis  automatically,   so   you   need   not   compose
1747        insert/delete strings for an entry with <STRONG>csr</STRONG>).
1748
1749        Yet  another  way  to  construct  insert  and  delete might be to use a
1750        combination of  index  with  the  memory-lock  feature  found  on  some
1751        terminals   (like   the   HP-700/90  series,  which  however  also  has
1752        insert/delete).
1753
1754        Inserting lines at the top or bottom of the screen  can  also  be  done
1755        using  <STRONG>ri</STRONG>  or  <STRONG>ind</STRONG> on many terminals without a true insert/delete line,
1756        and is often faster even on terminals with those features.
1757
1758        The boolean <STRONG>non_dest_scroll_region</STRONG> should  be  set  if  each  scrolling
1759        window  is  effectively  a view port on a screen-sized canvas.  To test
1760        for this capability, create a scrolling region in  the  middle  of  the
1761        screen,  write something to the bottom line, move the cursor to the top
1762        of the region, and do <STRONG>ri</STRONG> followed by <STRONG>dl1</STRONG> or <STRONG>ind</STRONG>.  If the data  scrolled
1763        off  the  bottom  of the region by the <STRONG>ri</STRONG> re-appears, then scrolling is
1764        non-destructive.  System V and XSI Curses expect that  <STRONG>ind</STRONG>,  <STRONG>ri</STRONG>,  <STRONG>indn</STRONG>,
1765        and  <STRONG>rin</STRONG>  will  simulate  destructive  scrolling;  their  documentation
1766        cautions you not to define  <STRONG>csr</STRONG>  unless  this  is  true.   This  <STRONG>curses</STRONG>
1767        implementation  is  more  liberal  and  will  do  explicit erases after
1768        scrolling if <STRONG>ndsrc</STRONG> is defined.
1769
1770        If the terminal has the ability to define a window as part  of  memory,
1771        which  all  commands  affect,  it  should be given as the parameterized
1772        string <STRONG>wind</STRONG>.  The four parameters are the starting and ending lines  in
1773        memory and the starting and ending columns in memory, in that order.
1774
1775        If the terminal can retain display memory above, then the <STRONG>da</STRONG> capability
1776        should be given; if display memory  can  be  retained  below,  then  <STRONG>db</STRONG>
1777        should  be given.  These indicate that deleting a line or scrolling may
1778        bring non-blank lines up from below or that scrolling back with <STRONG>ri</STRONG>  may
1779        bring down non-blank lines.
1780
1781
1782 </PRE><H3><a name="h3-Insert_Delete-Character">Insert/Delete Character</a></H3><PRE>
1783        There  are  two  basic  kinds  of intelligent terminals with respect to
1784        insert/delete character which can be  described  using  <EM>terminfo.</EM>   The
1785        most   common   insert/delete  character  operations  affect  only  the
1786        characters on the current line and shift characters off the end of  the
1787        line  rigidly.  Other terminals, such as the Concept 100 and the Perkin
1788        Elmer Owl, make a distinction between typed and untyped blanks  on  the
1789        screen,  shifting  upon an insert or delete only to an untyped blank on
1790        the screen which is either  eliminated,  or  expanded  to  two  untyped
1791        blanks.
1792
1793        You  can determine the kind of terminal you have by clearing the screen
1794        and then typing text separated by cursor  motions.   Type  "abc    def"
1795        using  local  cursor  motions  (not  spaces)  between the "abc" and the
1796        "def".  Then position the cursor before the "abc" and put the  terminal
1797        in  insert  mode.   If typing characters causes the rest of the line to
1798        shift rigidly and characters to fall off the end,  then  your  terminal
1799        does  not  distinguish  between  blanks  and untyped positions.  If the
1800        "abc" shifts over to the "def" which then move together around the  end
1801        of  the  current  line  and  onto  the next as you insert, you have the
1802        second type of terminal, and  should  give  the  capability  <STRONG>in</STRONG>,  which
1803        stands for "insert null".
1804
1805        While  these  are  two  logically  separate attributes (one line versus
1806        multi-line insert mode, and special treatment  of  untyped  spaces)  we
1807        have  seen  no terminals whose insert mode cannot be described with the
1808        single attribute.
1809
1810        Terminfo can describe both terminals which have  an  insert  mode,  and
1811        terminals  which send a simple sequence to open a blank position on the
1812        current line.  Give as <STRONG>smir</STRONG> the sequence to get into insert mode.  Give
1813        as  <STRONG>rmir</STRONG>  the  sequence  to  leave  insert  mode.  Now give as <STRONG>ich1</STRONG> any
1814        sequence needed to be sent just before  sending  the  character  to  be
1815        inserted.   Most  terminals with a true insert mode will not give <STRONG>ich1</STRONG>;
1816        terminals which send a sequence to open a screen position  should  give
1817        it here.
1818
1819        If  your  terminal has both, insert mode is usually preferable to <STRONG>ich1</STRONG>.
1820        Technically, you should not give  both  unless  the  terminal  actually
1821        requires  both to be used in combination.  Accordingly, some non-curses
1822        applications get confused if both are present; the symptom  is  doubled
1823        characters  in  an  update using insert.  This requirement is now rare;
1824        most <STRONG>ich</STRONG> sequences do not require previous smir, and most  smir  insert
1825        modes  do  not  require <STRONG>ich1</STRONG> before each character.  Therefore, the new
1826        <STRONG>curses</STRONG> actually assumes this is the case and uses either  <STRONG>rmir</STRONG>/<STRONG>smir</STRONG>  or
1827        <STRONG>ich</STRONG>/<STRONG>ich1</STRONG>  as appropriate (but not both).  If you have to write an entry
1828        to be used under new curses for a terminal old  enough  to  need  both,
1829        include the <STRONG>rmir</STRONG>/<STRONG>smir</STRONG> sequences in <STRONG>ich1</STRONG>.
1830
1831        If post insert padding is needed, give this as a number of milliseconds
1832        in <STRONG>ip</STRONG> (a string option).  Any other sequence which may need to be  sent
1833        after an insert of a single character may also be given in <STRONG>ip</STRONG>.  If your
1834        terminal needs both to be placed into an "insert mode"  and  a  special
1835        code  to  precede each inserted character, then both <STRONG>smir</STRONG>/<STRONG>rmir</STRONG> and <STRONG>ich1</STRONG>
1836        can be given, and both will be used.   The  <STRONG>ich</STRONG>  capability,  with  one
1837        parameter, <EM>n</EM>, will repeat the effects of <STRONG>ich1</STRONG> <EM>n</EM> times.
1838
1839        If  padding  is  necessary between characters typed while not in insert
1840        mode, give this as a number of milliseconds padding in <STRONG>rmp</STRONG>.
1841
1842        It is occasionally necessary to move around while  in  insert  mode  to
1843        delete  characters  on the same line (e.g., if there is a tab after the
1844        insertion position).  If your terminal allows motion  while  in  insert
1845        mode  you  can  give  the  capability <STRONG>mir</STRONG> to speed up inserting in this
1846        case.  Omitting <STRONG>mir</STRONG> will affect only speed.   Some  terminals  (notably
1847        Datamedia's)  must  not  have  <STRONG>mir</STRONG> because of the way their insert mode
1848        works.
1849
1850        Finally, you can specify <STRONG>dch1</STRONG> to delete a single  character,  <STRONG>dch</STRONG>  with
1851        one  parameter,  <EM>n</EM>,  to  delete <EM>n</EM> <EM>characters,</EM> and delete mode by giving
1852        <STRONG>smdc</STRONG> and <STRONG>rmdc</STRONG> to enter and exit delete  mode  (any  mode  the  terminal
1853        needs to be placed in for <STRONG>dch1</STRONG> to work).
1854
1855        A  command  to  erase  <EM>n</EM>  characters (equivalent to outputting <EM>n</EM> blanks
1856        without moving the cursor) can be given as <STRONG>ech</STRONG> with one parameter.
1857
1858
1859 </PRE><H3><a name="h3-Highlighting_-Underlining_-and-Visible-Bells">Highlighting, Underlining, and Visible Bells</a></H3><PRE>
1860        If your terminal has one or more kinds of display attributes, these can
1861        be  represented  in  a number of different ways.  You should choose one
1862        display form as <EM>standout</EM> <EM>mode</EM>,  representing  a  good,  high  contrast,
1863        easy-on-the-eyes,  format  for  highlighting  error  messages and other
1864        attention getters.  (If you have a choice,  reverse  video  plus  half-
1865        bright  is  good,  or reverse video alone.)  The sequences to enter and
1866        exit standout mode are given as <STRONG>smso</STRONG> and <STRONG>rmso</STRONG>,  respectively.   If  the
1867        code  to  change  into  or  out of standout mode leaves one or even two
1868        blank spaces on the screen, as the TVI 912 and Teleray  1061  do,  then
1869        <STRONG>xmc</STRONG> should be given to tell how many spaces are left.
1870
1871        Codes to begin underlining and end underlining can be given as <STRONG>smul</STRONG> and
1872        <STRONG>rmul</STRONG> respectively.  If the terminal has a code to underline the current
1873        character  and  move  the  cursor  one  space to the right, such as the
1874        Microterm Mime, this can be given as <STRONG>uc</STRONG>.
1875
1876        Other capabilities to enter various highlighting  modes  include  <STRONG>blink</STRONG>
1877        (blinking)  <STRONG>bold</STRONG>  (bold or extra bright) <STRONG>dim</STRONG> (dim or half-bright) <STRONG>invis</STRONG>
1878        (blanking or invisible text) <STRONG>prot</STRONG> (protected) <STRONG>rev</STRONG> (reverse video)  <STRONG>sgr0</STRONG>
1879        (turn  off  <EM>all</EM>  attribute  modes) <STRONG>smacs</STRONG> (enter alternate character set
1880        mode) and <STRONG>rmacs</STRONG> (exit alternate character set mode).  Turning on any of
1881        these modes singly may or may not turn off other modes.
1882
1883        If  there  is  a  sequence to set arbitrary combinations of modes, this
1884        should be given as <STRONG>sgr</STRONG> (set attributes),  taking  9  parameters.   Each
1885        parameter  is either 0 or nonzero, as the corresponding attribute is on
1886        or off.  The 9 parameters are, in order: standout, underline,  reverse,
1887        blink,  dim,  bold,  blank,  protect, alternate character set.  Not all
1888        modes need be supported by <STRONG>sgr</STRONG>,  only  those  for  which  corresponding
1889        separate attribute commands exist.
1890
1891        For example, the DEC vt220 supports most of the modes:
1892
1893                <STRONG>tparm</STRONG> <STRONG>parameter</STRONG>      <STRONG>attribute</STRONG>        <STRONG>escape</STRONG> <STRONG>sequence</STRONG>
1894
1895                none                 none             \E[0m
1896                p1                   standout         \E[0;1;7m
1897                p2                   underline        \E[0;4m
1898                p3                   reverse          \E[0;7m
1899                p4                   blink            \E[0;5m
1900                p5                   dim              not available
1901                p6                   bold             \E[0;1m
1902                p7                   invis            \E[0;8m
1903                p8                   protect          not used
1904                p9                   altcharset       ^O (off) ^N (on)
1905
1906        We  begin each escape sequence by turning off any existing modes, since
1907        there is no quick way to determine whether they are  active.   Standout
1908        is  set  up  to  be  the  combination  of  reverse and bold.  The vt220
1909        terminal has a protect mode, though it is  not  commonly  used  in  sgr
1910        because  it protects characters on the screen from the host's erasures.
1911        The altcharset mode also is different in that it is either  ^O  or  ^N,
1912        depending  on whether it is off or on.  If all modes are turned on, the
1913        resulting sequence is \E[0;1;4;5;7;8m^N.
1914
1915        Some sequences are common to  different  modes.   For  example,  ;7  is
1916        output  when  either  p1  or p3 is true, that is, if either standout or
1917        reverse modes are turned on.
1918
1919        Writing out the above sequences, along with their dependencies yields
1920
1921             <STRONG>sequence</STRONG>             <STRONG>when</STRONG> <STRONG>to</STRONG> <STRONG>output</STRONG>      <STRONG>terminfo</STRONG> <STRONG>translation</STRONG>
1922
1923             \E[0                 always              \E[0
1924             ;1                   if p1 or p6         %?%p1%p6%|%t;1%;
1925             ;4                   if p2               %?%p2%|%t;4%;
1926             ;5                   if p4               %?%p4%|%t;5%;
1927             ;7                   if p1 or p3         %?%p1%p3%|%t;7%;
1928             ;8                   if p7               %?%p7%|%t;8%;
1929             m                    always              m
1930             ^N or ^O             if p9 ^N, else ^O   %?%p9%t^N%e^O%;
1931
1932        Putting this all together into the sgr sequence gives:
1933
1934            sgr=\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p4%t;5%;
1935                %?%p1%p3%|%t;7%;%?%p7%t;8%;m%?%p9%t\016%e\017%;,
1936
1937        Remember that if you specify sgr, you must also  specify  sgr0.   Also,
1938        some  implementations  rely  on  sgr  being  given  if sgr0 is, Not all
1939        terminfo  entries  necessarily  have  an  sgr  string,  however.   Many
1940        terminfo  entries  are  derived  from termcap entries which have no sgr
1941        string.  The only drawback to adding an sgr string is that termcap also
1942        assumes that sgr0 does not exit alternate character set mode.
1943
1944        Terminals   with  the  "magic  cookie"  glitch  (<STRONG>xmc</STRONG>)  deposit  special
1945        "cookies" when they receive mode-setting sequences,  which  affect  the
1946        display  algorithm  rather  than  having extra bits for each character.
1947        Some terminals, such as the HP 2621, automatically leave standout  mode
1948        when  they  move  to  a  new line or the cursor is addressed.  Programs
1949        using standout mode should exit standout mode before moving the  cursor
1950        or  sending a newline, unless the <STRONG>msgr</STRONG> capability, asserting that it is
1951        safe to move in standout mode, is present.
1952
1953        If the terminal has a way of flashing the screen to indicate  an  error
1954        quietly  (a  bell replacement) then this can be given as <STRONG>flash</STRONG>; it must
1955        not move the cursor.
1956
1957        If the cursor needs to be made more visible than normal when it is  not
1958        on the bottom line (to make, for example, a non-blinking underline into
1959        an easier to find block or blinking underline) give  this  sequence  as
1960        <STRONG>cvvis</STRONG>.  If there is a way to make the cursor completely invisible, give
1961        that as <STRONG>civis</STRONG>.  The capability <STRONG>cnorm</STRONG> should be given which  undoes  the
1962        effects of both of these modes.
1963
1964        If  your  terminal  correctly  generates underlined characters (with no
1965        special codes needed) even though it  does  not  overstrike,  then  you
1966        should  give  the  capability  <STRONG>ul</STRONG>.  If a character overstriking another
1967        leaves both characters on the screen, specify the  capability  <STRONG>os</STRONG>.   If
1968        overstrikes are erasable with a blank, then this should be indicated by
1969        giving <STRONG>eo</STRONG>.
1970
1971
1972 </PRE><H3><a name="h3-Keypad-and-Function-Keys">Keypad and Function Keys</a></H3><PRE>
1973        If the terminal has a keypad that transmits codes  when  the  keys  are
1974        pressed,  this  information can be given.  Note that it is not possible
1975        to handle terminals where the keypad only works in local (this applies,
1976        for  example, to the unshifted HP 2621 keys).  If the keypad can be set
1977        to transmit or not  transmit,  give  these  codes  as  <STRONG>smkx</STRONG>  and  <STRONG>rmkx</STRONG>.
1978        Otherwise the keypad is assumed to always transmit.
1979
1980        The  codes  sent  by the left arrow, right arrow, up arrow, down arrow,
1981        and home keys can be given as <STRONG>kcub1,</STRONG> <STRONG>kcuf1,</STRONG>  <STRONG>kcuu1,</STRONG>  <STRONG>kcud1,</STRONG>  and  <STRONG>khome</STRONG>
1982        respectively.  If there are function keys such as f0, f1, ..., f10, the
1983        codes they send can be given as <STRONG>kf0,</STRONG> <STRONG>kf1,</STRONG> <STRONG>...,</STRONG>  <STRONG>kf10</STRONG>.   If  these  keys
1984        have  labels  other  than the default f0 through f10, the labels can be
1985        given as <STRONG>lf0,</STRONG> <STRONG>lf1,</STRONG> <STRONG>...,</STRONG> <STRONG>lf10</STRONG>.
1986
1987        The codes transmitted by certain other special keys can be given:
1988
1989        <STRONG>o</STRONG>   <STRONG>kll</STRONG> (home down),
1990
1991        <STRONG>o</STRONG>   <STRONG>kbs</STRONG> (backspace),
1992
1993        <STRONG>o</STRONG>   <STRONG>ktbc</STRONG> (clear all tabs),
1994
1995        <STRONG>o</STRONG>   <STRONG>kctab</STRONG> (clear the tab stop in this column),
1996
1997        <STRONG>o</STRONG>   <STRONG>kclr</STRONG> (clear screen or erase key),
1998
1999        <STRONG>o</STRONG>   <STRONG>kdch1</STRONG> (delete character),
2000
2001        <STRONG>o</STRONG>   <STRONG>kdl1</STRONG> (delete line),
2002
2003        <STRONG>o</STRONG>   <STRONG>krmir</STRONG> (exit insert mode),
2004
2005        <STRONG>o</STRONG>   <STRONG>kel</STRONG> (clear to end of line),
2006
2007        <STRONG>o</STRONG>   <STRONG>ked</STRONG> (clear to end of screen),
2008
2009        <STRONG>o</STRONG>   <STRONG>kich1</STRONG> (insert character or enter insert mode),
2010
2011        <STRONG>o</STRONG>   <STRONG>kil1</STRONG> (insert line),
2012
2013        <STRONG>o</STRONG>   <STRONG>knp</STRONG> (next page),
2014
2015        <STRONG>o</STRONG>   <STRONG>kpp</STRONG> (previous page),
2016
2017        <STRONG>o</STRONG>   <STRONG>kind</STRONG> (scroll forward/down),
2018
2019        <STRONG>o</STRONG>   <STRONG>kri</STRONG> (scroll backward/up),
2020
2021        <STRONG>o</STRONG>   <STRONG>khts</STRONG> (set a tab stop in this column).
2022
2023        In addition, if the keypad has a 3 by 3 array  of  keys  including  the
2024        four  arrow  keys,  the  other five keys can be given as <STRONG>ka1</STRONG>, <STRONG>ka3</STRONG>, <STRONG>kb2</STRONG>,
2025        <STRONG>kc1</STRONG>, and <STRONG>kc3</STRONG>.  These keys are useful when the  effects  of  a  3  by  3
2026        directional pad are needed.
2027
2028        Strings to program function keys can be given as <STRONG>pfkey</STRONG>, <STRONG>pfloc</STRONG>, and <STRONG>pfx</STRONG>.
2029        A string to program screen labels should be specified as <STRONG>pln</STRONG>.  Each  of
2030        these  strings takes two parameters: the function key number to program
2031        (from 0 to 10) and the string to program it with.  Function key numbers
2032        out  of  this  range may program undefined keys in a terminal dependent
2033        manner.  The difference between the capabilities is that  <STRONG>pfkey</STRONG>  causes
2034        pressing  the  given  key  to  be the same as the user typing the given
2035        string; <STRONG>pfloc</STRONG> causes the string to  be  executed  by  the  terminal  in
2036        local; and <STRONG>pfx</STRONG> causes the string to be transmitted to the computer.
2037
2038        The  capabilities  <STRONG>nlab</STRONG>,  <STRONG>lw</STRONG>  and  <STRONG>lh</STRONG> define the number of programmable
2039        screen labels and their width and height.  If  there  are  commands  to
2040        turn  the  labels  on  and  off,  give  them in <STRONG>smln</STRONG> and <STRONG>rmln</STRONG>.  <STRONG>smln</STRONG> is
2041        normally output after one or more pln sequences to make sure  that  the
2042        change becomes visible.
2043
2044
2045 </PRE><H3><a name="h3-Tabs-and-Initialization">Tabs and Initialization</a></H3><PRE>
2046        A few capabilities are used only for tabs:
2047
2048        <STRONG>o</STRONG>   If  the  terminal  has hardware tabs, the command to advance to the
2049            next tab stop can be given as <STRONG>ht</STRONG> (usually control/I).
2050
2051        <STRONG>o</STRONG>   A "back-tab" command which moves leftward to the preceding tab stop
2052            can be given as <STRONG>cbt</STRONG>.
2053
2054            By  convention,  if the teletype modes indicate that tabs are being
2055            expanded by the computer rather than being sent  to  the  terminal,
2056            programs  should  not use <STRONG>ht</STRONG> or <STRONG>cbt</STRONG> even if they are present, since
2057            the user may not have the tab stops properly set.
2058
2059        <STRONG>o</STRONG>   If the terminal has hardware tabs which are initially set  every  <EM>n</EM>
2060            spaces when the terminal is powered up, the numeric parameter <STRONG>it</STRONG> is
2061            given, showing the number of spaces the tabs are set to.
2062
2063            The <STRONG>it</STRONG> capability is normally used by the <STRONG>tset</STRONG> command to determine
2064            whether  to set the mode for hardware tab expansion, and whether to
2065            set the tab stops.  If the terminal has tab stops that can be saved
2066            in  non-volatile  memory,  the terminfo description can assume that
2067            they are properly set.
2068
2069        Other capabilities include
2070
2071        <STRONG>o</STRONG>   <STRONG>is1</STRONG>, <STRONG>is2</STRONG>, and <STRONG>is3</STRONG>, initialization strings for the terminal,
2072
2073        <STRONG>o</STRONG>   <STRONG>iprog</STRONG>, the path name of a program  to  be  run  to  initialize  the
2074            terminal,
2075
2076        <STRONG>o</STRONG>   and <STRONG>if</STRONG>, the name of a file containing long initialization strings.
2077
2078        These  strings  are  expected to set the terminal into modes consistent
2079        with the rest of the terminfo description.  They are normally  sent  to
2080        the  terminal,  by  the  <EM>init</EM> option of the <STRONG>tput</STRONG> program, each time the
2081        user logs in.  They will be printed in the following order:
2082
2083               run the program
2084                      <STRONG>iprog</STRONG>
2085
2086               output
2087                      <STRONG>is1</STRONG> and
2088                      <STRONG>is2</STRONG>
2089
2090               set the margins using
2091                      <STRONG>mgc</STRONG> or
2092                      <STRONG>smglp</STRONG> and <STRONG>smgrp</STRONG> or
2093                      <STRONG>smgl</STRONG> and <STRONG>smgr</STRONG>
2094
2095               set tabs using
2096                      <STRONG>tbc</STRONG> and <STRONG>hts</STRONG>
2097
2098               print the file
2099                      <STRONG>if</STRONG>
2100
2101               and finally output
2102                      <STRONG>is3</STRONG>.
2103
2104        Most initialization is done with <STRONG>is2</STRONG>.  Special terminal  modes  can  be
2105        set  up  without duplicating strings by putting the common sequences in
2106        <STRONG>is2</STRONG> and special cases in <STRONG>is1</STRONG> and <STRONG>is3</STRONG>.
2107
2108        A set of sequences that does a harder  reset  from  a  totally  unknown
2109        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>
2110        and <STRONG>is3</STRONG> respectively.  These strings are  output  by  <EM>reset</EM>  option  of
2111        <STRONG>tput</STRONG>,  or  by  the <STRONG>reset</STRONG> program (an alias of <STRONG>tset</STRONG>), which is used when
2112        the terminal gets into a wedged state.  Commands are normally placed in
2113        <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG> <STRONG>rs3</STRONG> and <STRONG>rf</STRONG> only if they produce annoying effects on the screen
2114        and are not necessary when logging in.  For example, the command to set
2115        the  vt100  into  80-column  mode would normally be part of <STRONG>is2</STRONG>, but it
2116        causes an annoying glitch of the screen  and  is  not  normally  needed
2117        since the terminal is usually already in 80-column mode.
2118
2119        The  <STRONG>reset</STRONG>  program  writes  strings including <STRONG>iprog</STRONG>, etc., in the same
2120        order as the <EM>init</EM> program, using <STRONG>rs1</STRONG>, etc., instead of  <STRONG>is1</STRONG>,  etc.   If
2121        any  of  <STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, or <STRONG>rf</STRONG> reset capability strings are missing, the
2122        <STRONG>reset</STRONG>  program  falls  back  upon  the   corresponding   initialization
2123        capability string.
2124
2125        If  there are commands to set and clear tab stops, they can be given as
2126        <STRONG>tbc</STRONG> (clear all tab stops) and <STRONG>hts</STRONG> (set a tab stop in the current column
2127        of  every  row).   If a more complex sequence is needed to set the tabs
2128        than can be described by this, the sequence can be placed in <STRONG>is2</STRONG> or <STRONG>if</STRONG>.
2129
2130        The <STRONG>tput</STRONG> <STRONG>reset</STRONG> command uses the same capability strings  as  the  <STRONG>reset</STRONG>
2131        command,  although  the two programs (<STRONG>tput</STRONG> and <STRONG>reset</STRONG>) provide different
2132        command-line options.
2133
2134        In  practice,  these  terminfo  capabilities  are  not  often  used  in
2135        initialization of tabs (though they are required for the <STRONG>tabs</STRONG> program):
2136
2137        <STRONG>o</STRONG>   Almost all hardware terminals (at least those which supported tabs)
2138            initialized those to every <EM>eight</EM> columns:
2139
2140            The only exception was the AT&amp;T 2300  series,  which  set  tabs  to
2141            every <EM>five</EM> columns.
2142
2143        <STRONG>o</STRONG>   In  particular,  developers  of  the  hardware  terminals which are
2144            commonly used as models  for  modern  terminal  emulators  provided
2145            documentation demonstrating that <EM>eight</EM> columns were the standard.
2146
2147        <STRONG>o</STRONG>   Because of this, the terminal initialization programs <STRONG>tput</STRONG> and <STRONG>tset</STRONG>
2148            use  the  <STRONG>tbc</STRONG>  (<STRONG>clear_all_tabs</STRONG>)  and  <STRONG>hts</STRONG>  (<STRONG>set_tab</STRONG>)   capabilities
2149            directly  only when the <STRONG>it</STRONG> (<STRONG>init_tabs</STRONG>) capability is set to a value
2150            other than <EM>eight</EM>.
2151
2152
2153 </PRE><H3><a name="h3-Delays-and-Padding">Delays and Padding</a></H3><PRE>
2154        Many older and slower terminals do not support either XON/XOFF  or  DTR
2155        handshaking,  including  hard copy terminals and some very archaic CRTs
2156        (including, for  example,  DEC  VT100s).   These  may  require  padding
2157        characters after certain cursor motions and screen changes.
2158
2159        If the terminal uses xon/xoff handshaking for flow control (that is, it
2160        automatically emits ^S back to the host  when  its  input  buffers  are
2161        close  to  full),  set <STRONG>xon</STRONG>.  This capability suppresses the emission of
2162        padding.  You  can  also  set  it  for  memory-mapped  console  devices
2163        effectively that do not have a speed limit.  Padding information should
2164        still be included so that routines  can  make  better  decisions  about
2165        relative costs, but actual pad characters will not be transmitted.
2166
2167        If <STRONG>pb</STRONG> (padding baud rate) is given, padding is suppressed at baud rates
2168        below the value of <STRONG>pb</STRONG>.  If the entry has no  padding  baud  rate,  then
2169        whether padding is emitted or not is completely controlled by <STRONG>xon</STRONG>.
2170
2171        If  the  terminal requires other than a null (zero) character as a pad,
2172        then this can be given as <STRONG>pad</STRONG>.  Only the first  character  of  the  <STRONG>pad</STRONG>
2173        string is used.
2174
2175
2176 </PRE><H3><a name="h3-Status-Lines">Status Lines</a></H3><PRE>
2177        Some  terminals  have an extra "status line" which is not normally used
2178        by software (and thus not counted in the terminal's <STRONG>lines</STRONG> capability).
2179
2180        The simplest case is a status line which is cursor-addressable but  not
2181        part of the main scrolling region on the screen; the Heathkit H19 has a
2182        status line of this kind, as would  a  24-line  VT100  with  a  23-line
2183        scrolling region set up on initialization.  This situation is indicated
2184        by the <STRONG>hs</STRONG> capability.
2185
2186        Some terminals with status lines need special sequences to  access  the
2187        status  line.  These may be expressed as a string with single parameter
2188        <STRONG>tsl</STRONG> which takes the cursor to a given zero-origin column on the  status
2189        line.   The  capability  <STRONG>fsl</STRONG>  must  return  to  the  main-screen cursor
2190        positions before the last <STRONG>tsl</STRONG>.  You may need to embed the string values
2191        of  <STRONG>sc</STRONG>  (save  cursor)  and  <STRONG>rc</STRONG>  (restore  cursor)  in  <STRONG>tsl</STRONG>  and <STRONG>fsl</STRONG> to
2192        accomplish this.
2193
2194        The status line is normally assumed to be the same width as  the  width
2195        of  the  terminal.   If  this  is  untrue,  you can specify it with the
2196        numeric capability <STRONG>wsl</STRONG>.
2197
2198        A command to erase or blank the status line may be specified as <STRONG>dsl</STRONG>.
2199
2200        The boolean capability <STRONG>eslok</STRONG> specifies  that  escape  sequences,  tabs,
2201        etc., work ordinarily in the status line.
2202
2203        The  <STRONG>ncurses</STRONG> implementation does not yet use any of these capabilities.
2204        They are documented here in case they ever become important.
2205
2206
2207 </PRE><H3><a name="h3-Line-Graphics">Line Graphics</a></H3><PRE>
2208        Many terminals have alternate character sets useful for  forms-drawing.
2209        Terminfo  and  <STRONG>curses</STRONG>  have  built-in  support  for most of the drawing
2210        characters supported by the VT100, with some characters from  the  AT&amp;T
2211        4410v1  added.   This  alternate  character set may be specified by the
2212        <STRONG>acsc</STRONG> capability.
2213
2214          <STRONG>Glyph</STRONG>                       <STRONG>ACS</STRONG>            <STRONG>Ascii</STRONG>     <STRONG>acsc</STRONG>     <STRONG>acsc</STRONG>
2215          <STRONG>Name</STRONG>                        <STRONG>Name</STRONG>           <STRONG>Default</STRONG>   <STRONG>Char</STRONG>     <STRONG>Value</STRONG>
2216          --------------------------------------------------------------------
2217          arrow pointing right        ACS_RARROW     &gt;         +        0x2b
2218          arrow pointing left         ACS_LARROW     &lt;         ,        0x2c
2219          arrow pointing up           ACS_UARROW     ^         -        0x2d
2220          arrow pointing down         ACS_DARROW     v         .        0x2e
2221          solid square block          ACS_BLOCK      #         0        0x30
2222          diamond                     ACS_DIAMOND    +         `        0x60
2223          checker board (stipple)     ACS_CKBOARD    :         a        0x61
2224          degree symbol               ACS_DEGREE     \         f        0x66
2225          plus/minus                  ACS_PLMINUS    #         g        0x67
2226          board of squares            ACS_BOARD      #         h        0x68
2227          lantern symbol              ACS_LANTERN    #         i        0x69
2228          lower right corner          ACS_LRCORNER   +         j        0x6a
2229
2230          upper right corner          ACS_URCORNER   +         k        0x6b
2231          upper left corner           ACS_ULCORNER   +         l        0x6c
2232          lower left corner           ACS_LLCORNER   +         m        0x6d
2233          large plus or crossover     ACS_PLUS       +         n        0x6e
2234          scan line 1                 ACS_S1         ~         o        0x6f
2235          scan line 3                 ACS_S3         -         p        0x70
2236          horizontal line             ACS_HLINE      -         q        0x71
2237          scan line 7                 ACS_S7         -         r        0x72
2238          scan line 9                 ACS_S9         _         s        0x73
2239          tee pointing right          ACS_LTEE       +         t        0x74
2240          tee pointing left           ACS_RTEE       +         u        0x75
2241          tee pointing up             ACS_BTEE       +         v        0x76
2242          tee pointing down           ACS_TTEE       +         w        0x77
2243          vertical line               ACS_VLINE      |         x        0x78
2244          less-than-or-equal-to       ACS_LEQUAL     &lt;         y        0x79
2245          greater-than-or-equal-to    ACS_GEQUAL     &gt;         z        0x7a
2246          greek pi                    ACS_PI         *         {        0x7b
2247          not-equal                   ACS_NEQUAL     !         |        0x7c
2248          UK pound sign               ACS_STERLING   f         }        0x7d
2249          bullet                      ACS_BULLET     o         ~        0x7e
2250
2251        A few notes apply to the table itself:
2252
2253        <STRONG>o</STRONG>   X/Open Curses incorrectly states that the mapping  for  <EM>lantern</EM>  is
2254            uppercase  "I"  although Unix implementations use the lowercase "i"
2255            mapping.
2256
2257        <STRONG>o</STRONG>   The DEC VT100 implemented graphics using  the  alternate  character
2258            set  feature, temporarily switching <EM>modes</EM> and sending characters in
2259            the range 0x60 (96) to 0x7e (126) (the <STRONG>acsc</STRONG>  <STRONG>Value</STRONG>  column  in  the
2260            table).
2261
2262        <STRONG>o</STRONG>   The AT&amp;T terminal added graphics characters outside that range.
2263
2264            Some  of  the  characters  within the range do not match the VT100;
2265            presumably they were used in the AT&amp;T terminal:  <EM>board</EM>  <EM>of</EM>  <EM>squares</EM>
2266            replaces  the  VT100  <EM>newline</EM> symbol, while <EM>lantern</EM> <EM>symbol</EM> replaces
2267            the VT100 <EM>vertical</EM> <EM>tab</EM> symbol.  The other VT100 symbols for control
2268            characters  (<EM>horizontal</EM> <EM>tab</EM>, <EM>carriage</EM> <EM>return</EM> and <EM>line-feed</EM>) are not
2269            (re)used in curses.
2270
2271        The best way to define a new device's graphics set is to add  a  column
2272        to  a  copy of this table for your terminal, giving the character which
2273        (when emitted between <STRONG>smacs</STRONG>/<STRONG>rmacs</STRONG> switches) will  be  rendered  as  the
2274        corresponding graphic.  Then read off the VT100/your terminal character
2275        pairs right to left in sequence; these become the ACSC string.
2276
2277
2278 </PRE><H3><a name="h3-Color-Handling">Color Handling</a></H3><PRE>
2279        The curses library functions <STRONG>init_pair</STRONG> and  <STRONG>init_color</STRONG>  manipulate  the
2280        <EM>color</EM>   <EM>pairs</EM>   and   <EM>color</EM>  <EM>values</EM>  discussed  in  this  section  (see
2281        <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG> for details on these and related functions).
2282
2283        Most color terminals are either "Tektronix-like" or "HP-like":
2284
2285        <STRONG>o</STRONG>   Tektronix-like terminals have a predefined set of <EM>N</EM> colors (where <EM>N</EM>
2286            is usually 8), and can set character-cell foreground and background
2287            characters independently, mixing them into <EM>N</EM> * <EM>N</EM> color-pairs.
2288
2289        <STRONG>o</STRONG>   On HP-like  terminals,  the  user  must  set  each  color  pair  up
2290            separately   (foreground   and  background  are  not  independently
2291            settable).  Up to <EM>M</EM> color-pairs may be set up  from  2*<EM>M</EM>  different
2292            colors.  ANSI-compatible terminals are Tektronix-like.
2293
2294        Some basic color capabilities are independent of the color method.  The
2295        numeric capabilities <STRONG>colors</STRONG> and <STRONG>pairs</STRONG> specify the  maximum  numbers  of
2296        colors  and  color-pairs  that can be displayed simultaneously.  The <STRONG>op</STRONG>
2297        (original pair) string resets foreground and background colors to their
2298        default  values  for  the terminal.  The <STRONG>oc</STRONG> string resets all colors or
2299        color-pairs to their default values for the terminal.   Some  terminals
2300        (including  many  PC  terminal  emulators)  erase screen areas with the
2301        current background color rather than the power-up  default  background;
2302        these should have the boolean capability <STRONG>bce</STRONG>.
2303
2304        While  the  curses  library  works  with  <EM>color</EM>  <EM>pairs</EM>  (reflecting the
2305        inability of some devices  to  set  foreground  and  background  colors
2306        independently),  there  are  separate  capabilities  for  setting these
2307        features:
2308
2309        <STRONG>o</STRONG>   To  change  the  current  foreground  or  background  color  on   a
2310            Tektronix-type  terminal, use <STRONG>setaf</STRONG> (set ANSI foreground) and <STRONG>setab</STRONG>
2311            (set ANSI background)  or  <STRONG>setf</STRONG>  (set  foreground)  and  <STRONG>setb</STRONG>  (set
2312            background).  These take one parameter, the color number.  The SVr4
2313            documentation describes only <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>; the XPG4 draft says  that
2314            "If  the  terminal supports ANSI escape sequences to set background
2315            and  foreground,  they  should  be  coded  as  <STRONG>setaf</STRONG>   and   <STRONG>setab</STRONG>,
2316            respectively.
2317
2318        <STRONG>o</STRONG>   If  the  terminal supports other escape sequences to set background
2319            and  foreground,  they  should  be  coded   as   <STRONG>setf</STRONG>   and   <STRONG>setb</STRONG>,
2320            respectively.   The  <STRONG>vidputs</STRONG>  and the <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG> functions use the
2321            <STRONG>setaf</STRONG> and <STRONG>setab</STRONG> capabilities if they are defined.
2322
2323        The <STRONG>setaf</STRONG>/<STRONG>setab</STRONG>  and  <STRONG>setf</STRONG>/<STRONG>setb</STRONG>  capabilities  take  a  single  numeric
2324        argument each.  Argument values 0-7 of <STRONG>setaf</STRONG>/<STRONG>setab</STRONG> are portably defined
2325        as follows (the middle column is the symbolic #define available in  the
2326        header  for the <STRONG>curses</STRONG> or <STRONG>ncurses</STRONG> libraries).  The terminal hardware is
2327        free to map these as it likes,  but  the  RGB  values  indicate  normal
2328        locations in color space.
2329
2330                     <STRONG>Color</STRONG>       <STRONG>#define</STRONG>       <STRONG>Value</STRONG>       <STRONG>RGB</STRONG>
2331                     black     <STRONG>COLOR_BLACK</STRONG>       0     0, 0, 0
2332                     red       <STRONG>COLOR_RED</STRONG>         1     max,0,0
2333                     green     <STRONG>COLOR_GREEN</STRONG>       2     0,max,0
2334                     yellow    <STRONG>COLOR_YELLOW</STRONG>      3     max,max,0
2335                     blue      <STRONG>COLOR_BLUE</STRONG>        4     0,0,max
2336                     magenta   <STRONG>COLOR_MAGENTA</STRONG>     5     max,0,max
2337                     cyan      <STRONG>COLOR_CYAN</STRONG>        6     0,max,max
2338                     white     <STRONG>COLOR_WHITE</STRONG>       7     max,max,max
2339
2340        The argument values of <STRONG>setf</STRONG>/<STRONG>setb</STRONG> historically correspond to a different
2341        mapping, i.e.,
2342
2343                     <STRONG>Color</STRONG>       <STRONG>#define</STRONG>       <STRONG>Value</STRONG>       <STRONG>RGB</STRONG>
2344                     black     <STRONG>COLOR_BLACK</STRONG>       0     0, 0, 0
2345                     blue      <STRONG>COLOR_BLUE</STRONG>        1     0,0,max
2346                     green     <STRONG>COLOR_GREEN</STRONG>       2     0,max,0
2347                     cyan      <STRONG>COLOR_CYAN</STRONG>        3     0,max,max
2348                     red       <STRONG>COLOR_RED</STRONG>         4     max,0,0
2349                     magenta   <STRONG>COLOR_MAGENTA</STRONG>     5     max,0,max
2350                     yellow    <STRONG>COLOR_YELLOW</STRONG>      6     max,max,0
2351                     white     <STRONG>COLOR_WHITE</STRONG>       7     max,max,max
2352
2353        It is important to not confuse the  two  sets  of  color  capabilities;
2354        otherwise red/blue will be interchanged on the display.
2355
2356        On  an  HP-like terminal, use <STRONG>scp</STRONG> with a color-pair number parameter to
2357        set which color pair is current.
2358
2359        Some terminals allow the <EM>color</EM> <EM>values</EM> to be modified:
2360
2361        <STRONG>o</STRONG>   On a Tektronix-like terminal, the capability <STRONG>ccc</STRONG> may be present  to
2362            indicate  that colors can be modified.  If so, the <STRONG>initc</STRONG> capability
2363            will take a color number (0 to <STRONG>colors</STRONG> - 1)and three more parameters
2364            which  describe the color.  These three parameters default to being
2365            interpreted as RGB (Red,  Green,  Blue)  values.   If  the  boolean
2366            capability <STRONG>hls</STRONG> is present, they are instead as HLS (Hue, Lightness,
2367            Saturation) indices.  The ranges are terminal-dependent.
2368
2369        <STRONG>o</STRONG>   On an HP-like terminal, <STRONG>initp</STRONG> may give a capability for changing  a
2370            color-pair  value.   It  will  take  seven parameters; a color-pair
2371            number (0 to <STRONG>max_pairs</STRONG> -  1),  and  two  triples  describing  first
2372            background  and  then  foreground colors.  These parameters must be
2373            (Red, Green, Blue) or (Hue,  Lightness,  Saturation)  depending  on
2374            <STRONG>hls</STRONG>.
2375
2376        On  some  color  terminals,  colors  collide  with highlights.  You can
2377        register these collisions with the <STRONG>ncv</STRONG> capability.  This is a  bit-mask
2378        of   attributes   not   to  be  used  when  colors  are  enabled.   The
2379        correspondence with the attributes understood by <STRONG>curses</STRONG> is as follows:
2380
2381                   <STRONG>Attribute</STRONG>              <STRONG>Bit</STRONG>   <STRONG>Decimal</STRONG>      <STRONG>Set</STRONG> <STRONG>by</STRONG>
2382                   A_STANDOUT             0     1            sgr
2383                   A_UNDERLINE            1     2            sgr
2384                   A_REVERSE              2     4            sgr
2385                   A_BLINK                3     8            sgr
2386                   A_DIM                  4     16           sgr
2387                   A_BOLD                 5     32           sgr
2388                   A_INVIS                6     64           sgr
2389                   A_PROTECT              7     128          sgr
2390                   A_ALTCHARSET           8     256          sgr
2391                   A_HORIZONTAL           9     512          sgr1
2392                   A_LEFT                 10    1024         sgr1
2393                   A_LOW                  11    2048         sgr1
2394                   A_RIGHT                12    4096         sgr1
2395                   A_TOP                  13    8192         sgr1
2396                   A_VERTICAL             14    16384        sgr1
2397                   A_ITALIC               15    32768        sitm
2398
2399        For example, on many IBM PC consoles, the underline attribute  collides
2400        with  the  foreground  color  blue  and is not available in color mode.
2401        These should have an <STRONG>ncv</STRONG> capability of 2.
2402
2403        SVr4 curses does nothing with <STRONG>ncv</STRONG>, ncurses recognizes it and  optimizes
2404        the output in favor of colors.
2405
2406
2407 </PRE><H3><a name="h3-Miscellaneous">Miscellaneous</a></H3><PRE>
2408        If  the  terminal requires other than a null (zero) character as a pad,
2409        then this can be given as pad.  Only the first  character  of  the  pad
2410        string is used.  If the terminal does not have a pad character, specify
2411        npc.  Note that ncurses implements the termcap-compatible <STRONG>PC</STRONG>  variable;
2412        though  the  application  may  set this value to something other than a
2413        null, ncurses will test <STRONG>npc</STRONG> first and use napms if the terminal has  no
2414        pad character.
2415
2416        If  the terminal can move up or down half a line, this can be indicated
2417        with <STRONG>hu</STRONG> (half-line up) and <STRONG>hd</STRONG>  (half-line  down).   This  is  primarily
2418        useful  for  superscripts  and subscripts on hard-copy terminals.  If a
2419        hard-copy terminal can eject to the next page (form feed), give this as
2420        <STRONG>ff</STRONG> (usually control/L).
2421
2422        If  there  is  a  command to repeat a given character a given number of
2423        times  (to  save  time  transmitting  a  large  number   of   identical
2424        characters)  this  can  be indicated with the parameterized string <STRONG>rep</STRONG>.
2425        The first parameter is the character to be repeated and the  second  is
2426        the number of times to repeat it.  Thus, tparm(repeat_char, 'x', 10) is
2427        the same as "xxxxxxxxxx".
2428
2429        If the terminal has a settable command character, such as the TEKTRONIX
2430        4025,  this can be indicated with <STRONG>cmdch</STRONG>.  A prototype command character
2431        is chosen which is used in all capabilities.  This character  is  given
2432        in  the  <STRONG>cmdch</STRONG>  capability to identify it.  The following convention is
2433        supported on some UNIX systems: The environment is to be searched for a
2434        <STRONG>CC</STRONG>  variable,  and if found, all occurrences of the prototype character
2435        are replaced with the character in the environment variable.
2436
2437        Terminal descriptions that do not represent a specific  kind  of  known
2438        terminal,  such  as  <EM>switch</EM>, <EM>dialup</EM>, <EM>patch</EM>, and <EM>network</EM>, should include
2439        the <STRONG>gn</STRONG> (generic) capability so that programs can complain that they  do
2440        not  know how to talk to the terminal.  (This capability does not apply
2441        to <EM>virtual</EM> terminal descriptions for which  the  escape  sequences  are
2442        known.)
2443
2444        If the terminal has a "meta key" which acts as a shift key, setting the
2445        8th bit of any character transmitted, this fact can be  indicated  with
2446        <STRONG>km</STRONG>.   Otherwise, software will assume that the 8th bit is parity and it
2447        will usually be cleared.  If strings exist to turn this "meta mode"  on
2448        and off, they can be given as <STRONG>smm</STRONG> and <STRONG>rmm</STRONG>.
2449
2450        If the terminal has more lines of memory than will fit on the screen at
2451        once, the number of lines of memory can be indicated with <STRONG>lm</STRONG>.  A  value
2452        of <STRONG>lm</STRONG>#0 indicates that the number of lines is not fixed, but that there
2453        is still more memory than fits on the screen.
2454
2455        If the terminal is one of those supported by the UNIX virtual  terminal
2456        protocol, the terminal number can be given as <STRONG>vt</STRONG>.
2457
2458        Media  copy strings which control an auxiliary printer connected to the
2459        terminal can be given as <STRONG>mc0</STRONG>: print the contents of  the  screen,  <STRONG>mc4</STRONG>:
2460        turn  off  the printer, and <STRONG>mc5</STRONG>: turn on the printer.  When the printer
2461        is on, all text sent to the terminal will be sent to the  printer.   It
2462        is  undefined whether the text is also displayed on the terminal screen
2463        when the printer is on.  A variation  <STRONG>mc5p</STRONG>  takes  one  parameter,  and
2464        leaves  the  printer  on  for  as  many  characters as the value of the
2465        parameter, then turns the printer off.  The parameter should not exceed
2466        255.   All  text, including <STRONG>mc4</STRONG>, is transparently passed to the printer
2467        while an <STRONG>mc5p</STRONG> is in effect.
2468
2469
2470 </PRE><H3><a name="h3-Glitches-and-Braindamage">Glitches and Braindamage</a></H3><PRE>
2471        Hazeltine terminals, which do not allow "~" characters to be  displayed
2472        should indicate <STRONG>hz</STRONG>.
2473
2474        Terminals  which  ignore a line-feed immediately after an <STRONG>am</STRONG> wrap, such
2475        as the Concept and vt100, should indicate <STRONG>xenl</STRONG>.
2476
2477        If <STRONG>el</STRONG> is required to get rid of standout  (instead  of  merely  writing
2478        normal text on top of it), <STRONG>xhp</STRONG> should be given.
2479
2480        Teleray terminals, where tabs turn all characters moved over to blanks,
2481        should indicate <STRONG>xt</STRONG> (destructive tabs).  Note: the  variable  indicating
2482        this   is   now  "dest_tabs_magic_smso";  in  older  versions,  it  was
2483        teleray_glitch.  This glitch is also taken  to  mean  that  it  is  not
2484        possible  to  position  the  cursor on top of a "magic cookie", that to
2485        erase standout mode it is instead necessary to use  delete  and  insert
2486        line.  The ncurses implementation ignores this glitch.
2487
2488        The  Beehive Superbee, which is unable to correctly transmit the escape
2489        or control/C characters, has <STRONG>xsb</STRONG>, indicating that the f1  key  is  used
2490        for  escape  and  f2  for control/C.  (Only certain Superbees have this
2491        problem, depending on the ROM.)  Note that in older terminfo  versions,
2492        this capability was called "beehive_glitch"; it is now "no_esc_ctl_c".
2493
2494        Other  specific  terminal  problems  may  be  corrected  by adding more
2495        capabilities of the form <STRONG>x</STRONG><EM>x</EM>.
2496
2497
2498 </PRE><H3><a name="h3-Pitfalls-of-Long-Entries">Pitfalls of Long Entries</a></H3><PRE>
2499        Long terminfo entries are unlikely to be a problem; to date,  no  entry
2500        has   even   approached   terminfo's  4096-byte  string-table  maximum.
2501        Unfortunately, the termcap translations are much more strictly  limited
2502        (to 1023 bytes), thus termcap translations of long terminfo entries can
2503        cause problems.
2504
2505        The man pages for 4.3BSD and older versions  of  <STRONG>tgetent</STRONG>  instruct  the
2506        user  to  allocate a 1024-byte buffer for the termcap entry.  The entry
2507        gets null-terminated by the termcap library, so that makes the  maximum
2508        safe  length  for a termcap entry 1k-1 (1023) bytes.  Depending on what
2509        the application and the termcap library being used does, and  where  in
2510        the  termcap  file  the terminal type that <STRONG>tgetent</STRONG> is searching for is,
2511        several bad things can happen.
2512
2513        Some termcap libraries print a warning message or exit if they find  an
2514        entry that's longer than 1023 bytes; others do not; others truncate the
2515        entries to 1023 bytes.  Some application programs  allocate  more  than
2516        the recommended 1K for the termcap entry; others do not.
2517
2518        Each  termcap  entry has two important sizes associated with it: before
2519        "tc" expansion, and after "tc" expansion.  "tc" is the capability  that
2520        tacks on another termcap entry to the end of the current one, to add on
2521        its capabilities.  If a termcap entry does not use the "tc" capability,
2522        then of course the two lengths are the same.
2523
2524        The  "before tc expansion" length is the most important one, because it