]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/terminfo.5.html
ncurses 5.2
[ncurses.git] / doc / html / man / terminfo.5.html
index 59a79d59a0fe25bcff77a41f2a6cb022614f2725..20bb063d23f9b5137c0c8bb3c083605cef09dc1c 100644 (file)
@@ -10,7 +10,7 @@
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
-       @DATADIR@/terminfo/*/*
+       /usr/share/terminfo/*/*
 
 
 </PRE>
                                              (P*)
        change_char_pitch         cpi    ZA   Change number of
                                              characters per inch
+                                             to #1
        change_line_pitch         lpi    ZB   Change number of
-                                             lines per inch
+                                             lines per inch to #1
        change_res_horz           chr    ZC   Change horizontal
-                                             resolution
+                                             resolution to #1
        change_res_vert           cvr    ZD   Change vertical res-
-                                             olution
+                                             olution to #1
        change_scroll_region      csr    cs   change region to
                                              line #1 to line #2
                                              (P)
                                              ble
        cursor_left               cub1   le   move left one space
 
-
        cursor_mem_address        mrcup  CM   memory relative cur-
-                                             sor addressing
+                                             sor addressing, move
+                                             to row #1 columns #2
        cursor_normal             cnorm  ve   make cursor appear
                                              normal (undo
                                              civis/cvvis)
        cursor_visible            cvvis  vs   make cursor very
                                              visible
        define_char               defc   ZE   Define a character
+                                             #1, #2 dots wide,
+                                             descender #3
        delete_character          dch1   dc   delete character
                                              (P*)
        delete_line               dl1    dl   delete line (P*)
        dial_phone                dial   DI   dial number #1
        dis_status_line           dsl    ds   disable status line
