1.\"	$NetBSD: curses_default_colors.3,v 1.2 2002/10/21 14:17:54 wiz Exp $
2.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
3.\" All rights reserved.
4.\"
5.\" This code is derived from software contributed to The NetBSD Foundation
6.\" by Julian Coleman.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of The NetBSD Foundation nor the names of its
17.\"    contributors may be used to endorse or promote products derived
18.\"    from this software without specific prior written permission.
19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29.\" POSSIBILITY OF SUCH DAMAGE.
30.\"
31.Dd October 13, 2002
32.Dt CURSES_DEFAULT_COLORS 3
33.Os
34.Sh NAME
35.Nm curses_default_colors ,
36.Nm assume_default_colors ,
37.Nm use_default_colors
38.Nd curses default colors setting routines
39.Sh LIBRARY
40.Lb libcurses
41.Sh SYNOPSIS
42.Fd #include \*[Lt]curses.h\*[Gt]
43.Ft int
44.Fn assume_default_colors "short fore" "short back"
45.Ft int
46.Fn use_default_colors ""
47.Sh DESCRIPTION
48These functions tell the curses library to set the default colors or to use
49the terminal's default colors instead of using the default colors for curses
50applications (which are white foreground on black background).
51.Pp
52The function
53.Fn assume_default_colors fore back
54sets the default colors to foreground color
55.Fa fore
56and background color
57.Fa back .
58If a value of \-1 is used for a color, then the terminal default color is used
59for that color.
60.Pp
61The function
62.Fn use_default_colors
63sets both the foreground and background colors to the terminal default colors.
64This is equivalent to
65.Fn assume_default_colors \-1 \-1 .
66.Sh RETURN VALUES
67These functions return OK on success and ERR on failure.
68.Sh SEE ALSO
69.Xr curses_color 3
70.Sh STANDARDS
71These functions are based on
72.Em ncurses
73extensions to the curses standards.
74.Sh HISTORY
75These functions
76first appeared in
77.Nx 1.7
78