ncurses 6.4 - patch 20231021

[ncurses.git] / man / curs_slk.3x

diff --git a/man/curs_slk.3x b/man/curs_slk.3x
index 7d791b1d75e21a53247f60ee9759585f606ec5cf..7bc27a6de4f03c32dbd64f1ee924965894eee788 100644 (file)
--- a/man/curs_slk.3x
+++ b/man/curs_slk.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *

 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,102 +27,94 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_slk.3x,v 1.45 2022/10/29 22:44:14 tom Exp $
-.TH curs_slk 3X 2022-10-29 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_slk.3x,v 1.64 2023/10/21 10:31:22 tom Exp $
+.TH curs_slk 3X 2023-10-21 "ncurses 6.4" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.

 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..

-.na
-.hy 0

 .SH NAME
 .SH NAME

-\fBslk_init\fP,
-\fBslk_set\fP,
-\fBslk_wset\fP,
-\fBslk_refresh\fP,
-\fBslk_noutrefresh\fP,
-\fBslk_label\fP,
-\fBslk_clear\fP,
-\fBslk_restore\fP,
-\fBslk_touch\fP,
-\fBslk_attron\fP,
-\fBslk_attrset\fP,
-\fBslk_attroff\fP,
-\fBslk_attr_on\fP,
-\fBslk_attr_set\fP,
-\fBslk_attr_off\fP,
-\fBslk_attr\fP,
-\fBslk_color\fP,
-\fBextended_slk_color\fP \- \fBcurses\fP soft label routines
-.ad
-.hy
+\fB\%slk_init\fP,
+\fB\%slk_set\fP,
+\fB\%slk_wset\fP,
+\fB\%slk_refresh\fP,
+\fB\%slk_noutrefresh\fP,
+\fB\%slk_label\fP,
+\fB\%slk_clear\fP,
+\fB\%slk_restore\fP,
+\fB\%slk_touch\fP,
+\fB\%slk_attron\fP,
+\fB\%slk_attrset\fP,
+\fB\%slk_attroff\fP,
+\fB\%slk_attr_on\fP,
+\fB\%slk_attr_set\fP,
+\fB\%slk_attr_off\fP,
+\fB\%slk_attr\fP,
+\fB\%slk_color\fP,
+\fB\%extended_slk_color\fP \-
+\fIcurses\fR soft label key routines

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-.sp
-\fBint slk_init(int \fIfmt\fB);\fR
-.sp
-\fBint slk_set(int \fIlabnum\fB, const char *\fIlabel\fB, int \fIfmt\fB);\fR
-.br
-\fBint slk_wset(int \fIlabnum\fB, const wchar_t *\fIlabel\fB, int \fIfmt\fB);\fR
-.sp
-\fBchar *slk_label(int \fIlabnum\fB);\fR
-.sp
-\fBint slk_refresh(void);\fP
-.br
-\fBint slk_noutrefresh(void);\fP
-.br
-\fBint slk_clear(void);\fP
-.br
-\fBint slk_restore(void);\fP
-.br
-\fBint slk_touch(void);\fP
-.sp
-\fBint slk_attron(const chtype \fIattrs\fB);\fR
-.br
-\fBint slk_attroff(const chtype \fIattrs\fB);\fR
-.br
-\fBint slk_attrset(const chtype \fIattrs\fB);\fR
-.br
-\fBint slk_attr_on(attr_t \fIattrs\fB, void* \fIopts\fB);\fR
-.br
-\fBint slk_attr_off(const attr_t \fIattrs\fB, void * \fIopts\fB);\fR
-.br
-\fBint slk_attr_set(const attr_t \fIattrs\fB, short \fIpair\fB, void* \fIopts\fB);\fR
-.br
-/* extension */
-.br
-\fBattr_t slk_attr(void);\fP
-.sp
-\fBint slk_color(short \fIpair\fB);\fR
-.br
-/* extension */
-.br
-\fBint extended_slk_color(int \fIpair\fB);\fR
+.nf
+\fB#include <curses.h>
+.PP
+\fBint slk_init(int \fIfmt\fP);
+.PP
+\fBint slk_set(int \fIlabnum\fP, const char *\fIlabel\fP, int \fIfmt\fP);
+\fBint slk_wset(int \fIlabnum\fP, const wchar_t *\fIlabel\fP, int \fIfmt\fP);
+.PP
+\fBchar *slk_label(int \fIlabnum\fP);
+.PP
+\fBint slk_refresh(void);
+\fBint slk_noutrefresh(void);
+\fBint slk_clear(void);
+\fBint slk_restore(void);
+\fBint slk_touch(void);
+.PP
+\fBint slk_attron(const chtype \fIattrs\fP);
+\fBint slk_attroff(const chtype \fIattrs\fP);
+\fBint slk_attrset(const chtype \fIattrs\fP);
+\fBint slk_attr_on(attr_t \fIattrs\fP, void* \fIopts\fP);
+\fBint slk_attr_off(const attr_t \fIattrs\fP, void * \fIopts\fP);
+\fBint slk_attr_set(const attr_t \fIattrs\fP, short \fIpair\fP, void* \fIopts\fP);
+\fI/* extension */
+\fBattr_t slk_attr(void);
+.PP
+\fBint slk_color(short \fIpair\fP);
+\fI/* extension */
+\fBint extended_slk_color(int \fIpair\fP);
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-The slk* functions manipulate the set of soft function-key labels that exist on
-many terminals.
+The \fBslk\fP* functions manipulate the set
+of soft function-key labels that exist on many terminals.

 For those terminals that do not have soft labels,
 For those terminals that do not have soft labels,

