[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 03/19] man/curs_{bkgd,bkgrnd,color}: Migrate terminology.
From: |
G. Branden Robinson |
Subject: |
[PATCH 03/19] man/curs_{bkgd,bkgrnd,color}: Migrate terminology. |
Date: |
Sat, 21 Sep 2024 11:44:59 -0500 |
...from "background character" to "blank character". We don't need two
names for the same concept.
---
man/curs_bkgd.3x | 15 +++++++--------
man/curs_bkgrnd.3x | 14 +++++++-------
man/curs_color.3x | 10 +++++-----
3 files changed, 19 insertions(+), 20 deletions(-)
diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x
index 9ef707f3c..a8a5191b7 100644
--- a/man/curs_bkgd.3x
+++ b/man/curs_bkgd.3x
@@ -100,8 +100,8 @@ .SS "bkgd, wbkgd"
The rendition of every character in the window changes to the new
background rendition.
.bP
-Wherever the former background character appears,
-it changes to the new background character.
+Wherever the former blank character appears,
+it changes to the new blank character.
.PP
.I \%ncurses
updates the rendition of each character cell by comparing the character,
@@ -123,7 +123,7 @@ .SS "bkgd, wbkgd"
its color pair value is nonzero.
If not,
it simply replaces the attributes and color pair in the cell with those
-from the new background character.
+from the new blank character.
.bP
If the cell uses color,
and its background color matches that of the current window background,
@@ -147,13 +147,13 @@ .SS "bkgd, wbkgd"
If the terminal does not support color,
or if color has not been initialized with \fB\%start_color\fP(3X),
.I \%ncurses
-ignores the new background character's color attribute.
+ignores the new blank character's color attribute.
.SS "bkgdset, wbkgdset"
\fB\%bkgdset\fP and \fB\%wbkgdset\fP manipulate the background of
the applicable window,
without updating the character cells as \fB\%bkgd\fP and
\fB\%wbkgd\fP do;
-only future writes reflect the updated background.
+only future writes reflect the updated blank character.
.SS getbkgd
\fB\%getbkgd\fP obtains the given window's background character and
attribute combination.
@@ -165,8 +165,7 @@ .SH RETURN VALUE
.PP
\fB\%bkgdset\fP and \fBwbkgdset\fP do not return a value.
.PP
-\fB\%getbkgd\fP returns a window's background character and attribute
-combination.
+\fB\%getbkgd\fP returns a window's blank character.
.SH NOTES
Unusually,
there is no \fB\%wgetbkgd\fP function;
@@ -208,7 +207,7 @@ .SH PORTABILITY
.PP
Neither X/Open Curses nor the SVr4 manual pages detail how the rendition
of characters on the screen updates when \fB\%bkgd\fP or \fB\%wbkgd\fP
-changes the background character.
+changes the blank character.
.IR \%ncurses ,
like SVr4
.IR curses ,
diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x
index f7ea27208..4c64ec60e 100644
--- a/man/curs_bkgrnd.3x
+++ b/man/curs_bkgrnd.3x
@@ -103,8 +103,8 @@ .SS "bkgrnd, wbkgrnd"
The rendition of every character in the window changes to the new
background rendition.
.bP
-Wherever the former background character appears,
-it changes to the new background character.
+Wherever the former blank character appears,
+it changes to the new blank character.
.PP
.I \%ncurses
updates the rendition of each character cell by comparing the character,
@@ -126,7 +126,7 @@ .SS "bkgrnd, wbkgrnd"
its color pair value is nonzero.
If not,
it simply replaces the attributes and color pair in the cell with those
-from the new background character.
+from the new blank character.
.bP
If the cell uses color,
and its background color matches that of the current window background,
@@ -145,12 +145,12 @@ .SS "bkgrnd, wbkgrnd"
and then adding attributes from the new background.
.PP
.I \%ncurses
-treats a background character value of zero (0) as a blank character.
+treats a blank character value of zero (0) as a blank character.
.PP
If the terminal does not support color,
or if color has not been initialized with \fB\%start_color\fP(3X),
.I \%ncurses
-ignores the new background character's color attribute.
+ignores the new blank character's color attribute.
.SS "bkgrndset, wbkgrndset"
\fB\%bkgrndset\fP and \fB\%wbkgrndset\fP manipulate the background of
the applicable window,
@@ -159,7 +159,7 @@ .SS "bkgrndset, wbkgrndset"
only future writes reflect the updated background.
.SS "getbkgrnd, wgetbkgrnd"
The \fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP functions obtain the
-background character and attribute pair of \fB\%stdscr\fP or the
+blank character and attribute pair of \fB\%stdscr\fP or the
specified window and store it via the
.I wch
pointer.
@@ -194,7 +194,7 @@ .SH NOTES
.PP
Unlike their counterparts in the non-wide configuration of
.IR \%ncurses ,
-\fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP supply the background character
+\fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP supply the blank character
and attribute in a modifiable
.I \%cchar_t
parameter,
diff --git a/man/curs_color.3x b/man/curs_color.3x
index bf33f6f4a..ee5d14d28 100644
--- a/man/curs_color.3x
+++ b/man/curs_color.3x
@@ -142,7 +142,7 @@ .SS Rendering
window attributes,
as from \fB\%wattrset\fP(3X) or \fB\%wattr_set\fP(3X)
.bP
-window background character attributes,
+window blank character attributes,
as from \fB\%wbkgdset\fP(3X) or \fB\%wbkgrndset\fP(3X)
.PP
Per-character and window attributes are usually set through a function
@@ -151,7 +151,7 @@ .SS Rendering
such as \fB\%wattr_set\fP,
use a separate color pair number parameter.
.PP
-The background character is a special case:
+The blank character is a special case:
it includes a character code,
just as if it were passed to \fB\%waddch\fP.
.PP
@@ -167,7 +167,7 @@ .SS Rendering
If the window attribute does not use color pair 0,
\fIcurses\fP uses the color pair from the window attribute.
.bP
-Otherwise, \fIcurses\fP uses the background character.
+Otherwise, \fIcurses\fP uses the blank character.
.RE
.bP
If the parameter passed to \fB\%waddch\fP is \fInot blank\fP,
@@ -175,12 +175,12 @@ .SS Rendering
\fIcurses\fP prefers the color pair from the parameter,
if it is nonzero.
Otherwise, it tries the window attribute next, and finally the
-background character.
+blank character.
.PP
Some \fIcurses\fP functions such as \fB\%wprintw\fP call \fB\%waddch\fP.
Those do not combine its parameter with a color pair.
Consequently those calls use only the window attribute or
-the background character.
+the blank character.
.SH CONSTANTS
In \fB\%<curses.h>\fP the following macros are defined.
These are the standard colors (ISO-6429).
--
2.30.2
signature.asc
Description: PGP signature
- [PATCH 03/19] man/curs_{bkgd,bkgrnd,color}: Migrate terminology.,
G. Branden Robinson <=