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