-\fBcurses\fP takes over the bottom line of \fBstdscr\fP, reducing the size of
-\fBstdscr\fP and the variable \fBLINES\fP.
-\fBcurses\fP standardizes on eight
+\fIcurses\fP takes over the bottom line of \fB\%stdscr\fP, reducing the size of
+\fB\%stdscr\fP and the variable \fBLINES\fP.
+\fIcurses\fP standardizes on eight

 labels of up to eight characters each.
 labels of up to eight characters each.

-In addition to this, the ncurses
+In addition to this, the \fIncurses\fP

 implementation supports a mode where it simulates 12 labels of up to five
 characters each.
 This is useful for PC-like enduser devices.
 implementation supports a mode where it simulates 12 labels of up to five
 characters each.
 This is useful for PC-like enduser devices.

-ncurses simulates this mode by taking over up to two lines at
+\fIncurses\fP simulates this mode by taking over up to two lines at

 the bottom of the screen;
 it does not try to use any hardware support for this
 mode.
 .SS Initialization
 the bottom of the screen;
 it does not try to use any hardware support for this
 mode.
 .SS Initialization

-.PP
-The \fBslk_init\fP routine must be called before \fBinitscr\fP or \fBnewterm\fP
+The \fB\%slk_init\fP routine must be called
+before \fB\%initscr\fP or \fB\%newterm\fP

 is called.
 is called.

-If \fBinitscr\fP eventually uses a line from \fBstdscr\fP to
+If \fB\%initscr\fP eventually uses a line from \fB\%stdscr\fP to

 emulate the soft labels,
 then \fIfmt\fP determines how the labels are arranged on the screen:
 .RS 3
 emulate the soft labels,
 then \fIfmt\fP determines how the labels are arranged on the screen:
 .RS 3


@@ -143,20 +135,19 @@ but in addition an index line is generated, helping the user to
 identify the key numbers easily.
 .RE
 .SS Labels
 identify the key numbers easily.
 .RE
 .SS Labels

-.PP
-The \fBslk_set\fP routine
-(and the \fBslk_wset\fP routine for the wide-character library)
+The \fB\%slk_set\fP routine
+(and the \fB\%slk_wset\fP routine for the wide-character library)

 has three parameters:
 .RS 3
 .TP 5
 .I labnum
 is the label number, from \fB1\fP to \fB8\fP
 has three parameters:
 .RS 3
 .TP 5
 .I labnum
 is the label number, from \fB1\fP to \fB8\fP

-(12 if \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP);
+(12 if \fIfmt\fP in \fB\%slk_init\fP is \fB2\fP or \fB3\fP);

 .TP
 .I label
 is be the string to put on the label,
 up to eight
 .TP
 .I label
 is be the string to put on the label,
 up to eight

-(five if \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP)
+(five if \fIfmt\fP in \fB\%slk_init\fP is \fB2\fP or \fB3\fP)

 characters in length.
 A null string or a null pointer sets up a blank label.
 .TP
 characters in length.
 A null string or a null pointer sets up a blank label.
 .TP


@@ -167,39 +158,37 @@ left-justified, centered, or right-justified, respectively, within the
 label.
 .RE
 .PP
 label.
 .RE
 .PP

