ncurses 5.2
[ncurses.git] / man / default_colors.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998,1999,2000 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" Author: Thomas E. Dickey <dickey@clark.net> 1997,1999,2000
30 .\"
31 .\" $Id: default_colors.3x,v 1.13 2000/07/15 22:06:50 tom Exp $
32 .TH default_colors 3X ""
33 .SH NAME
34 \fBdefault_colors\fR:
35 \fBuse_default_colors\fR,
36 \fBassume_default_colors\fR \- use terminal's default colors
37 ..
38 .SH SYNOPSIS
39 \fB#include <curses.h>\fP
40
41 \fBint use_default_colors(void);\fP
42 .br
43 \fBint assume_default_colors(int fg, int bg);\fP
44 ..
45 .SH DESCRIPTION
46 The
47 .I use_default_colors()
48 and
49 .I assume_default_colors()
50 functions are extensions to the curses library.
51 They are used with terminals that support ISO 6429 color, or equivalent.
52 These terminals allow the application to reset color to an unspecified
53 default value (e.g., with SGR 39 or SGR 49).
54 .PP
55 Applications that paint a colored background over the whole screen
56 do not take advantage of SGR 39 and SGR 49.
57 Some applications are designed to work with the default background,
58 using colors only for text.
59 For example, there are several implementations of the \fBls\fP program
60 which use colors to denote different file types or permissions.
61 These "color ls" programs do not necessarily modify the background color,
62 typically using only the \fIsetaf\fP terminfo capability to set the
63 foreground color.
64 Full-screen applications that use default colors can achieve similar
65 visual effects.
66 .PP
67 The first function,
68 .I use_default_colors()
69 tells the curses library to assign terminal default
70 foreground/background colors to color number -1. So init_pair(x,COLOR_RED,-1)
71 will initialize pair x as red on default background and init_pair(x,-1,COLOR_BLUE) will
72 initialize pair x as default foreground on blue.
73 .PP
74 The other,
75 .I assume_default_colors()
76 is a refinement which tells which colors to paint for color pair 0.
77 This function recognizes a special color number -1,
78 which denotes the default terminal color.
79 .PP
80 The following are equivalent:
81 .RS
82 .br
83 .I use_default_colors();
84 .br
85 .I assume_default_colors(-1,-1);
86 .RE
87 .PP
88 These are ncurses extensions.
89 For other curses implementations, color
90 number -1 does not mean anything, just as for ncurses before a
91 successful call of \fIuse_default_colors()\fP or \fIassume_default_colors()\fP.
92 .PP
93 Other curses implementations do not allow an application to modify color pair 0.
94 They assume that the background is COLOR_BLACK,
95 but do not ensure that the color pair 0 is painted to match the
96 assumption.
97 If your application does not use either
98 .I use_default_colors()
99 or
100 .I assume_default_colors()
101 ncurses will paint a white foreground (text) with black background
102 for color pair 0.
103 ..
104 .SH RETURN VALUE
105 These functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
106 They will fail if either the terminal does not support
107 the \fIorig_pair\fP or \fIorig_colors\fP capability.
108 If the \fIinitialize_pair\fP capability is found, this causes an
109 error as well.
110 ..
111 .SH NOTES
112 Associated with this extension, the \fBinit_pair\fR(3X) function accepts
113 negative arguments to specify default foreground or background
114 colors.
115 ..
116 .SH PORTABILITY
117 These routines are specific to ncurses.  They were not supported on
118 Version 7, BSD or System V implementations.  It is recommended that
119 any code depending on them be conditioned using NCURSES_VERSION.
120 ..
121 .SH SEE ALSO
122 \fBcurs_color\fR(3X),
123 \fBded\fP(1).
124 ..
125 .SH AUTHOR
126 Thomas Dickey (from an analysis of the requirements for color xterm
127 for XFree86 3.1.2C, February 1996).
128 .\"#
129 .\"# The following sets edit modes for GNU EMACS
130 .\"# Local Variables:
131 .\"# mode:nroff
132 .\"# fill-column:79
133 .\"# End: