X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;fp=doc%2Fhtml%2Fman%2Fcurs_slk.3x.html;h=84b202d04af49b8074790589bd03df7f4acc9c6b;hp=66a50898a2450d1096cc7d8ef1329fe45a4bdded;hb=da409f83dde1caedbb9c84acaf5943275e60e0e0;hpb=859f2280a309b121d29160e4d066ecc0fd39e52c
diff --git a/doc/html/man/curs_slk.3x.html b/doc/html/man/curs_slk.3x.html
index 66a50898..84b202d0 100644
--- a/doc/html/man/curs_slk.3x.html
+++ b/doc/html/man/curs_slk.3x.html
@@ -27,7 +27,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_slk.3x,v 1.40 2022/02/12 20:05:11 tom Exp @
+ * @Id: curs_slk.3x,v 1.44 2022/10/29 22:44:14 tom Exp @
-->
@@ -59,7 +59,6 @@
int slk_init(int fmt);
int slk_set(int labnum, const char *label, int fmt);
- /* extension */
int slk_wset(int labnum, const wchar_t *label, int fmt);
char *slk_label(int labnum);
@@ -76,7 +75,7 @@
int slk_attr_on(attr_t attrs, void* opts);
int slk_attr_off(const attr_t attrs, void * opts);
int slk_attr_set(const attr_t attrs, short pair, void* opts);
-
+ /* extension */
attr_t slk_attr(void);
int slk_color(short pair);
@@ -117,11 +116,11 @@
library) has three parameters:
labnum
- is the label number, from 1 to 8 (12 for fmt in slk_init is 2
- or 3);
+ is the label number, from 1 to 8 (12 if fmt in slk_init is 2 or
+ 3);
label
- is be the string to put on the label, up to eight (five for fmt
+ is be the string to put on the label, up to eight (five if fmt
in slk_init is 2 or 3) characters in length. A null string or
a null pointer sets up a blank label.
@@ -263,15 +262,44 @@
o It added slk_color.
- The format codes 2 and 3 for slk_init and the function slk_attr are
- specific to ncurses.
+ Although slk_start is declared in the curses header file, it was not
+ documented by SVr4 other than its presence in a list of libtermlib.so.1
+ symbols. Reading the source code (i.e., Illumos):
+
+ o slk_start has two parameters:
+
+ o ng (number of groups) and
+
+ o gp (group pointer).
+
+ o Soft-key groups are an array of ng integers.
+
+ o In SVr4, slk_init calls slk_start passing a null for gp. For this
+ case, slk_start uses the number of groups ng (3 for the 3-2-3 lay-
+ out, 2 for the 4-4 layout) which slk_init provided.
+
+ If ng is neither 2 or 3, slk_start checks the terminfo fln (la-
+ bel_format) capability, interpreting that as a comma-separated list
+ of numbers, e.g., "3,2,3" for the 3-2-3 layout.
+
+ Finally, if there is no fln capability, slk_start returns ERR.
+
+ o If slk_start is given a non-null gp, it copies the ng elements of
+ the group of soft-keys, up to 16.
+
+ If there are more than 16 elements, slk_start returns an error.
+
+ o The format codes 2 and 3 for slk_init were added by ncurses in
+ 1996. PDCurses 2.4 added this feature in 2001.
+
+ The function slk_attr was added by ncurses in 1996.
- X/Open Curses does not specify a limit for the number of colors and
+ X/Open Curses does not specify a limit for the number of colors and
color pairs which a terminal can support. However, in its use of short
- for the parameters, it carries over SVr4's implementation detail for
+ for the parameters, it carries over SVr4's implementation detail for
the compiled terminfo database, which uses signed 16-bit numbers. This
- implementation provides extended versions of those functions which use
- short parameters, allowing applications to use larger color- and pair-
+ implementation provides extended versions of those functions which use
+ int parameters, allowing applications to use larger color- and pair-
numbers.