-The \fBslk_label\fP routine returns the current label for label number
+The \fB\%slk_label\fP routine returns the current label for label number

 \fIlabnum\fP, with leading and trailing blanks stripped.
 .SS Screen updates
 \fIlabnum\fP, with leading and trailing blanks stripped.
 .SS Screen updates

+The \fB\%slk_refresh\fP and \fB\%slk_noutrefresh\fP routines correspond to
+the \fB\%wrefresh\fP and \fB\%wnoutrefresh\fP routines.

 .PP
 .PP

-The \fBslk_refresh\fP and \fBslk_noutrefresh\fP routines correspond to
-the \fBwrefresh\fP and \fBwnoutrefresh\fP routines.
-.PP
-The \fBslk_clear\fP routine clears the soft labels from the screen.
+The \fB\%slk_clear\fP routine clears the soft labels from the screen.

 .PP
 .PP

-The \fBslk_restore\fP routine restores the soft labels to the screen
-after a \fBslk_clear\fP has been performed.
+The \fB\%slk_restore\fP routine restores the soft labels to the screen
+after a \fB\%slk_clear\fP has been performed.

 .PP
 .PP

-The \fBslk_touch\fP routine forces all the soft labels to be output
-the next time a \fBslk_noutrefresh\fP is performed.
+The \fB\%slk_touch\fP routine forces all the soft labels to be output
+the next time a \fB\%slk_noutrefresh\fP is performed.

 .SS Video attributes
 .SS Video attributes

-.PP

 The
 The

-\fBslk_attron\fP, \fBslk_attrset\fP, \fBslk_attroff\fP and \fBslk_attr\fP
+\fB\%slk_attron\fP, \fB\%slk_attrset\fP, \fB\%slk_attroff\fP and \fB\%slk_attr\fP

 routines correspond to
 routines correspond to

-\fBattron\fP, \fBattrset\fP, \fBattroff\fP and \fBattr_get\fP, respectively.
+\fB\%attron\fP, \fB\%attrset\fP, \fB\%attroff\fP and \fB\%attr_get\fP, respectively.

 They have an effect only if soft labels are simulated on the bottom line of
 the screen.
 The default highlight for soft keys is A_STANDOUT (as in
 They have an effect only if soft labels are simulated on the bottom line of
 the screen.
 The default highlight for soft keys is A_STANDOUT (as in

-System V curses, which does not document this fact).
+System V \fIcurses\fP, which does not document this fact).

 .SS Colors
 .SS Colors

-.PP
-The \fBslk_color\fP routine corresponds to \fBcolor_set\fP.
+The \fB\%slk_color\fP routine corresponds to \fB\%color_set\fP.

 It has an effect only
 if soft labels are simulated on the bottom line of the screen.
 .PP
 It has an effect only
 if soft labels are simulated on the bottom line of the screen.
 .PP

-Because \fBslk_color\fP accepts only \fBshort\fP (signed 16-bit integer) values,
+Because \fB\%slk_color\fP accepts
+only \fBshort\fP (signed 16-bit integer) values,

 this implementation provides
 this implementation provides

-\fBextended_slk_color\fP which accepts an integer value, e.g., 32-bits.
+\fB\%extended_slk_color\fP which accepts an integer value, e.g., 32-bits.

 .
 .SH RETURN VALUE
 These routines return \fBERR\fP upon failure
 .
 .SH RETURN VALUE
 These routines return \fBERR\fP upon failure


@@ -213,11 +202,7 @@ In this implementation
 \fBslk_attr\fP
 returns the attribute used for the soft keys.
 .TP 5
 \fBslk_attr\fP
 returns the attribute used for the soft keys.
 .TP 5

-.na
-.hy 0

 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP
 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP

-.ad
-.hy

 return an error
 if the terminal or the softkeys were not initialized.
 .TP 5
 return an error
 if the terminal or the softkeys were not initialized.
 .TP 5


@@ -228,12 +213,12 @@ if the terminal or the softkeys were not initialized.
 \fBslk_attr_set\fP
 returns an error
 if the terminal or the softkeys were not initialized, or
 \fBslk_attr_set\fP
 returns an error
 if the terminal or the softkeys were not initialized, or

-the color pair is outside the range 0..COLOR_PAIRS\-1.
+the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.

 .TP 5
 \fBslk_color\fP
 returns an error
 if the terminal or the softkeys were not initialized, or
 .TP 5
 \fBslk_color\fP
 returns an error
 if the terminal or the softkeys were not initialized, or

