1 .\" $NetBSD: curses_background.3,v 1.6 2008/04/30 13:10:51 martin Exp $
2 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
3 .\" All rights reserved.
5 .\" This code is derived from software contributed to The NetBSD Foundation
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 .\" POSSIBILITY OF SUCH DAMAGE.
29 .Dt CURSES_BACKGROUND 3
32 .Nm curses_background ,
38 .Nd curses attribute manipulation routines
48 .Fn getbkgd "WINDOW *"
54 These functions manipulate the background attributes on
56 or on the specified window.
60 sets the background attributes of the specified window
65 When the background attributes are set on a window, characters are added to
66 the window with the logical
68 of the background attributes and the character's attributes.
69 If both the background attribute and the character attribute contain color,
70 the color of the character attribute is rendered.
71 If the background attribute contains a non-space character, then this
72 character is added where the foreground character is a space character.
74 Note that subwindows created from
76 inherit the background attributes of
81 sets the background attributes of the specified window
85 and also sets the rendition of every character position on that window,
86 as if the characters had been newly added to
88 The rendition of characters on subwindows of
98 .Fn wbkgdset stdscr ch
100 .Fn wbkgd stdscr ch ,
105 returns the background attributes for the window
112 return OK on success and ERR on failure.
114 .Xr curses_attributes 3 ,
120 Curses library complies with the X/Open Curses specification, part of the
121 Single Unix Specification.
123 These functions first appeared in