bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 171/177] man/curs_util.3x: Revise "RETURN VALUE" section.


From: G. Branden Robinson
Subject: [PATCH 171/177] man/curs_util.3x: Revise "RETURN VALUE" section.
Date: Mon, 13 Jan 2025 11:44:15 -0600

Content:
* Drop mention of SVr4's loose specification of return values, to be
  resurrected in a subsequent commit.

Style:
* Favor "ncurses" over "this implementation".
* Drop inset applied to sequence of tagged paragraphs.  ncurses man
  pages seem _mostly_ not to otherwise do this.  Restructure to use
  bulleted paragraphs.

Markup:
* Protect literals from hyphenation.
* Favor man(7) font style macros over *roff font selection escape
  sequences, except for man page cross references (because
  man/make_sed.sh recognizes only certain patterns when rewriting such
  cross references) and terms in the "NAME" section (because the
  generated edit_man.sh script expects font selection escape sequences
  when scraping terms thence to gather names for man page aliases).
---
 man/curs_util.3x | 32 +++++++++++++++++---------------
 1 file changed, 17 insertions(+), 15 deletions(-)

diff --git a/man/curs_util.3x b/man/curs_util.3x
index 8a46c7ce2..bb87666a9 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -331,30 +331,32 @@ .SS flushinp
 that has been typed by the user
 and has not yet been read by the program.
 .SH RETURN VALUE
-Except for \fBflushinp\fP,
-routines that return an integer
-return \fBERR\fP upon failure and \fBOK\fP
-(SVr4 specifies only "an integer value other than \fBERR\fP")
-upon successful completion.
+Except for
+.BR \%flushinp ","
+functions that return integers return
+.B ERR
+upon failure and
+.B OK
+upon success.
 .PP
-Routines that return pointers return
+Functions that return pointers return
 .I NULL
 on error.
 .PP
-In this implementation
-.RS 3
-.TP 5
-\fBflushinp\fP
+In
+.IR \%ncurses ","
+.bP
+.B \%flushinp
 returns
 .B ERR
-if the terminal was not initialized.
-.TP 5
-\fBputwin\fP
+if the terminal was not initialized,
+and
+.bP
+.B \%putwin
 returns
 .B ERR
-if the associated \fIwrite\fP(2) calls return
+if its associated \fIwrite\fP(2) calls return
 .BR ERR "."
-.RE
 .SH NOTES
 .B \%wunctrl
 is part of
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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