-the color pair is outside the range 0..COLOR_PAIRS\-1.
+the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.

 .TP 5
 \fBslk_init\fP
 returns an error
 .TP 5
 \fBslk_init\fP
 returns an error


@@ -251,66 +236,66 @@ memory for the labels cannot be allocated.
 .RE
 .SH HISTORY
 SVr3 introduced these functions:
 .RE
 .SH HISTORY
 SVr3 introduced these functions:

-  slk_clear
-  slk_init
-  slk_label
-  slk_noutrefresh
-  slk_refresh
-  slk_restore
-  slk_set
-  slk_touch
+  \fBslk_clear\fP
+  \fBslk_init\fP
+  \fBslk_label\fP
+  \fBslk_noutrefresh\fP
+  \fBslk_refresh\fP
+  \fBslk_restore\fP
+  \fBslk_set\fP
+  \fBslk_touch\fP

 .PP
 SVr4 added these functions:
 .PP
 SVr4 added these functions:

-  slk_attroff
-  slk_attron
-  slk_attrset
-  slk_start
+  \fBslk_attroff\fP
+  \fBslk_attron\fP
+  \fBslk_attrset\fP
+  \fBslk_start\fP

 .PP
 .PP

-X/Open Curses added these:
-  slk_attr_off
-  slk_attr_on
-  slk_attr_set
-  slk_color
-  slk_wset
+X/Open \fIcurses\fP added these:
+  \fBslk_attr_off\fP
+  \fBslk_attr_on\fP
+  \fBslk_attr_set\fP
+  \fBslk_color\fP
+  \fBslk_wset\fP

 .SH EXTENSIONS
 .SH EXTENSIONS

-.PP
-X/Open Curses documents the \fIopts\fP argument as reserved for future use,
+X/Open \fIcurses\fP documents the \fIopts\fP argument
+as reserved for future use,

 saying that it must be null.
 This implementation
 uses that parameter in ABI 6 for the functions which have a color-pair
 parameter to support extended color pairs.
 .PP
 saying that it must be null.
 This implementation
 uses that parameter in ABI 6 for the functions which have a color-pair
 parameter to support extended color pairs.
 .PP

-For  functions  which modify the color, e.g., \fBslk_attr_set\fP,
+For  functions  which modify the color, e.g., \fB\%slk_attr_set\fP,

 if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 and used to  set  the  color pair instead of the \fBshort\fP pair parameter.
 .SH NOTES
 if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 and used to  set  the  color pair instead of the \fBshort\fP pair parameter.
 .SH NOTES

-Most applications would use \fBslk_noutrefresh\fP because a
-\fBwrefresh\fP is likely to follow soon.
+Most applications would use \fB\%slk_noutrefresh\fP because a
+\fB\%wrefresh\fP is likely to follow soon.

 .SH PORTABILITY
 .SH PORTABILITY

-The XSI Curses standard, Issue 4, described the soft-key functions,
-with some differences from SVr4 curses:
+The XSI \fIcurses\fP standard, Issue 4, described the soft-key functions,
+with some differences from SVr4 \fIcurses\fP:

 .bP
 It added functions like the SVr4
 .bP
 It added functions like the SVr4

-attribute-manipulation functions \fBslk_attron\fP,
-\fBslk_attroff\fP, \fBslk_attrset\fP,
-but which use \fBattr_t\fP parameters (rather than \fBchtype\fP),
+attribute-manipulation functions \fB\%slk_attron\fP,
+\fB\%slk_attroff\fP, \fB\%slk_attrset\fP,
+but which use \fBattr_t\fP parameters (rather than \fB\%chtype\fP),

 along with a reserved \fIopts\fP parameter.
 .IP
 Two of these new functions (unlike the SVr4 functions) have no provision
 along with a reserved \fIopts\fP parameter.
 .IP
 Two of these new functions (unlike the SVr4 functions) have no provision

-for color: \fBslk_attr_on\fP and \fBslk_attr_off\fP.
+for color: \fB\%slk_attr_on\fP and \fB\%slk_attr_off\fP.

 .IP
 .IP

-The third function (\fBslk_attr_set\fP) has a color-pair parameter.
+The third function \%(\fBslk_attr_set\fP) has a color-pair parameter.

 .bP
 It added \fBconst\fP qualifiers to parameters (unnecessarily), and
 .bP
 .bP
 It added \fBconst\fP qualifiers to parameters (unnecessarily), and
 .bP

