ncurses 5.7 - patch 20101002

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

diff --git a/man/curs_slk.3x b/man/curs_slk.3x
index e4055c841db967f92996f47aee6a71da6f9ef56f..0e95b0bd54122bc5d85c26f9a75c145107e0a43c 100644 (file)
--- a/man/curs_slk.3x
+++ b/man/curs_slk.3x
@@ -26,13 +26,14 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_slk.3x,v 1.17 2010/01/30 21:29:04 tom Exp $
+.\" $Id: curs_slk.3x,v 1.21 2010/10/02 23:21:04 tom Exp $

 .TH curs_slk 3X ""
 .na
 .hy 0
 .SH NAME
 \fBslk_init\fR,
 \fBslk_set\fR,
 .TH curs_slk 3X ""
 .na
 .hy 0
 .SH NAME
 \fBslk_init\fR,
 \fBslk_set\fR,

+\fBslk_wset\fR,

 \fBslk_refresh\fR,
 \fBslk_noutrefresh\fR,
 \fBslk_label\fR,
 \fBslk_refresh\fR,
 \fBslk_noutrefresh\fR,
 \fBslk_label\fR,


@@ -46,7 +47,7 @@
 \fBslk_attr_set\fR,
 \fBslk_attr_off\fR,
 \fBslk_attr\fR,
 \fBslk_attr_set\fR,
 \fBslk_attr_off\fR,
 \fBslk_attr\fR,

-\fBslk_color\fR - \fBcurses\fR soft label routines
+\fBslk_color\fR \- \fBcurses\fR soft label routines

 .ad
 .hy
 .SH SYNOPSIS
 .ad
 .hy
 .SH SYNOPSIS


@@ -78,13 +79,13 @@
 .br
 \fBint slk_attr_off(const attr_t attrs, void * opts);\fR
 .br
 .br
 \fBint slk_attr_off(const attr_t attrs, void * opts);\fR
 .br

-\fBint slk_attr_set(const attr_t attrs,\fR
-.br
-       \fBshort color_pair_number, void* opts);\fR
+\fBint slk_attr_set(const attr_t attrs, short color_pair, void* opts);\fR

 .br
 \fBattr_t slk_attr(void);\fR
 .br
 .br
 \fBattr_t slk_attr(void);\fR
 .br

-\fBint slk_color(short color_pair_number);\fR
+\fBint slk_color(short color_pair);\fR
+.br
+\fBint slk_wset(int labnum, const wchar_t *label, int fmt);\fR

 .br
 .SH DESCRIPTION
 The slk* functions manipulate the set of soft function-key labels that exist on
 .br
 .SH DESCRIPTION
 The slk* functions manipulate the set of soft function-key labels that exist on


@@ -111,22 +112,24 @@ then \fIfmt\fR determines how the labels are arranged on the screen:
 .RS
 .TP 3
 .B 0
 .RS
 .TP 3
 .B 0

-indicates a 3-2-3 arrangement of
+indicates a 3\-2\-3 arrangement of

 the labels.
 .TP 3
 .B 1
 the labels.
 .TP 3
 .B 1

-indicates a 4-4 arrangement
+indicates a 4\-4 arrangement

 .TP 3
 .B 2
 .TP 3
 .B 2

-indicates the PC-like 4-4-4 mode.
+indicates the PC-like 4\-4\-4 mode.

 .TP 3
 .B 3
 .TP 3
 .B 3

-is again the PC-like 4-4-4 mode,
+is again the PC-like 4\-4\-4 mode,

 but in addition an index line is generated, helping the user to
 identify the key numbers easily.
 .RE
 .PP
 but in addition an index line is generated, helping the user to
 identify the key numbers easily.
 .RE
 .PP

-The \fBslk_set\fR routine has three parameters:
+The \fBslk_set\fR routine
+(and the \fBslk_wset\fR routine for the wide-character library)
+has three parameters:

 .RS
 .TP 5
 .I labnum
 .RS
 .TP 5
 .I labnum


@@ -198,13 +201,13 @@ 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..COLOR_PAIRS\-1,

 or opts is not null.
 .TP 5
 \fBslk_color\fP
 returns an error
 if the terminal or the softkeys were not initialized, or
 or opts is not null.
 .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..COLOR_PAIRS\-1.

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


@@ -232,7 +235,11 @@ qualifiers.
 The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the
 function \fBslk_attr\fR are specific to ncurses.
 .SH SEE ALSO
 The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the
 function \fBslk_attr\fR are specific to ncurses.
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X)
+\fBcurses\fR(3X),
+\fBcurs_attr\fR(3X),
+\fBcurs_initscr\fR(3X),
+\fBcurs_refresh\fR(3X),
+\fBcurs_variables\fR(3X).

 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables:
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: