]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - include/Caps
ncurses 5.2
[ncurses.git] / include / Caps
index 8e4435cc2b38e1209a4b126e753f4ee13f682968..b12370f032abdb90a1d0bfa3ec0dd5ec80bcfe6f 100644 (file)
@@ -29,7 +29,7 @@
 # Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995
 #    and: Eric S. Raymond <esr@snark.thyrsus.com>
 #
-# $Id: Caps,v 1.25 1999/11/27 20:13:55 tom Exp $
+# $Id: Caps,v 1.30 2000/10/14 17:36:14 tom Exp $
 #
 # This is the master termcap/terminfo capability table.
 #
@@ -334,7 +334,7 @@ cursor_down         cud1    str     do      YBCGE   down one line
 cursor_home            home    str     ho      YBCGE   home cursor (if no cup)
 cursor_invisible       civis   str     vi      YB-G-   make cursor invisible
 cursor_left            cub1    str     le      YBCGE   move left one space
-cursor_mem_address     mrcup   str     CM      YB-G-   memory relative cursor addressing
+cursor_mem_address     mrcup   str     CM      YB-G-   memory relative cursor addressing, move to row #1 columns #2
 cursor_normal          cnorm   str     ve      YBCGE   make cursor appear normal (undo civis/cvvis)
 cursor_right           cuf1    str     nd      YBCGE   non-destructive space (move right one space)
 cursor_to_ll           ll      str     ll      YBCGE   last line, first column (if no cup)
@@ -454,7 +454,7 @@ set_attributes              sgr     str     sa      YB-G-   define video attributes #1-#9 (PG9)
 set_tab                hts     str     st      YB-G-   set a tab in every row, current columns
 set_window             wind    str     wi      -B-GE   current window is lines #1-#2 cols #3-#4
 tab                    ht      str     ta      YBCGE   tab to next 8-space hardware tab stop
-to_status_line         tsl     str     ts      YB-G-   move to status line
+to_status_line         tsl     str     ts      YB-G-   move to status line, column #1
 underline_char         uc      str     uc      YBCG-   underline char and move past it
 up_half_line           hu      str     hu      YB-G-   half a line up
 init_prog              iprog   str     iP      -B---   path name of program for initialization
@@ -594,11 +594,11 @@ key_f62           kf62    str     Fq      ----E   F62 function key
 key_f63                kf63    str     Fr      ----E   F63 function key
 clr_bol                el1     str     cb      -----   Clear to beginning of line
 clear_margins          mgc     str     MC      -----   clear right and left soft margins
-set_left_margin        smgl    str     ML      -----   set left soft margin at current column
+set_left_margin        smgl    str     ML      -----   set left soft margin at current column.  See smgl. (ML is not in BSD termcap).
 set_right_margin       smgr    str     MR      -----   set right soft margin at current column
 label_format           fln     str     Lf      -----   label format
 set_clock              sclk    str     SC      -----   set clock, #1 hrs #2 mins #3 secs
