]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - include/Caps
ncurses 6.4 - patch 20240217
[ncurses.git] / include / Caps
index ceff65af08544474966067cfe031a11e2cb24e8f..b208203476c4e3813162d7371a6619ee6b76d496 100644 (file)
@@ -1,5 +1,5 @@
 ##############################################################################
-# Copyright 2019-2021,2023 Thomas E. Dickey                                  #
+# Copyright 2019-2023,2024 Thomas E. Dickey                                  #
 # Copyright 1998-2015,2016 Free Software Foundation, Inc.                    #
 #                                                                            #
 # Permission is hereby granted, free of charge, to any person obtaining a    #
@@ -30,7 +30,7 @@
 # Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995
 #    and: Eric S. Raymond <esr@snark.thyrsus.com>
 #
-# $Id: Caps,v 1.49 2023/10/14 20:54:32 tom Exp $
+# $Id: Caps,v 1.53 2024/01/20 16:51:41 Branden.Robinson Exp $
 #
 # This is the master termcap/terminfo capability table.
 #
@@ -48,7 +48,7 @@
 #
 # Column 1: terminfo variable name
 # Column 2: terminfo capability name
-# Column 3: capability type (boolean, numeric, or string)
+# Column 3: capability type (Boolean, numeric, or string)
 # Column 4: termcap capability name
 # Column 5: KEY_xxx name, if any, `-' otherwise
 # Column 6: value for KEY_xxx name, if any, `-' otherwise
 # to buy space for non-essentials Emacs is still using.  Capabilities high
 # on that hit list: rc, sc, uc.
 #
+# FORMATTING THE TABLES
+#
+# We manually specify a (minimum) column width for the capability name
+# and terminfo code columns in the tables to achieve a consistent
+# arrangement; as used here, tbl(1) cannot know the width required by
+# one table's data while formatting another's.
+#
+# The longest capability names (C variables) are
+# "enter_near_letter_quality" and "bit_image_carriage_return" (tied at
+# 25n), and the longest terminfo code is "setcolor" (8n).
+#
+# The tables are a tight fit on traditional man(7) implementations that
+# use a line length of 65n, and the "Description" column has little room
+# within which the formatter can make breaking or adjustment decisions.
+# Words like "micro_..._address" and "parm_..._micro" don't break.
+# Reducing the inter-column gaps to 2 ens gives them enough room.  --GBR
+#
 #############################################################################
 #
 # STANDARD CAPABILITIES
 #%.TP
 #%(#\d\fIi\fP\u)
 #%indicates the \fIi\fP\uth\d parameter.
-#%
+#%.
 #%.PP
-#% These are the boolean capabilities:
-#%
-#%.na
-#%.TS H
-#%center expand;
-#%c l l c
-#%c l l c
-#%lw25 lw6 lw2 lw20.
-#%\fBVariable  Cap-    TCap    Description\fR
-#%\fBBooleans  name    Code\fR
+#%.TS
+#%center;
+#%Lb        Cb       S   Lb
+#%Lb        Lb       Lb  Lb
+#%Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
+#%\&   Code    \&
+#%Boolean Capability Name      TI      TC      Description
+#%_
 auto_left_margin               bw      bool    bw      -       -       YB-G-   cub1 wraps from column 0 to last column
 auto_right_margin              am      bool    am      -       -       YBCGE   terminal has automatic margins
 no_esc_ctlc                    xsb     bool    xb      -       -       YBCG-   beehive (f1=escape, f2=ctrl C)
@@ -254,18 +269,16 @@ semi_auto_right_margin            sam     bool    YE      -       -       -----   printing in last column causes cr
 cpi_changes_res                        cpix    bool    YF      -       -       -----   changing character pitch changes resolution
 lpi_changes_res                        lpix    bool    YG      -       -       -----   changing line pitch changes resolution
 #%.TE
-#%.ad
-#%
-#%These are the numeric capabilities:
-#%
-#%.na
-#%.TS H
-#%center expand;
-#%c l l c
-#%c l l c
-#%lw25 lw6 lw2 lw20.
-#%\fBVariable  Cap-    TCap    Description\fR
-#%\fBNumeric   name    Code\fR
+#%.PP
+#%.
+#%.TS
+#%center;
+#%Lb        Cb       S   Lb
+#%Lb        Lb       Lb  Lb
+#%Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
+#%\&   Code    \&
+#%Numeric Capability Name      TI      TC      Description
+#%_
 columns                                cols    num     co      -       -       YBCGE   number of columns in a line
 init_tabs                      it      num     it      -       -       YB-G-   tabs initially every # spaces
 lines                          lines   num     li      -       -       YBCGE   number of lines on screen or page
@@ -284,20 +297,21 @@ max_colors                        colors  num     Co      -       -       -----   maximum number of colors on screen
 max_pairs                      pairs   num     pa      -       -       -----   maximum number of color-pairs on the screen
 no_color_video                 ncv     num     NC      -       -       -----   video attributes that cannot be used with colors
 #%.TE
-#%.ad
-#%
+#%.PP
+#%.
 #%The following numeric capabilities are present in the SVr4.0 term structure,
 #%but are not yet documented in the man page.
 #%They came in with SVr4's printer support.
-#%
-#%.na
-#%.TS H
-#%center expand;
-#%c l l c
-#%c l l c
-#%lw25 lw6 lw2 lw20.
-#%\fBVariable  Cap-    TCap    Description\fR
-#%\fBNumeric   name    Code\fR
+#%.
+#%.PP
+#%.TS
+#%center;
+#%Lb        Cb       S   Lb
+#%Lb        Lb       Lb  Lb
+#%Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
+#%\&   Code    \&
+#%Numeric Capability Name      TI      TC      Description
+#%_
 buffer_capacity                        bufsz   num     Ya      -       -       -----   numbers of bytes buffered before printing
 dot_vert_spacing               spinv   num     Yb      -       -       -----   spacing of pins vertically in pins per inch
 dot_horz_spacing               spinh   num     Yc      -       -       -----   spacing of dots horizontally in dots per inch
@@ -316,18 +330,16 @@ buttons                           btns    num     BT      -       -       -----   number of buttons on mouse
 bit_image_entwining            bitwin  num     Yo      -       -       -----   number of passes for each bit-image row
 bit_image_type                 bitype  num     Yp      -       -       -----   type of bit-image device
 #%.TE
-#%.ad
-#%
-#%These are the string capabilities:
-#%
-#%.na
-#%.TS H
-#%center expand;
-#%c l l c
-#%c l l c
-#%lw25 lw6 lw2 lw20.
-#%\fBVariable  Cap-    TCap    Description\fR
-#%\fBString    name    Code\fR
+#%.PP
+#%.
+#%.TS
+#%center;
+#%Lb        Cb       S   Lb
+#%Lb        Lb       Lb  Lb
+#%Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
+#%\&   Code    \&
+#%String Capability Name       TI      TC      Description
+#%_
 back_tab                       cbt     str     bt      -               -       YBCGE   back tab (P)
 bell                           bel     str     bl      -               -       YB-GE   audible signal (bell) (P)
 carriage_return                        cr      str     cr      -               -       YBCGE   carriage return (P*) (P*)
@@ -416,8 +428,8 @@ key_sf                              kind    str     kF      KEY_SF          0520    -B-G-*  scroll-forward key
 key_sr                         kri     str     kR      KEY_SR          0521    -B-G-*  scroll-backward key
 key_stab                       khts    str     kT      KEY_STAB        0524    -B-G-*  set-tab key
 key_up                         kcuu1   str     ku      KEY_UP          0403    YBCGE   up-arrow key
-keypad_local                   rmkx    str     ke      -               -       YBCGE   leave 'keyboard_transmit' mode
-keypad_xmit                    smkx    str     ks      -               -       YBCGE   enter 'keyboard_transmit' mode
+keypad_local                   rmkx    str     ke      -               -       YBCGE   leave keyboard transmit mode
+keypad_xmit                    smkx    str     ks      -               -       YBCGE   enter keyboard transmit mode
 lab_f0                         lf0     str     l0      -               -       -B-G-*  label on function key f0 if not f0
 lab_f1                         lf1     str     l1      -               -       -B-G-*  label on function key f1 if not f1
 lab_f10                                lf10    str     la      -               -       -----   label on function key f10 if not f10