-       display_clock             dclk   DK   display clock at
-                                             (#1,#2)
+       display_clock             dclk   DK   display clock
        down_half_line            hd     hd   half a line down
        ena_acs                   enacs  eA   enable alternate
                                              char set
                                              mode
        enter_protected_mode      prot   mp   turn on protected
                                              mode
+
        enter_reverse_mode        rev    mr   turn on reverse
                                              video mode
-
        enter_secure_mode         invis  mk   turn on blank mode
                                              (characters invisi-
                                              ble)
        from_status_line          fsl    fs   return from status
                                              line
        goto_window               wingo  WG   go to window #1
-       hangup                    hup    HU   hang-up phone
-
 
+       hangup                    hup    HU   hang-up phone
        init_1string              is1    i1   initialization
                                              string
        init_2string              is2    is   initialization
                                              screen key
        key_exit                  kext   @9   exit key
        key_f0                    kf0    k0   F0 function key
-       key_f1                    kf1    k1   F1 function key
 
+       key_f1                    kf1    k1   F1 function key
        key_f10                   kf10   k;   F10 function key
        key_f11                   kf11   F1   F11 function key
        key_f12                   kf12   F2   F12 function key
        key_f55                   kf55   Fj   F55 function key
        key_f56                   kf56   Fk   F56 function key
        key_f57                   kf57   Fl   F57 function key
-       key_f58                   kf58   Fm   F58 function key
 
+       key_f58                   kf58   Fm   F58 function key
        key_f59                   kf59   Fn   F59 function key
        key_f6                    kf6    k6   F6 function key
        key_f60                   kf60   Fo   F60 function key
        key_sf                    kind   kF   scroll-forward key
        key_sfind                 kFND   *0   shifted find key
        key_shelp                 kHLP   #1   shifted help key
-       key_shome                 kHOM   #2   shifted home key
 
+       key_shome                 kHOM   #2   shifted home key
        key_sic                   kIC    #3   shifted insert-char-
                                              acter key
        key_sleft                 kLFT   #4   shifted left-arrow
        label_format              fln    Lf   label format
        label_off                 rmln   LF   turn off soft labels
        label_on                  smln   LO   turn on soft labels
-       meta_off                  rmm    mo   turn off meta mode
 
+       meta_off                  rmm    mo   turn off meta mode
        meta_on                   smm    mm   turn on meta mode
                                              (8th-bit on)
        micro_column_address      mhpa   ZY   Like column_address
                                              micro mode
        micro_right               mcuf1  Zb   Like cursor_right in
                                              micro mode
-       micro_row_address         mvpa   Zc   Like row_address in
-                                             micro mode
+       micro_row_address         mvpa   Zc   Like row_address #1
+                                             in micro mode
        micro_up                  mcuu1  Zd   Like cursor_up in
                                              micro mode
        newline                   nel    nw   newline (behave like
                                              in micro mode
        pkey_key                  pfkey  pk   program function key
                                              #1 to type string #2
+
+
+
        pkey_local                pfloc  pl   program function key
                                              #1 to execute string
                                              #2
-
        pkey_xmit                 pfx    px   program function key
                                              #1 to transmit
                                              string #2
                                              position (P)
        scroll_forward            ind    sf   scroll text up (P)
        scroll_reverse            ri     sr   scroll text down (P)
-       select_char_set           scs    Zj   Select character set
+       select_char_set           scs    Zj   Select character
+                                             set, #1
        set_attributes            sgr    sa   define video
                                              attributes #1-#9
                                              (PG9)
        set_bottom_margin         smgb   Zk   Set bottom margin at
                                              current line
        set_bottom_margin_parm    smgbp  Zl   Set bottom margin at
-                                             line #1 or #2 lines
-                                             from bottom
+                                             line #1 or (if smgtp
+                                             is not given) #2
+                                             lines from bottom
        set_clock                 sclk   SC   set clock, #1 hrs #2
                                              mins #3 secs
        set_color_pair            scp    sp   Set current color
                                              pair to #1
+
+
        set_foreground            setf   Sf   Set foreground color
                                              #1
        set_left_margin           smgl   ML   set left soft margin
-                                             at current column
-
-
-
+                                             at current column.
+                                             See smgl. (ML is not
+                                             in BSD termcap).
        set_left_margin_parm      smglp  Zm   Set left (right)
                                              margin at column #1
-                                             (#2)
        set_right_margin          smgr   MR   set right soft mar-
                                              gin at current col-
                                              umn
                                              current line
        set_top_margin_parm       smgtp  Zp   Set top (bottom)
                                              margin at row #1
-                                             (#2)
        set_window                wind   wi   current window is
                                              lines #1-#2 cols
                                              #3-#4
        start_bit_image           sbim   Zq   Start printing bit
                                              image graphics
        start_char_set_def        scsd   Zr   Start character set
-                                             definition
+                                             definition #1, with
+                                             #2 characters in the
+                                             set
        stop_bit_image            rbim   Zs   Stop printing bit
                                              image graphics
        stop_char_set_def         rcsd   Zt   End definition of
-                                             character set
+                                             character set #1
        subscript_characters      subcs  Zu   List of subscript-
                                              able characters
        superscript_characters    supcs  Zv   List of superscript-
        these_cause_cr            docr   Zw   Printing any of
                                              these characters
                                              causes CR
-       to_status_line            tsl    ts   move to status line
+       to_status_line            tsl    ts   move to status line,
+                                             column #1
        tone                      tone   TO   select touch tone
                                              dialing
        underline_char            uc     uc   underline char and
        user2                     u2     u2   User string #2
        user3                     u3     u3   User string #3
        user4                     u4     u4   User string #4
+
        user5                     u5     u5   User string #5
        user6                     u6     u6   User string #6
        user7                     u7     u7   User string #7
        user9                     u9     u9   User string #9
        wait_tone                 wait   WA   wait for dial-tone
        xoff_character            xoffc  XF   XOFF character
-
        xon_character             xonc   XN   XON character
        zero_motion               zerom  Zx   No motion for subse-
                                              quent character
 
-       The following  string  capabilities  are  present  in  the
-       SVr4.0  term structure, but were originally not documented
+       The  following  string  capabilities  are  present  in the
+       SVr4.0 term structure, but were originally not  documented
        in the man page.
 
                <B>Variable</B>          <B>Cap-</B>     <B>TCap</B>    <B>Description</B>
                                                of the bit image
        bit_image_repeat          birep    Xy   Repeat bit image
                                                cell #1 #2 times
-       char_set_names            csnm     Zy   List of character
-                                               set names
+       char_set_names            csnm     Zy   Produce #1'th item
+                                               from list of char-
+                                               acter set names
        code_set_init             csin     ci   Init sequence for
                                                multiple codesets
        color_names               colornm  Yw   Give name for
                                                guage/codeset sup-
                                                port
        display_pc_char           dispc    S1   Display PC charac-
-                                               ter
+                                               ter #1
        end_bit_image_region      endbi    Yy   End a bit-image
                                                region
        enter_pc_charset_mode     smpch    S2   Enter PC character
                                                display mode
        exit_scancode_mode        rmsc     S5   Exit PC scancode
                                                mode
+
+
+
        get_mouse                 getm     Gm   Curses should get
-                                               button events
+                                               button events,
+                                               parameter #1 not
+                                               documented.
        key_mouse                 kmous    Km   Mouse event has
                                                occurred
        mouse_info                minfo    Mi   Mouse status
                                                information
        pc_term_options           pctrm    S6   PC terminal
                                                options
-
-
-
        pkey_plab                 pfxl     xl   Program function
                                                key #1 to type
                                                string #2 and show
        set3_des_seq              s3ds     s3   Shift to code set
                                                3
        set_a_background          setab    AB   Set background
-                                               color using ANSI
-                                               escape
+                                               color to #1, using
+                                               ANSI escape
        set_a_foreground          setaf    AF   Set foreground
-                                               color using ANSI
-                                               escape
+                                               color to #1, using
+                                               ANSI escape
        set_color_band            setcolor Yz   Change to ribbon
                                                color #1
        set_lr_margin             smglr    ML   Set both left and
                                                right margins to
-                                               #1, #2
+                                               #1, #2.  (ML is
+                                               not in BSD term-
+                                               cap).
        set_page_length           slines   YZ   Set page length to
                                                #1 lines
        set_tb_margin             smgtb    MT   Sets both top and
                                              mode
         enter_right_hl_mode      erhlm  Xr   Enter right high-
                                              light mode
-
-
         enter_top_hl_mode        ethlm  Xt   Enter top highlight
                                              mode
         enter_vertical_hl_mode   evhlm  Xv   Enter vertical high-
        piled description you are working on.  Only that directory
        is searched.
 
-       If  TERMINFO  is  not  set,  the  <B>ncurses</B>  version  of the
-       terminfo reader code will instead look  in  the  directory
+       If  TERMINFO  is  not set, the <B>ncurses</B> version of the ter-
+       minfo reader code  will  instead  look  in  the  directory
        <B>$HOME/.terminfo</B>  for  a compiled description.  If it fails
        to find one  there,  and  the  environment  variable  TER-
        MINFO_DIRS  is set, it will interpret the contents of that
        variable as a list of colon- separated directories  to  be
        searched  (an  empty  entry is interpreted as a command to
-       search <I>@DATADIR@/terminfo</I>).  If no description is found in
-       any of the TERMINFO_DIRS directories, the fetch fails.
+       search <I>/usr/share/terminfo</I>).  If no description  is  found
+       in  any of the TERMINFO_DIRS directories, the fetch fails.
 
-       If  neither  TERMINFO  nor  TERMINFO_DIRS is set, the last
-       place  tried  will  be  the  system  terminfo   directory,
-       <I>@DATADIR@/terminfo</I>.
+       If neither TERMINFO nor TERMINFO_DIRS  is  set,  the  last
+       place   tried  will  be  the  system  terminfo  directory,
+       <I>/usr/share/terminfo</I>.
 
-       (Neither  the  <B>$HOME/.terminfo</B>  lookups  nor TERMINFO_DIRS
-       extensions  are  supported  under  stock  System  V   ter-
+       (Neither the  <B>$HOME/.terminfo</B>  lookups  nor  TERMINFO_DIRS
+       extensions   are  supported  under  stock  System  V  ter-
        minfo/curses.)
 
 
    <B>Preparing</B> <B>Descriptions</B>
-       We  now  outline how to prepare descriptions of terminals.
-       The most effective way to prepare a  terminal  description
-       is  by  imitating the description of a similar terminal in
-       <I>terminfo</I> and to build up a  description  gradually,  using
+       We now outline how to prepare descriptions  of  terminals.
+       The  most  effective way to prepare a terminal description
+       is by imitating the description of a similar  terminal  in
+       <I>terminfo</I>  and  to  build up a description gradually, using
        partial descriptions with <I>vi</I> or some other screen-oriented
-       program to check that they are correct.  Be aware  that  a
+       program  to  check that they are correct.  Be aware that a
        very unusual terminal may expose deficiencies in the abil-
-       ity of the <I>terminfo</I> file to describe it  or  bugs  in  the
+       ity  of  the  <I>terminfo</I>  file to describe it or bugs in the
        screen-handling code of the test program.
 
-       To  get the padding for insert line right (if the terminal
+       To get the padding for insert line right (if the  terminal
        manufacturer did not document it) a severe test is to edit
-       a  large file at 9600 baud, delete 16 or so lines from the
-       middle of the screen, then hit the `u' key  several  times
-       quickly.   If the terminal messes up, more padding is usu-
-       ally needed.  A similar test can be used for insert  char-
+       a large file at 9600 baud, delete 16 or so lines from  the
+       middle  of  the screen, then hit the `u' key several times
+       quickly.  If the terminal messes up, more padding is  usu-
+       ally  needed.  A similar test can be used for insert char-
        acter.
 
 
    <B>Basic</B> <B>Capabilities</B>
-       The  number  of  columns  on each line for the terminal is
-       given by the <B>cols</B> numeric capability.  If the terminal  is
-       a  CRT, then the number of lines on the screen is given by
+       The number of columns on each line  for  the  terminal  is
+       given  by the <B>cols</B> numeric capability.  If the terminal is
+       a CRT, then the number of lines on the screen is given  by
        the <B>lines</B> capability.  If the terminal wraps around to the
-       beginning  of the next line when it reaches the right mar-
-       gin, then it should have the <B>am</B> capability.  If the termi-
-       nal  can  clear its screen, leaving the cursor in the home
-       position, then this is given by the <B>clear</B> string  capabil-
-       ity.   If the terminal overstrikes (rather than clearing a
-       position when a character is struck over) then  it  should
-       have  the  <B>os</B>  capability.   If the terminal is a printing
-       terminal, with no soft copy unit, give it both <B>hc</B> and  <B>os</B>.
-       (<B>os</B>  applies to storage scope terminals, such as TEKTRONIX
-       4010 series, as well as hard copy and APL terminals.)   If
-       there is a code to move the cursor to the left edge of the
-       current row, give this as <B>cr</B>.  (Normally this will be car-
-       riage  return,  control M.)  If there is a code to produce
-       an audible signal (bell, beep, etc) give this as <B>bel</B>.
+       beginning of the next  line  when  it  reaches  the  right
+       margin,  then  it  should  have the <B>am</B> capability.  If the
+       terminal can clear its screen, leaving the cursor  in  the
+       home  position,  then  this  is  given by the <B>clear</B> string
+       capability.  If  the  terminal  overstrikes  (rather  than
+       clearing  a position when a character is struck over) then
+       it should have the <B>os</B> capability.  If the  terminal  is  a
+       printing terminal, with no soft copy unit, give it both <B>hc</B>
+       and <B>os</B>.  (<B>os</B> applies to storage scope terminals,  such  as
+       TEKTRONIX 4010 series, as well as hard copy and APL termi-
+       nals.)  If there is a code to move the cursor to the  left
+       edge  of the current row, give this as <B>cr</B>.  (Normally this
+       will be carriage return, control M.)  If there is  a  code
+       to  produce  an audible signal (bell, beep, etc) give this
+       as <B>bel</B>.
 
        If there is a code to move the cursor one position to  the
        left  (such  as backspace) that capability should be given
 
      33|tty33|tty|model 33 teletype,
      bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os,
+
        while the Lear Siegler ADM-3 is described as
 
      adm3|3|lsi adm3,
 
             %+ %- %* %/ %m
                       arithmetic (%m is mod): push(pop() op pop())
+
             %&amp; %| %^  bit operations: push(pop() op pop())
             %= %&gt; %&lt;  logical operations: push(pop() op pop())
             %A, %O    logical and &amp; or operations (for conditionals)
          \E[0       always              \E[0
          ;1         if p1 or p6         %?%p1%p6%|%t;1%;
          ;4         if p2               %?%p2%|%t;4%;
+
          ;5         if p4               %?%p4%|%t;5%;
          ;7         if p1 or p3         %?%p1%p3%|%t;7%;
          ;8         if p7               %?%p7%|%t;8%;
 
        Remember  that  if  you specify sgr, you must also specify
        sgr0.
+
        Terminals with the ``magic cookie'' glitch  (<B>xmc</B>)  deposit
        special   ``cookies''   when   they  receive  mode-setting
        sequences, which affect the display algorithm rather  than
        They are normally sent to the terminal, by the <I>init</I> option
        of the <I>tput</I> program, each time the  user  logs  in.   They
        will  be  printed  in the following order: run the program
-       <B>iprog</B>; output <B>is1</B>; <B>is2</B>; set the margins using <B>mgc</B>, <B>smgl</B>and
-       <B>smgr</B>;  set  tabs using <B>tbc</B> and <B>hts</B>; print the file <B>if</B>; and
-       finally output <B>is3</B>.
+       <B>iprog</B>; output <B>is1</B>; <B>is2</B>; set the margins  using  <B>mgc</B>,  <B>smgl</B>
+       and  <B>smgr</B>;  set tabs using <B>tbc</B> and <B>hts</B>; print the file <B>if</B>;
+       and finally output <B>is3</B>.
 
        Most initialization is done with  <B>is2</B>.   Special  terminal
        modes can be set up without duplicating strings by putting
        ter  as  a  pad,  then this can be given as <B>pad</B>.  Only the
        first character of the <B>pad</B> string is used.
 
+
    <B>Status</B> <B>Lines</B>
        Some terminals have an extra `status line'  which  is  not
        normally  used  by  software  (and thus not counted in the
        board of squares           ACS_BOARD      #          h
        bullet                     ACS_BULLET     o          ~
        checker board (stipple)    ACS_CKBOARD    :          a
-
        degree symbol              ACS_DEGREE     \          f
        diamond                    ACS_DIAMOND    +          `
        greater-than-or-equal-to   ACS_GEQUAL     &gt;          z
 
        If  the terminal can move up or down half a line, this can
        be indicated with <B>hu</B>  (half-line  up)  and  <B>hd</B>  (half-line
-       down).  This is primarily useful for superscripts and sub-
-       scripts on hard-copy terminals.  If a  hard-copy  terminal
-       can  eject  to  the next page (form feed), give this as <B>ff</B>
-       (usually control L).
+       down).   This  is  primarily  useful  for superscripts and
+       subscripts on hard-copy terminals.  If a hard-copy  termi-
+       nal  can  eject to the next page (form feed), give this as
+       <B>ff</B> (usually control L).
 
        If there is a command to repeat a given character a  given
        number  of times (to save time transmitting a large number
        Some  SVr4  <B>curses</B>  implementations,  and  all previous to
        SVr4, don't interpret the %A and %O operators in parameter
        strings.
-
        SVr4/XPG4  do  not  specify whether <B>msgr</B> licenses movement
        while in an alternate-character-set mode (such modes  may,
        among other things, map CR and NL to characters that don't
 
 </PRE>
 <H2>FILES</H2><PRE>
-       @DATADIR@/terminfo/?/*   files     containing     terminal
+       /usr/share/terminfo/?/*  files     containing     terminal
                                 descriptions
 
 
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 </PRE>
 <HR>
 <ADDRESS>