bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 12/42] man/curs_bkgrnd.3x: Define terms and reorganize.


From: G. Branden Robinson
Subject: [PATCH 12/42] man/curs_bkgrnd.3x: Define terms and reorganize.
Date: Sat, 16 Dec 2023 11:42:58 -0600

* Define "background" and "blank character" before launching into
  function descriptions, lifting much of this more general information
  therefrom.
* Relocate material: arrange function descriptions in synopsis order.
---
 man/curs_bkgrnd.3x | 28 +++++++++++++++++++---------
 1 file changed, 19 insertions(+), 9 deletions(-)

diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x
index d870aa957..25421b78f 100644
--- a/man/curs_bkgrnd.3x
+++ b/man/curs_bkgrnd.3x
@@ -55,15 +55,22 @@ .SH SYNOPSIS
 \fBint wgetbkgrnd(WINDOW *\fIwin\fP, cchar_t *\fIwch\fP);
 .fi
 .SH DESCRIPTION
-.SS bkgrndset
-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
+The
+.I background
+of a
+.I curses
+window
+is a
+.I \%cchar_t
+combining a set of
+.I attributes
+with a complex character called the
+.I "blank character."
+The blank character is a spacing character that populates a window's
+character cells when their contents are erased without replacement.
+The background's attributes are combined with all non-blank characters
+written to the window with the \fB\%waddch\fP(3X) and \fB\%winsch\fP(3X)
+families of functions.
 Both
 the character and attribute parts of the background are combined with
 the blank characters.
@@ -85,6 +92,9 @@ .SS bkgrnd
 .bP
 Wherever the former background character
 appears, it is changed to the new background character.
+.SS bkgrndset
+The \fBbkgrndset\fP and \fBwbkgrndset\fP routines manipulate the
+background of the named window.
 .SS getbkgrnd
 The \fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP functions obtain the given
 or specified window's current background character and attribute pair
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]