]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_bkgrnd.3x
ncurses 6.3 - patch 20211225
[ncurses.git] / man / curs_bkgrnd.3x
index 84a2984bc0ec268b7bc853cf6941c147ffe1a227..d5933cb5bb8d158512f06fc6e54cf9ad5d6e39d3 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
 .\" Copyright 2002-2015,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_bkgrnd.3x,v 1.12 2020/10/17 23:13:15 tom Exp $
+.\" $Id: curs_bkgrnd.3x,v 1.14 2021/12/25 21:41:58 tom Exp $
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .TH curs_bkgrnd 3X ""
 .SH NAME
-\fBbkgrnd\fR,
-\fBwbkgrnd\fR,
-\fBbkgrndset\fR,
-\fBwbkgrndset\fR,
-\fBgetbkgrnd\fR,
-\fBwgetbkgrnd\fR \- \fBcurses\fR window complex background manipulation routines
+\fBbkgrnd\fP,
+\fBwbkgrnd\fP,
+\fBbkgrndset\fP,
+\fBwbkgrndset\fP,
+\fBgetbkgrnd\fP,
+\fBwgetbkgrnd\fP \- \fBcurses\fP window complex background manipulation routines
 .SH SYNOPSIS
 .PP
 .B #include <curses.h>
 .sp
-\fBint bkgrnd(\fR\fB const cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint bkgrnd(\fP\fB const cchar_t *\fP\fIwch\fP\fB);\fP
 .br
-\fBint wbkgrnd(\fR\fB WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint wbkgrnd(\fP\fB WINDOW *\fP\fIwin\fP\fB, const cchar_t *\fP\fIwch\fP\fB);\fP
 .sp
-\fBvoid bkgrndset(const cchar_t *\fR\fIwch\fR \fB);\fR
+\fBvoid bkgrndset(const cchar_t *\fP\fIwch\fP \fB);\fP
 .br
-\fBvoid wbkgrndset(WINDOW *\fR\fIwin\fR\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
+\fBvoid wbkgrndset(WINDOW *\fP\fIwin\fP\fB, const cchar_t *\fP\fIwch\fP\fB);\fP
 .sp
-\fBint getbkgrnd(cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint getbkgrnd(cchar_t *\fP\fIwch\fP\fB);\fP
 .br
-\fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint wgetbkgrnd(WINDOW *\fP\fIwin\fP\fB, cchar_t *\fP\fIwch\fP\fB);\fP
 .br
 .SH DESCRIPTION
 .SS bkgrndset
 .PP
-The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the
+The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the
 background of the named window.
-The window background is a \fBcchar_t\fR consisting of
+The window background is a \fBcchar_t\fP consisting of
 any combination of attributes (i.e., rendition) and a complex character.
 The attribute part of the background is combined (OR'ed) with all non-blank
-characters that are written into the window with \fBwaddch\fR.
+characters that are written into the window with \fBwaddch\fP.
 Both
 the character and attribute parts of the background are combined with
 the blank characters.
@@ -77,7 +77,7 @@ particular terminal, the attribute part of the background is displayed
 as the graphic rendition of the character put on the screen.
 .SS bkgrnd
 .PP
-The \fBbkgrnd\fR and \fBwbkgrnd\fR functions
+The \fBbkgrnd\fP and \fBwbkgrnd\fP functions
 set the background property of the current or specified window
 and then apply this setting to every character position in that window:
 .bP
@@ -88,15 +88,15 @@ Wherever the former background character
 appears, it is changed to the new background character.
 .SS getbkgrnd
 .PP
-The \fBgetbkgrnd\fR function returns the given window's current background
-character/attribute pair via the \fBwch\fR pointer.
+The \fBgetbkgrnd\fP function returns the given window's current background
+character/attribute pair via the \fBwch\fP pointer.
 If the given window pointer is null,
 the character is not updated (but no error returned).
 .SH NOTES
 Note that
-\fBbkgrnd\fR,
-\fBbkgrndset\fR, and
-\fBgetbkgrnd\fR
+\fBbkgrnd\fP,
+\fBbkgrndset\fP, and
+\fBgetbkgrnd\fP
 may be macros.
 .PP
 X/Open Curses does not provide details on how the rendition is changed.
@@ -104,10 +104,10 @@ This implementation follows the approach used in SVr4 curses,
 which is explained in the manual page for \fBwbkgd\fP.
 .SH RETURN VALUE
 .PP
-The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value.
+The \fBbkgrndset\fP and \fBwbkgrndset\fP routines do not return a value.
 .PP
-Upon successful completion, the other functions return \fBOK\fR.
-Otherwise, they return \fBERR\fR:
+Upon successful completion, the other functions return \fBOK\fP.
+Otherwise, they return \fBERR\fP:
 .bP
 A null window pointer is treated as an error.
 .bP
@@ -117,5 +117,5 @@ A null character pointer is treated as an error.
 These functions are described in the XSI Curses standard, Issue 4
 (X/Open Curses).
 .SH SEE ALSO
-\fBcurses\fR(3X),
-\fBcurs_bkgd\fR(3X)
+\fBcurses\fP(3X),
+\fBcurs_bkgd\fP(3X)