ncurses 5.7 - patch 20100220
[ncurses.git] / man / curs_bkgd.3x
index 97b4094fce4c177dafb635c582ced6c650e056ee..c177a4114c57d7b66ecb113bd5284b9765d618f8 100644 (file)
@@ -1,24 +1,50 @@
-.\" $Id: curs_bkgd.3x,v 1.10 1996/07/20 23:48:30 tom Exp $
+.\"***************************************************************************
+.\" Copyright (c) 1998-2003,2010 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.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: curs_bkgd.3x,v 1.20 2010/01/30 21:29:04 Tim.van.der.Molen Exp $
 .TH curs_bkgd 3X ""
 .TH curs_bkgd 3X ""
-.
 .SH NAME
 .SH NAME
-\fBbkgdset\fR, \fBwbkgdset\fR, \fBbkgd\fR,
-\fBwbkgd\fR - \fBcurses\fR window background manipulation routines
-.
+\fBbkgdset\fR, \fBwbkgdset\fR,
+\fBbkgd\fR, \fBwbkgd\fR,
+\fBgetbkgd\fR - \fBcurses\fR window background manipulation routines
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
-\fBvoid bkgdset(const chtype ch);\fR
+.PP
+\fBvoid bkgdset(chtype ch);\fR
 .br
 .br
-\fBvoid wbkgdset(WINDOW *win, const chtype ch);\fR
+\fBvoid wbkgdset(WINDOW *win, chtype ch);\fR
 .br
 .br
-\fBint bkgd(const chtype ch);\fR
+\fBint bkgd(chtype ch);\fR
 .br
 .br
-\fBint wbkgd(WINDOW *win, const chtype ch);\fR
+\fBint wbkgd(WINDOW *win, chtype ch);\fR
 .br
 \fBchtype getbkgd(WINDOW *win);\fR
 .br
 .br
 \fBchtype getbkgd(WINDOW *win);\fR
 .br
-.
 .SH DESCRIPTION
 The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the
 background of the named window.
 .SH DESCRIPTION
 The \fBbkgdset\fR and \fBwbkgdset\fR routines manipulate the
 background of the named window.
@@ -30,42 +56,40 @@ the character and attribute parts of the background are combined with
 the blank characters.  The background becomes a property of the
 character and moves with the character through any scrolling and
 insert/delete line/character operations.
 the blank characters.  The background becomes a property of the
 character and moves with the character through any scrolling and
 insert/delete line/character operations.
-
-To the extent possible on a
-particular terminal, the attribute part of the background is displayed
+.PP
+To the extent possible on a particular terminal,
+the attribute part of the background is displayed
 as the graphic rendition of the character put on the screen.
 as the graphic rendition of the character put on the screen.
-
+.PP
 The \fBbkgd\fR and \fBwbkgd\fR functions
 set the background property of the current or specified window
 and then apply this setting to every character position in that window:
 The \fBbkgd\fR and \fBwbkgd\fR functions
 set the background property of the current or specified window
 and then apply this setting to every character position in that window:
-
+.PP
 .RS
 The rendition of every character on the screen is changed to
 the new background rendition.
 .RS
 The rendition of every character on the screen is changed to
 the new background rendition.
-
+.PP
 Wherever the former background character
 appears, it is changed to the new background character.
 .RE
 Wherever the former background character
 appears, it is changed to the new background character.
 .RE
-
+.PP
 The \fBgetbkgd\fR function returns the given window's current background
 character/attribute pair.
 The \fBgetbkgd\fR function returns the given window's current background
 character/attribute pair.
-.
 .SH RETURN VALUE
 The routines \fBbkgd\fR and \fBwbkgd\fR return the integer \fBOK\fR.
 The SVr4.0 manual says "or a non-negative integer if \fBimmedok\fR is set",
 but this appears to be an error.
 .SH RETURN VALUE
 The routines \fBbkgd\fR and \fBwbkgd\fR return the integer \fBOK\fR.
 The SVr4.0 manual says "or a non-negative integer if \fBimmedok\fR is set",
 but this appears to be an error.
-.
 .SH NOTES
 Note that \fBbkgdset\fR and \fBbkgd\fR may be macros.
 .SH NOTES
 Note that \fBbkgdset\fR and \fBbkgd\fR may be macros.
-.
 .SH PORTABILITY
 .SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4.  The draft
-does not include \fBconst\fR qualifiers on the arguments.  The standard
-specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR, on failure. but
-gives no failure conditions.
-.
+These functions are described in the XSI Curses standard, Issue 4.
+It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure,
+but gives no failure conditions.
 .SH SEE ALSO
 .SH SEE ALSO
-\fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_outopts\fR(3X)
+\fBcurses\fR(3X),
+\fBcurs_addch\fR(3X),
+\fBcurs_attr\fR(3X),
+\fBcurs_outopts\fR(3X)
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables:
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: