ncurses 6.4 - patch 20231014

[ncurses.git] / man / curs_bkgrnd.3x

diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x
index 974e358480f302dfdf7aedb16476898ef061850c..34ae0de13587fe4eb66dceb98763ac4e7735cf64 100644 (file)
--- a/man/curs_bkgrnd.3x
+++ b/man/curs_bkgrnd.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
 .\" Copyright 2002-2015,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,47 +27,47 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_bkgrnd.3x,v 1.15 2022/02/12 20:06:41 tom Exp $
+.\" $Id: curs_bkgrnd.3x,v 1.30 2023/10/07 21:19:07 tom Exp $
+.TH curs_bkgrnd 3X 2023-10-07 "ncurses 6.4" "Library calls"
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
-.TH curs_bkgrnd 3X ""
 .SH NAME
-\fBbkgrnd\fP,
-\fBwbkgrnd\fP,
-\fBbkgrndset\fP,
-\fBwbkgrndset\fP,
-\fBgetbkgrnd\fP,
-\fBwgetbkgrnd\fP \- \fBcurses\fP window complex background manipulation routines
+\fB\%bkgrnd\fP,
+\fB\%wbkgrnd\fP,
+\fB\%bkgrndset\fP,
+\fB\%wbkgrndset\fP,
+\fB\%getbkgrnd\fP,
+\fB\%wgetbkgrnd\fP \-
+manipulate background of a \fIcurses\fP window of wide characters
 .SH SYNOPSIS
+.nf
+\fB#include <curses.h>
+.PP
+\fBint bkgrnd(const cchar_t *\fIwch\fP);
+\fBint wbkgrnd(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP);
+.PP
+\fBvoid bkgrndset(const cchar_t *\fIwch\fP);
+\fBvoid wbkgrndset(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fP);
 .PP
-.B #include <curses.h>
-.sp
-\fBint bkgrnd(\fB const cchar_t *\fIwch\fB);\fR
-.br
-\fBint wbkgrnd(\fB WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
-.sp
-\fBvoid bkgrndset(const cchar_t *\fIwch\fR \fB);\fR
-.br
-\fBvoid wbkgrndset(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
-.sp
-\fBint getbkgrnd(cchar_t *\fIwch\fB);\fR
-.br
-\fBint wgetbkgrnd(WINDOW *\fIwin\fB, cchar_t *\fIwch\fB);\fR
-.br
+\fBint getbkgrnd(cchar_t *\fIwch\fP);
+\fBint wgetbkgrnd(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP);
+.fi
 .SH DESCRIPTION
 .SS bkgrndset
-.PP
 The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the
 background of the named window.
 The window background is a \fBcchar_t\fP consisting of
 any combination of attributes (i.e., rendition) and a complex character.
+.bP
 The attribute part of the background is combined (OR'ed) with all non-blank
 characters that are written into the window with \fBwaddch\fP.
+.bP
 Both
 the character and attribute parts of the background are combined with
 the blank characters.
+.PP
 The background becomes a property of the
 character and moves with the character through any scrolling and
 insert/delete line/character operations.
@@ -76,7 +76,6 @@ 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.
 .SS bkgrnd
-.PP
 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:
@@ -87,11 +86,12 @@ the new background rendition.
 Wherever the former background character
 appears, it is changed to the new background character.
 .SS getbkgrnd
-.PP
 The \fBgetbkgrnd\fP function returns the given window's current background
-character/attribute pair via the \fBwch\fP pointer.
+character/attribute pair via the
+.I wch
+pointer.
 If the given window pointer is null,
-the character is not updated (but no error returned).
+the character is not updated (but no error is returned).
 .SH NOTES
 Note that
 \fBbkgrnd\fP,
@@ -103,7 +103,6 @@ X/Open Curses does not provide details on how the rendition is changed.
 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\fP and \fBwbkgrndset\fP routines do not return a value.
 .PP
 Upon successful completion, the other functions return \fBOK\fP.
@@ -113,9 +112,8 @@ A null window pointer is treated as an error.
 .bP
 A null character pointer is treated as an error.
 .SH PORTABILITY
-.PP
 These functions are described in the XSI Curses standard, Issue 4
 (X/Open Curses).
 .SH SEE ALSO
-\fBcurses\fP(3X),
-\fBcurs_bkgd\fP(3X)
+\fB\%curses\fP(3X),
+\fB\%curs_bkgd\fP(3X)