ncurses 4.1
[ncurses.git] / man / dft_fgbg.3x
1 .\"*****************************************************************************
2 .\" Copyright 1997 by Thomas E. Dickey <dickey@clark.net>                      *
3 .\" All Rights Reserved.                                                       *
4 .\"                                                                            *
5 .\" Permission to use, copy, modify, and distribute this software and its      *
6 .\" documentation for any purpose and without fee is hereby granted, provided  *
7 .\" that the above copyright notice appear in all copies and that both that    *
8 .\" copyright notice and this permission notice appear in supporting           *
9 .\" documentation, and that the name of the above listed copyright holder(s)   *
10 .\" not be used in advertising or publicity pertaining to distribution of the  *
11 .\" software without specific, written prior permission. THE ABOVE LISTED      *
12 .\" COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,  *
13 .\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO     *
14 .\" EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY         *
15 .\" SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER       *
16 .\" RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF       *
17 .\" CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN        *
18 .\" CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.                   *
19 .\"*****************************************************************************
20 .\" $Id: dft_fgbg.3x,v 1.1 1997/01/19 02:51:30 tom Exp $
21 .TH use_default_colors 3X ""
22 .
23 .SH NAME
24 \fBuse_default_colors\fP \- use terminal's default colors
25 .
26 .SH SYNOPSIS
27 \fB#include <curses.h>\fP
28
29 \fBint use_default_colors(void);\fP
30 .
31 .SH DESCRIPTION
32 This is an extension to the curses library.
33 It is used with terminals that support ISO 6429 color, or equivalent.
34 These terminals allow the application to reset color to an unspecified
35 default value (e.g., with SGR 39 or SGR 49).
36 Because they are designed to support this, their design usually includes
37 features to change the default foreground or background colors so that
38 they do not match the assumption in XSI curses of white on black.
39 .PP
40 Applications that paint a colored background over the whole screen
41 are not adversely impacted by this type of terminal design.
42 However, there are applications that are designed to work with
43 the default background.
44 .
45 .SH RETURN VALUE
46 The function returns the integer \fBERR\fP upon failure and \fBOK\fP on success.
47 It will fail if either the terminal does not support
48 the \fIorig_pair\fP or \fIorig_colors\fP capability.
49 If the \fIinitialize_pair\fP capability is found, this causes an
50 error as well.
51 .
52 .SH NOTES
53 Associated with this extension, the \fBinit_pair\fP(3x) function accepts
54 negative arguments to specify default foreground or background
55 colors.
56 .
57 .SH PORTABILITY
58 These routines are specific to ncurses.  They were not supported on
59 Version 7, BSD or System V implementations.  It is recommended that
60 any code depending on them be conditioned using NCURSES_VERSION.
61 .
62 .SH SEE ALSO
63 \fBcurs_color\fP(3x),
64 \fBded\fP(1).
65 .
66 .SH AUTHOR
67 Thomas Dickey (from an analysis of the requirements for color xterm
68 for XFree86 3.1.2C, February 1996).
69 .\"#
70 .\"# The following sets edit modes for GNU EMACS
71 .\"# Local Variables:
72 .\"# mode:nroff
73 .\"# fill-column:79
74 .\"# End: