ncurses 6.2 - patch 20201024
[ncurses.git] / man / default_colors.3x
1 .\"***************************************************************************
2 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
3 .\" Copyright 2000-2011,2016 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" Author: Thomas E. Dickey 1997,1999,2000,2005
31 .\"
32 .\" $Id: default_colors.3x,v 1.30 2020/10/24 09:52:16 tom Exp $
33 .TH default_colors 3X ""
34 .ie \n(.g .ds `` \(lq
35 .el       .ds `` ``
36 .ie \n(.g .ds '' \(rq
37 .el       .ds '' ''
38 .SH NAME
39 \fBuse_default_colors\fR,
40 \fBassume_default_colors\fR \- use terminal's default colors
41 .SH SYNOPSIS
42 \fB#include <curses.h>\fP
43 .sp
44 \fBint use_default_colors(void);\fP
45 .br
46 \fBint assume_default_colors(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
47 .SH DESCRIPTION
48 The \fBuse_default_colors\fP and \fBassume_default_colors\fP
49 functions are extensions to the curses library.
50 They are used with terminals that support ISO 6429 color, or equivalent.
51 These terminals allow the application to reset color to an unspecified
52 default value (e.g., with SGR 39 or SGR 49).
53 .PP
54 Applications that paint a colored background over the whole screen
55 do not take advantage of SGR 39 and SGR 49.
56 Some applications are designed to work with the default background,
57 using colors only for text.
58 For example, there are several implementations of the \fBls\fP program
59 which use colors to denote different file types or permissions.
60 These \*(``color ls\*('' programs do not necessarily modify the background color,
61 typically using only the \fBsetaf\fP terminfo capability to set the
62 foreground color.
63 Full-screen applications that use default colors can achieve similar
64 visual effects.
65 .PP
66 The first function, \fBuse_default_colors\fP
67 tells the curses library to assign terminal default
68 foreground/background colors to color number \-1.
69 So init_pair(x,COLOR_RED,\-1)
70 will initialize pair x as red on default background
71 and init_pair(x,\-1,COLOR_BLUE) will
72 initialize pair x as default foreground on blue.
73 .PP
74 The other, \fBassume_default_colors\fP
75 is a refinement which tells which colors to paint for color pair 0.
76 This function recognizes a special color number \-1,
77 which denotes the default terminal color.
78 .PP
79 The following are equivalent:
80 .RS
81 .br
82 .I use_default_colors();
83 .br
84 .I assume_default_colors(\-1,\-1);
85 .RE
86 .PP
87 These are ncurses extensions.
88 For other curses implementations, color
89 number \-1 does not mean anything, just as for ncurses before a
90 successful call of \fBuse_default_colors\fP or \fBassume_default_colors\fP.
91 .PP
92 Other curses implementations do not allow an application to modify color pair 0.
93 They assume that the background is COLOR_BLACK,
94 but do not ensure that the color pair 0 is painted to match the
95 assumption.
96 If your application does not use either
97 .B use_default_colors
98 or
99 .B assume_default_colors
100 ncurses will paint a white foreground (text) with black background
101 for color pair 0.
102 .SH RETURN VALUE
103 These functions return the integer \fBERR\fP upon failure
104 and \fBOK\fP on success.
105 They will fail if either the terminal does not support
106 the \fBorig_pair\fP or \fBorig_colors\fP capability.
107 If the \fBinitialize_pair\fP capability is not found, this causes an
108 error as well.
109 .SH NOTES
110 Associated with this extension, the \fBinit_pair\fR function accepts
111 negative arguments to specify default foreground or background colors.
112 .PP
113 The \fBuse_default_colors\fP function was added to support \fIded\fP.
114 This is a full-screen application which uses curses to manage only part
115 of the screen.
116 The bottom portion of the screen, which is of adjustable
117 size, is left uncolored to display the results from shell commands.
118 The top portion of the screen colors filenames using a scheme like the
119 \*(``color ls\*('' programs.
120 Attempting to manage the background color of the screen for this application
121 would give unsatisfactory results for a variety of reasons.
122 This extension was devised after
123 noting that color xterm (and similar programs) provides a background color
124 which does not necessarily correspond to any of the ANSI colors.
125 While a special terminfo entry could be constructed using nine colors,
126 there was no mechanism provided within curses to account for the related
127 \fBorig_pair\fP and \fBback_color_erase\fP capabilities.
128 .PP
129 The \fBassume_default_colors\fP function was added to solve
130 a different problem: support for applications which would use
131 environment variables and other configuration to bypass curses'
132 notion of the terminal's default colors, setting specific values.
133 .SH PORTABILITY
134 These routines are specific to ncurses.
135 They were not supported on
136 Version 7, BSD or System V implementations.
137 It is recommended that
138 any code depending on them be conditioned using NCURSES_VERSION.
139 .SH SEE ALSO
140 \fBcurs_color\fR(3X),
141 \fBded\fP(1).
142 .SH AUTHOR
143 Thomas Dickey (from an analysis of the requirements for color xterm
144 for XFree86 3.1.2C, February 1996).