15589c42fa
Mostly this is intended to resolve the trace() badness once and for all. Obtained from: ftp://dickey.his.com/ncurses/
111 lines
4.6 KiB
Plaintext
111 lines
4.6 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright (c) 1998,1999,2000 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
.\" copy of this software and associated documentation files (the *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" Author: Thomas E. Dickey <dickey@clark.net> 1997,1999
|
|
.\"
|
|
.\" $Id: dft_fgbg.3x,v 1.10 2000/07/01 16:33:31 tom Exp $
|
|
.TH use_default_colors 3X ""
|
|
.SH NAME
|
|
\fBdft_fgbg\fR:
|
|
\fBuse_default_colors\fR,
|
|
\fBassume_default_colors\fR \- use terminal's default colors
|
|
..
|
|
.SH SYNOPSIS
|
|
\fB#include <curses.h>\fP
|
|
|
|
\fBint use_default_colors(void);\fP
|
|
.br
|
|
\fBint assume_default_colors(int fg, int bg);\fP
|
|
..
|
|
.SH DESCRIPTION
|
|
The
|
|
.I use_default_colors()
|
|
and
|
|
.I assume_default_colors()
|
|
functions are extensions to the curses library.
|
|
They are used with terminals that support ISO 6429 color, or equivalent.
|
|
These terminals allow the application to reset color to an unspecified
|
|
default value (e.g., with SGR 39 or SGR 49).
|
|
.PP
|
|
Applications that paint a colored background over the whole screen
|
|
do not take advantage of SGR 39 and SGR 49.
|
|
Some applications are designed to work with the default background.
|
|
.PP
|
|
The first function,
|
|
.I use_default_colors()
|
|
tells the curses library to assign terminal default
|
|
foreground/background colors to color number -1. So init_pair(x,COLOR_RED,-1)
|
|
will initialize pair x as red on default background and init_pair(x,-1,COLOR_BLUE) will
|
|
initialize pair x as default foreground on blue.
|
|
.PP
|
|
The other,
|
|
.I assume_default_colors()
|
|
is a refinement which tells which colors to paint for color pair 0, and -1 means default terminal color.
|
|
The following are equivalent:
|
|
.RS
|
|
.br
|
|
.I use_default_colors();
|
|
.br
|
|
.I assume_default_colors(-1,-1);
|
|
.RE
|
|
.PP
|
|
This is a ncurses extension and for other curses implementations color
|
|
number -1 does not mean anything, just as for ncurses before a
|
|
successful call of use_default_colors or assume_default_colors.
|
|
..
|
|
.SH RETURN VALUE
|
|
These functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
|
|
They will fail if either the terminal does not support
|
|
the \fIorig_pair\fP or \fIorig_colors\fP capability.
|
|
If the \fIinitialize_pair\fP capability is found, this causes an
|
|
error as well.
|
|
..
|
|
.SH NOTES
|
|
Associated with this extension, the \fBinit_pair\fR(3X) function accepts
|
|
negative arguments to specify default foreground or background
|
|
colors.
|
|
..
|
|
.SH PORTABILITY
|
|
These routines are specific to ncurses. They were not supported on
|
|
Version 7, BSD or System V implementations. It is recommended that
|
|
any code depending on them be conditioned using NCURSES_VERSION.
|
|
..
|
|
.SH SEE ALSO
|
|
\fBcurs_color\fR(3X),
|
|
\fBded\fP(1).
|
|
..
|
|
.SH AUTHOR
|
|
Thomas Dickey (from an analysis of the requirements for color xterm
|
|
for XFree86 3.1.2C, February 1996).
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|