@@ -693,19 +705,20 @@ superscript_characters            supcs   str     Zv      -               -       -----   List of superscriptable characte
 these_cause_cr                 docr    str     Zw      -               -       -----   Printing any of these characters causes CR
 zero_motion                    zerom   str     Zx      -               -       -----   No motion for subsequent character
 #%.TE
-#%.ad
-#%
+#%.PP
+#%.
 #%The following string capabilities are present in the SVr4.0 term structure,
 #%but were originally not documented in the man page.
-#%
-#%.na
-#%.TS H
-#%center expand;
-#%c l l c
-#%c l l c
-#%lw25 lw6 lw2 lw18.
-#%\fBVariable  Cap-    TCap    Description\fR
-#%\fBString    name    Code\fR
+#%.
+#%.PP
+#%.TS
+#%center;
+#%Lb        Cb       S   Lb
+#%Lb        Lb       Lb  Lb
+#%Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
+#%\&   Code    \&
+#%String Capability Name       TI      TC      Description
+#%_
 char_set_names                 csnm    str     Zy      -               -       -----   Produce #1'th item from list of character set names
 key_mouse                      kmous   str     Km      KEY_MOUSE       0631    -----   Mouse event has occurred
 mouse_info                     minfo   str     Mi      -               -       -----   Mouse status information
@@ -714,7 +727,7 @@ get_mouse                   getm    str     Gm      -               -       -----   Curses should get button events, parameter #1
 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
+device_type                    devt    str     dv      -               -       -----   Indicate languagecodeset support
 code_set_init                  csin    str     ci      -               -       -----   Init sequence for multiple codesets
 set0_des_seq                   s0ds    str     s0      -               -       -----   Shift to codeset 0 (EUC set 0, ASCII)
 set1_des_seq                   s1ds    str     s1      -               -       -----   Shift to codeset 1
@@ -742,9 +755,8 @@ pc_term_options                     pctrm   str     S6      -               -       -----   PC terminal options
 scancode_escape                        scesc   str     S7      -               -       -----   Escape for scancode emulation
 alt_scancode_esc               scesa   str     S8      -               -       -----   Alternate escape for scancode emulation
 #%.TE
-#%.ad
-#%
-#%.in .8i
+#%.PP
+#%.
 #%The XSI Curses standard added these hardcopy capabilities.
 #%They were used in some post-4.1 versions of System V curses,
 #%e.g., Solaris 2.5 and IRIX 6.x.
@@ -753,15 +765,16 @@ alt_scancode_esc          scesa   str     S8      -               -       -----   Alternate escape for scancode emulatio
 #%If your compiled terminfo entries use these,
 #%they may not be binary-compatible with System V terminfo
 #%entries after SVr4.1; beware!
-#%
-#%.na
-#%.TS H
-#%center expand;
-#%c l l c
-#%c l l c
-#%lw25 lw6 lw2 lw20.
-#%\fBVariable  Cap-    TCap    Description\fR
-#%\fBString    name    Code\fR
+#%.
+#%.PP
+#%.TS
+#%center;
+#%Lb        Cb       S   Lb
+#%Lb        Lb       Lb  Lb
+#%Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
+#%\&   Code    \&
+#%String Capability Name       TI      TC      Description
+#%_
 enter_horizontal_hl_mode       ehhlm   str     Xh      -               -       -----   Enter horizontal highlight mode
 enter_left_hl_mode             elhlm   str     Xl      -               -       -----   Enter left highlight mode
 enter_low_hl_mode              elohlm  str     Xo      -               -       -----   Enter low highlight mode
@@ -771,7 +784,6 @@ enter_vertical_hl_mode              evhlm   str     Xv      -               -       -----   Enter vertical highlight mode
 set_a_attributes               sgr1    str     sA      -               -       -----   Define second set of video attributes #1-#6
 set_pglen_inch                 slength str     YI      -               -       -----   Set page length to #1 hundredth of an inch (some implementations use sL for termcap).
 #%.TE
-#%.ad
 #
 # The magic token below tells the tic compiler-generator code that all the caps
 # past it should be ignored (not written out) when dumping terminfo objects. It