.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_color.3x,v 1.31 2010/08/14 23:11:23 Tim.van.der.Molen Exp $
+.\" $Id: curs_color.3x,v 1.35 2010/12/20 00:50:58 tom Exp $
.TH curs_color 3X ""
+.de bP
+.IP \(bu 4
+..
.na
.hy 0
.SH NAME
.hy
.SH SYNOPSIS
\fB# include <curses.h>\fR
-.br
+.sp
\fBint start_color(void);\fR
.br
\fBint init_pair(short pair, short f, short b);\fR
three arguments: the number of the color-pair to be changed, the foreground
color number, and the background color number.
For portable applications:
-.TP 5
-\-
+.bP
The value of the first argument
must be between \fB1\fR and \fBCOLOR_PAIRS\-1\fR,
except that if default colors are used (see \fBuse_default_colors\fP)
the upper limit is adjusted to allow for extra pairs which use
a default color in foreground and/or background.
-.TP 5
-\-
+.bP
The value of the second and
third arguments must be between 0 and \fBCOLORS\fR.
Color pair 0 is assumed to be white on black,
This implementation will return \fBERR\fR on attempts to
use color values outside the range 0 to COLORS\-1
(except for the default colors extension),
-or use color pairs outside the range 0 to COLOR_PAIR\-1.
+or use color pairs outside the range 0 to COLOR_PAIRS\-1.
Color values used in \fBinit_color\fP must be in the range 0 to 1000.
An error is returned from all functions
if the terminal has not been initialized.
An error is returned from secondary functions such as \fBinit_pair\fP
if \fBstart_color\fP was not called.
-.RS
+.RS 3
.TP 5
\fBinit_color\fP
returns an error if the terminal does not support
scrolling operations, see \fBcurs_bkgd\fR(3X).
.PP
Several caveats apply on 386 and 486 machines with VGA-compatible graphics:
-.TP 5
-\-
+.bP
COLOR_YELLOW is actually brown. To get yellow, use COLOR_YELLOW combined with
the \fBA_BOLD\fR attribute.
-.TP 5
-\-
+.bP
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
"yellow" background (you get a blinking yellow foreground instead).
-.TP 5
-\-
+.bP
Color RGB values are not settable.
.SH PORTABILITY
This implementation satisfies XSI Curses's minimum maximums
\fBcurses\fR(3X),
\fBcurs_initscr\fR(3X),
\fBcurs_attr\fR(3X),
+\fBcurs_variables\fR(3X),
\fBdefault_colors\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: