aboutsummaryrefslogtreecommitdiff
path: root/contrib/ncurses/man/dft_fgbg.3x
diff options
context:
space:
mode:
authorPeter Wemm <peter@FreeBSD.org>2000-07-03 09:24:12 +0000
committerPeter Wemm <peter@FreeBSD.org>2000-07-03 09:24:12 +0000
commit15589c42fa2774d2f8ee650f4f31eb8d3a861316 (patch)
tree27e79485df3c9195e6fe58960df47f675f41f1e9 /contrib/ncurses/man/dft_fgbg.3x
parent6b9085fd58b7602b14be0cd2059285baa764a7ee (diff)
downloadsrc-15589c42fa2774d2f8ee650f4f31eb8d3a861316.tar.gz
src-15589c42fa2774d2f8ee650f4f31eb8d3a861316.zip
Import the most recent ncurses 5.1 prerelease (20000701).
Mostly this is intended to resolve the trace() badness once and for all. Obtained from: ftp://dickey.his.com/ncurses/
Notes
Notes: svn path=/vendor/ncurses/dist/; revision=62449
Diffstat (limited to 'contrib/ncurses/man/dft_fgbg.3x')
-rw-r--r--contrib/ncurses/man/dft_fgbg.3x54
1 files changed, 40 insertions, 14 deletions
diff --git a/contrib/ncurses/man/dft_fgbg.3x b/contrib/ncurses/man/dft_fgbg.3x
index 2461256857b8..af6773ddea55 100644
--- a/contrib/ncurses/man/dft_fgbg.3x
+++ b/contrib/ncurses/man/dft_fgbg.3x
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc. *
+.\" 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 *
@@ -26,35 +26,61 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" Author: Thomas E. Dickey <dickey@clark.net> 1997
+.\" Author: Thomas E. Dickey <dickey@clark.net> 1997,1999
.\"
-.\" $Id: dft_fgbg.3x,v 1.6 1998/03/14 23:43:15 tom Exp $
+.\" $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 \- use terminal's default colors
+\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
-This is an extension to the curses library.
-It is used with terminals that support ISO 6429 color, or equivalent.
+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).
-Because they are designed to support this, their design usually includes
-features to change the default foreground or background colors so that
-they do not match the assumption in XSI curses of white on black.
.PP
Applications that paint a colored background over the whole screen
-are not adversely impacted by this type of terminal design.
-However, there are applications that are designed to work with
-the default background.
+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
-The function returns the integer \fBERR\fP upon failure and \fBOK\fP on success.
-It will fail if either the terminal does not support
+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.