]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - include/Caps.uwin
ncurses 6.4 - patch 20231230
[ncurses.git] / include / Caps.uwin
index de0d5b77cae942d8fbde88d7de022f70f533954f..6214f59a05d7723309a91fa3585f0fb55c720f9f 100644 (file)
@@ -1,5 +1,5 @@
 ##############################################################################
-# Copyright 2019,2020 Thomas E. Dickey                                       #
+# Copyright 2019-2021,2023 Thomas E. Dickey                                  #
 # Copyright 2001-2015,2016 Free Software Foundation, Inc.                    #
 #                                                                            #
 # Permission is hereby granted, free of charge, to any person obtaining a    #
@@ -29,7 +29,7 @@
 #
 # Author: Thomas Dickey
 #
-# $Id: Caps.uwin,v 1.13 2020/10/17 21:30:19 tom Exp $
+# $Id: Caps.uwin,v 1.17 2023/12/30 21:36:32 Branden.Robinson Exp $
 #
 # This is an adaptation of ncurses' termcap/terminfo capability table, which
 # is designed to align with U/Win's terminfo.
@@ -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
@@ -58,7 +58,7 @@
 #
 # The codes following [Y-] in column 7 describe the versions of termcap which
 # use the given capability.  This information is not used by the curses library
-# proper; rather, it's there to help the terminfo maintainer avoid emitting
+# proper; rather, it is there to help the terminfo maintainer avoid emitting
 # termcap entry translations that are more than 1023 bytes long (and tank a
 # lot of old termcap-using programs).  The codes read as follows:
 #      B = mentioned in the BSD man page for 4.4BSD curses
@@ -98,8 +98,8 @@
 # 3. List it in the standard table.  You almost certainly do *not* want
 # to do this -- the capabilities in that one, and their order, have been
 # carefully chosen to be SVr4-binary-compatible when they're written out
-# as a terminfo object, and breaking this would be bad.  It's up to the ncurses
-# library what to do with the terminfo data after it's read in.
+# as a terminfo object, and breaking this would be bad.  It is up to the ncurses
+# library what to do with the terminfo data after it is read in.
 #
 # 4. List it in the aliases table with an IGNORE target field.  If you
 # do this, the capability will be ignored on input (though the user will
 # 5. List it in the extensions table. If you do this, the compiler will
 # silently accept the capability, but the curses library proper will never
 # see it (because it won't be written out as part of the terminfo object
-# format).  It's up to you what you have the compiler do with it.
+# format).  It is up to you what you have the compiler do with it.
 #
 # There are two opposite reasons to choose option 5.  One is when you want
 # to eat the capability silently and discard it when doing translations
 # STANDARD CAPABILITIES
 #
 #%The following is a complete table of the capabilities included in a
-#%terminfo description block and available to terminfo-using code.  In each
-#%line of the table,
-#%
+#%terminfo description block and available to terminfo-using code.
+#%In each line of the table,
+#%.bP
 #%The \fBvariable\fR is the name by which the programmer (at the terminfo level)
 #%accesses the capability.
-#%
-#%The \fBcapname\fR is the short name used in the text of the database,
+#%.bP
+#%The \fBcapname\fR (\fICap-name\fP)
+#%is the short name used in the text of the database,
 #%and is used by a person updating the database.
+#%.IP
 #%Whenever possible, capnames are chosen to be the same as or similar to
 #%the ANSI X3.64-1979 standard (now superseded by ECMA-48, which uses
-#%identical or very similar names).  Semantics are also intended to match
-#%those of the specification.
-#%
-#%The termcap code is the old
-#%.B termcap
-#%capability name (some capabilities are new, and have names which termcap
-#%did not originate).
-#%.P
+#%identical or very similar names).
+#%Semantics are also intended to match those of the specification.
+#%.IP
 #%Capability names have no hard length limit, but an informal limit of 5
 #%characters has been adopted to keep them short and to allow the tabs in
 #%the source file
 #%.B Caps
 #%to line up nicely.
-#%
-#%Finally, the description field attempts to convey the semantics of the
-#%capability.  You may find some codes in the description field:
+#%.bP
+#%The \fBtermcap\fP (\fITcap\fP) code is the old capability name
+#%(some capabilities are new, and have names which termcap did not originate).
+#%.bP
+#%Finally, the \fBdescription\fP field attempts to convey the semantics of the
+#%capability.
+#%.PP
+#%You may find some codes in the description field:
 #%.TP
 #%(P)
 #%indicates that padding may be specified
 #%indicates the \fIi\fP\uth\d parameter.
 #%
 #%.PP
-#% These are the boolean capabilities:
+#% These are the Boolean capabilities:
 #%
 #%.na
 #%.TS H
@@ -279,8 +281,8 @@ no_color_video                      ncv     num     NC      -       -       -----   video attributes that cannot be used with
 #%.ad
 #%
 #%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.
+#%but are not yet documented in the man page.
+#%They came in with SVr4's printer support.
 #%
 #%.na
 #%
@@ -569,7 +571,7 @@ key_f62                             kf62    str     Fq      KEY_F(62)       -       ----E   F62 function key
 key_f63                                kf63    str     Fr      KEY_F(63)       -       ----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.  See smgl. (ML is not in BSD termcap).
+set_left_margin                        smgl    str     ML      -               -       -----   set left soft margin at current column.  (ML is not in BSD termcap).
 set_right_margin               smgr    str     MR      -               -       -----   set right soft margin at current column
 device_type                    devt    str     dv      -               -       -----   Indicate language/codeset support
 code_set_init                  csin    str     ci      -               -       -----   Init sequence for multiple codesets
@@ -707,7 +709,7 @@ has_hardware_tabs           OTpt    bool    pt      -               -       YB---   has 8-char tabs invoked with ^I
 return_does_clr_eol            OTxr    bool    xr      -               -       YB---   return clears the line
 # tek_4025_insert_line         OTxx    bool    xx      -               -       -BC--   Tektronix 4025 insert-line glitch
 #
-# mytinfo described this as a termcap capability, but it's not listed in the
+# mytinfo described this as a termcap capability, but it is not listed in the
 # 4.4BSD man pages, and not found in the 4.4BSD termcap file.  The ncurses
 # package, like System V, behaves as though it is always true.
 #