[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 11/14] man/curs_bkgrnd.3x: Discuss `wgetbkgrnd()` in description.
From: |
G. Branden Robinson |
Subject: |
[PATCH 11/14] man/curs_bkgrnd.3x: Discuss `wgetbkgrnd()` in description. |
Date: |
Fri, 1 Dec 2023 17:33:36 -0600 |
Also clarity data types in "RETURN VALUE" section.
Also set data types in italics, not bold.
Also protect function/macro and data type literals from hyphenation.
---
man/curs_bkgrnd.3x | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x
index 2f7ee448..4525c943 100644
--- a/man/curs_bkgrnd.3x
+++ b/man/curs_bkgrnd.3x
@@ -86,21 +86,20 @@ .SS bkgrnd
Wherever the former background character
appears, it is changed to the new background character.
.SS getbkgrnd
-The \fBgetbkgrnd\fP function returns the given window's current background
-character/attribute pair via the
+The \fB\%getbkgrnd\fP and \fB\%wgetbkgrnd\fP functions obtain the given
+or specified window's current background character and attribute pair
+and store it in via the
.I wch
pointer.
-If the given window pointer is null,
-the character is not updated (but no error is returned).
.SH RETURN VALUE
The \fBbkgrndset\fP and \fBwbkgrndset\fP routines do not return a value.
.PP
Upon successful completion, the other functions return \fBOK\fP.
Otherwise, they return \fBERR\fP:
.bP
-A null window pointer is treated as an error.
+A null \fI\%WINDOW\fP pointer is treated as an error.
.bP
-A null character pointer is treated as an error.
+A null \fI\%cchar_t\fP pointer is treated as an error.
.SH NOTES
\fB\%bkgrnd\fP,
\fB\%bkgrndset\fP, and
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 11/14] man/curs_bkgrnd.3x: Discuss `wgetbkgrnd()` in description.,
G. Branden Robinson <=