-display_clock          dclk    str     DK      -----   display clock at (#1,#2)
+display_clock          dclk    str     DK      -----   display clock
 remove_clock           rmclk   str     RC      -----   remove clock
 create_window          cwin    str     CW      -----   define a window #1 from #2,#3 to #4,#5
 goto_window            wingo   str     WG      -----   go to window #1
@@ -633,11 +633,11 @@ set_background    setb    str     Sb      -----   Set background color #1
 #
 # SVr4 added these capabilities to support printers
 #
-change_char_pitch      cpi     str     ZA      -----   Change number of characters per inch
-change_line_pitch      lpi     str     ZB      -----   Change number of lines per inch
-change_res_horz        chr     str     ZC      -----   Change horizontal resolution
-change_res_vert        cvr     str     ZD      -----   Change vertical resolution
-define_char            defc    str     ZE      -----   Define a character
+change_char_pitch      cpi     str     ZA      -----   Change number of characters per inch to #1
+change_line_pitch      lpi     str     ZB      -----   Change number of lines per inch to #1
+change_res_horz        chr     str     ZC      -----   Change horizontal resolution to #1
+change_res_vert        cvr     str     ZD      -----   Change vertical resolution to #1
+define_char            defc    str     ZE      -----   Define a character #1, #2 dots wide, descender #3
 enter_doublewide_mode  swidm   str     ZF      -----   Enter double-wide mode
 enter_draft_quality    sdrfq   str     ZG      -----   Enter draft-quality mode
 enter_italics_mode     sitm    str     ZH      -----   Enter italic mode
@@ -661,24 +661,24 @@ micro_column_address      mhpa    str     ZY      -----   Like column_address in micro mode
 micro_down             mcud1   str     ZZ      -----   Like cursor_down in micro mode
 micro_left             mcub1   str     Za      -----   Like cursor_left in micro mode
 micro_right            mcuf1   str     Zb      -----   Like cursor_right in micro mode
-micro_row_address      mvpa    str     Zc      -----   Like row_address in micro mode
+micro_row_address      mvpa    str     Zc      -----   Like row_address #1 in micro mode
 micro_up               mcuu1   str     Zd      -----   Like cursor_up in micro mode
 order_of_pins          porder  str     Ze      -----   Match software bits to print-head pins
 parm_down_micro        mcud    str     Zf      -----   Like parm_down_cursor in micro mode
 parm_left_micro        mcub    str     Zg      -----   Like parm_left_cursor in micro mode
 parm_right_micro       mcuf    str     Zh      -----   Like parm_right_cursor in micro mode
 parm_up_micro          mcuu    str     Zi      -----   Like parm_up_cursor in micro mode
-select_char_set        scs     str     Zj      -----   Select character set
+select_char_set        scs     str     Zj      -----   Select character set, #1
 set_bottom_margin      smgb    str     Zk      -----   Set bottom margin at current line
-set_bottom_margin_parm smgbp   str     Zl      -----   Set bottom margin at line #1 or #2 lines from bottom
-set_left_margin_parm   smglp   str     Zm      -----   Set left (right) margin at column #1 (#2)
+set_bottom_margin_parm smgbp   str     Zl      -----   Set bottom margin at line #1 or (if smgtp is not given) #2 lines from bottom
+set_left_margin_parm   smglp   str     Zm      -----   Set left (right) margin at column #1
 set_right_margin_parm  smgrp   str     Zn      -----   Set right margin at column #1
 set_top_margin         smgt    str     Zo      -----   Set top margin at current line
-set_top_margin_parm    smgtp   str     Zp      -----   Set top (bottom) margin at row #1 (#2)
+set_top_margin_parm    smgtp   str     Zp      -----   Set top (bottom) margin at row #1
 start_bit_image        sbim    str     Zq      -----   Start printing bit image graphics
-start_char_set_def     scsd    str     Zr      -----   Start character set definition
+start_char_set_def     scsd    str     Zr      -----   Start character set definition #1, with #2 characters in the set
 stop_bit_image         rbim    str     Zs      -----   Stop printing bit image graphics
-stop_char_set_def      rcsd    str     Zt      -----   End definition of character set
+stop_char_set_def      rcsd    str     Zt      -----   End definition of character set #1
 subscript_characters   subcs   str     Zu      -----   List of subscriptable characters
 superscript_characters supcs   str     Zv      -----   List of superscriptable characters
 these_cause_cr         docr    str     Zw      -----   Printing any of these characters causes CR
@@ -697,13 +697,13 @@ zero_motion       zerom   str     Zx      -----   No motion for subsequent character
 #%lw25 lw6 lw2 lw18.
 #%\fBVariable  Cap-    TCap    Description\fR
 #%\fBString    name    Code\fR
-char_set_names         csnm    str     Zy      -----   List of character set names
+char_set_names         csnm    str     Zy      -----   Produce #1'th item from list of character set names
 key_mouse              kmous   str     Km      -----   Mouse event has occurred
 mouse_info             minfo   str     Mi      -----   Mouse status information
 req_mouse_pos          reqmp   str     RQ      -----   Request mouse position
-get_mouse              getm    str     Gm      -----   Curses should get button events
-set_a_foreground       setaf   str     AF      -----   Set foreground color using ANSI escape
-set_a_background       setab   str     AB      -----   Set background color using ANSI escape
+get_mouse              getm    str     Gm      -----   Curses should get button events, parameter #1 not documented.
+set_a_foreground       setaf   str     AF      -----   Set foreground color to #1, using ANSI escape
+set_a_background       setab   str     AB      -----   Set background color to #1, using ANSI escape
 pkey_plab              pfxl    str     xl      -----   Program function key #1 to type string #2 and show string #3
 device_type            devt    str     dv      -----   Indicate language/codeset support
 code_set_init          csin    str     ci      -----   Init sequence for multiple codesets
@@ -711,7 +711,7 @@ set0_des_seq        s0ds    str     s0      -----   Shift to code set 0 (EUC set 0, ASCII)
 set1_des_seq           s1ds    str     s1      -----   Shift to code set 1
 set2_des_seq           s2ds    str     s2      -----   Shift to code set 2
 set3_des_seq           s3ds    str     s3      -----   Shift to code set 3
-set_lr_margin          smglr   str     ML      -----   Set both left and right margins to #1, #2
+set_lr_margin          smglr   str     ML      -----   Set both left and right margins to #1, #2.  (ML is not in BSD termcap).
 set_tb_margin          smgtb   str     MT      -----   Sets both top and bottom margins to #1, #2
 bit_image_repeat       birep   str     Xy      -----   Repeat bit image cell #1 #2 times
 bit_image_newline      binel   str     Zz      -----   Move to next row of the bit image
@@ -724,7 +724,7 @@ set_page_length     slines  str     YZ      -----   Set page length to #1 lines
 #
 # SVr4 added these capabilities for direct PC-clone support
 #
-display_pc_char        dispc   str     S1      -----   Display PC character
+display_pc_char        dispc   str     S1      -----   Display PC character #1
 enter_pc_charset_mode  smpch   str     S2      -----   Enter PC character display mode
 exit_pc_charset_mode   rmpch   str     S3      -----   Exit PC character display mode
 enter_scancode_mode    smsc    str     S4      -----   Enter PC scancode mode