ncurses 6.0 - patch 20180106

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

diff --git a/man/curs_color.3x b/man/curs_color.3x
index bbb2e3f03d1270c2762c66ebf61a38317898c663..ac868be198df99e4464f348675e56ca468068186 100644 (file)
--- a/man/curs_color.3x
+++ b/man/curs_color.3x
@@ -26,14 +26,15 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_color.3x,v 1.50 2017/04/01 19:57:19 tom Exp $
+.\" $Id: curs_color.3x,v 1.53 2017/11/20 01:03:45 tom Exp $
 .TH curs_color 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
 .de bP
-.IP \(bu 4
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2
 ..
 .ds n 5
 .na
@@ -46,6 +47,7 @@
 \fBinit_color\fR,
 \fBcolor_content\fR,
 \fBpair_content\fR,
+\fBreset_color_pairs\fR,
 \fBCOLOR_PAIR\fR,
 \fBPAIR_NUMBER\fR \- \fBcurses\fR color manipulation routines
 .ad
@@ -79,6 +81,10 @@
 .br
 \fBint extended_pair_content(int pair, int *f, int *b);\fR
 .sp
+/* extensions */
+.br
+\fBvoid reset_color_pairs(void);\fR
+.sp
 \fBint COLOR_PAIR(int n);\fR
 .br
 \fBPAIR_NUMBER(\fR\fIattrs\fR\fB);\fP
@@ -168,7 +174,7 @@ background color for all terminals.
       \fBCOLOR_WHITE\fR
 .fi
 .PP
-Some terminals support more than the eight (8) \*(lqANSI\*(rq colors.
+Some terminals support more than the eight (8) \*(``ANSI\*('' colors.
 There are no standard names for those additional colors. 
 .SH VARIABLES
 .SS COLORS
@@ -202,7 +208,7 @@ initializes its internal table representing the
 red, green and blue components of the color palette.
 .IP
 The components depend on whether the terminal uses
-CGA (aka \*(lqANSI\*(rq) or
+CGA (aka \*(``ANSI\*('') or
 HLS (i.e., the \fBhls\fP (\fBhue_lightness_saturation\fP) capability is set).
 The table is initialized first for eight basic colors
 (black, red, green, yellow, blue, magenta, cyan, and white),
@@ -274,6 +280,11 @@ As an extension, ncurses allows you to set color pair \fB0\fP via
 the \fBassume_default_colors\fR(3X) routine, or to specify the use of
 default colors (color number \fB\-1\fR) if you first invoke the
 \fBuse_default_colors\fR(3X) routine.
+.PP
+The extension \fBreset_color_pairs\fP tells ncurses to discard all
+of the color-pair information which was set with \fBinit_pair\fP.
+It also touches the current- and standard-screens, allowing an application to
+switch color palettes rapidly.
 .SS init_color
 .PP
 The \fBinit_color\fR routine changes the definition of a color.
@@ -335,7 +346,7 @@ The routines \fBcan_change_color\fR and \fBhas_colors\fR return \fBTRUE\fR
 or \fBFALSE\fR.
 .PP
 All other routines return the integer \fBERR\fR upon failure and an \fBOK\fR
-(SVr4 specifies only \*(lqan integer value other than \fBERR\fR\*(rq) upon successful
+(SVr4 specifies only \*(``an integer value other than \fBERR\fR\*('') upon successful
 completion.
 .PP
 X/Open defines no error conditions.
@@ -381,7 +392,7 @@ The A_BLINK attribute should in theory cause the background to go bright.
 This often fails to work, and even some cards for which it mostly works
 (such as the
 Paradise and compatibles) do the wrong thing when you try to set a bright
-\*(lqyellow\*(rq background (you get a blinking yellow foreground instead).
+\*(``yellow\*('' background (you get a blinking yellow foreground instead).
 .bP
 Color RGB values are not settable.
 .SH PORTABILITY
@@ -409,6 +420,8 @@ terminfo database, which uses signed 16-bit numbers.
 This implementation provides extended versions of those functions
 which use \fBshort\fP parameters,
 allowing applications to use larger color- and pair-numbers.
+.PP
+The \fBreset_color_pairs\fP function is an extension of ncurses.
 .SH SEE ALSO
 \fBcurses\fR(3X),
 \fBcurs_initscr\fR(3X),