-It added \fBslk_color\fP.
+It added \fB\%slk_color\fP.

 .PP
 .PP

-Although \fBslk_start\fP is declared in the curses header file,
+Although \fB\%slk_start\fP is declared in the \fIcurses\fP 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):
 .bP
 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):
 .bP

-\fBslk_start\fP has two parameters:
+\fB\%slk_start\fP has two parameters:

 .RS
 .bP
 \fIng\fP (number of groups) and
 .RS
 .bP
 \fIng\fP (number of groups) and


@@ -320,29 +305,30 @@ Reading the source code (i.e., Illumos):
 .bP
 Soft-key groups are an array of \fIng\fP integers.
 .bP
 .bP
 Soft-key groups are an array of \fIng\fP integers.
 .bP

-In SVr4, \fBslk_init\fP calls \fBslk_start\fP passing a null for \fIgp\fP. 
-For this case, \fBslk_start\fP uses the number of groups \fIng\fP
-(3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fBslk_init\fP provided.
+In SVr4, \fB\%slk_init\fP calls \fB\%slk_start\fP passing a null for \fIgp\fP.
+For this case, \fB\%slk_start\fP uses the number of groups \fIng\fP
+(3 for the 3-2-3 layout, 2 for the 4-4 layout) which \fB\%slk_init\fP provided.

 .IP
 If \fIng\fP is neither 2 or 3,
 .IP
 If \fIng\fP is neither 2 or 3,

-\fBslk_start\fP checks the terminfo \fIfln\fP (label_format) capability,
+\fB\%slk_start\fP checks the terminfo \fBfln\fP (label_format) capability,

 interpreting that as a comma-separated list of numbers,
 e.g., \*(``3,2,3\*('' for the 3-2-3 layout.
 .IP
 interpreting that as a comma-separated list of numbers,
 e.g., \*(``3,2,3\*('' for the 3-2-3 layout.
 .IP

-Finally, if there is no \fIfln\fP capability, \fBslk_start\fP returns ERR.
+Finally, if there is no \fBfln\fP capability,
+\fB\%slk_start\fP returns \fBERR\fP.

 .bP
 .bP

-If \fBslk_start\fP is given a non-null \fIgp\fP,
+If \fB\%slk_start\fP is given a non-null \fIgp\fP,

 it copies the \fIng\fP elements of the group of soft-keys, up to 16.
 .IP
 it copies the \fIng\fP elements of the group of soft-keys, up to 16.
 .IP

-If there are more than 16 elements, \fBslk_start\fP returns an error.
+If there are more than 16 elements, \fB\%slk_start\fP returns an error.

 .bP
 .bP

-The format codes \fB2\fP and \fB3\fP for \fBslk_init\fP
-were added by ncurses in 1996.
+The format codes \fB2\fP and \fB3\fP for \fB\%slk_init\fP
+were added by \fIncurses\fP in 1996.

 PDCurses 2.4 added this feature in 2001.
 .PP
 PDCurses 2.4 added this feature in 2001.
 .PP

-The function \fBslk_attr\fP was added by ncurses in 1996.
+The function \fB\%slk_attr\fP was added by \fIncurses\fP in 1996.

 .PP
 .PP

-X/Open Curses does not specify a limit for the number of colors and
+X/Open \fIcurses\fP does not specify a limit for the number of colors and

 color pairs which a terminal can support.
 However, in its use of \fBshort\fP for the parameters,
 it carries over SVr4's implementation detail for the compiled
 color pairs which a terminal can support.
 However, in its use of \fBshort\fP for the parameters,
 it carries over SVr4's implementation detail for the compiled


@@ -351,8 +337,8 @@ This implementation provides extended versions of those functions
 which use \fBint\fP parameters,
 allowing applications to use larger color- and pair-numbers.
 .SH SEE ALSO
 which use \fBint\fP parameters,
 allowing applications to use larger color- and pair-numbers.
 .SH SEE ALSO

-\fBcurses\fP(3X),
-\fBcurs_attr\fP(3X),
-\fBcurs_initscr\fP(3X),
-\fBcurs_refresh\fP(3X),
-\fBcurs_variables\fP(3X).
+\fB\%curses\fP(3X),
+\fB\%curs_attr\fP(3X),
+\fB\%curs_initscr\fP(3X),
+\fB\%curs_refresh\fP(3X),
+\fB\%curs_variables\fP(3X)