bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 104/177] man/curs_inopts.3x: Revise.


From: G. Branden Robinson
Subject: [PATCH 104/177] man/curs_inopts.3x: Revise.
Date: Mon, 13 Jan 2025 11:31:17 -0600

Content:
* Clarify that the `TERMINAL` data structure needs to be initialized,
  and it's a failure condition if it is not.

Style:
* Slightly recast description of `noqiflush()`'s effect.
* Fix missing word.
* Favor "a null pointer" over "NULL"; C23 now has `nullptr`.
* Say "unset" instead of "reset".  Not every programmer is familiar with
  the use of the latter term in its sense from digital logic design.

Markup:
* Annotate a curiosity about SVID 4.
---
 man/curs_inopts.3x | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index 8e29bd041..a5d74ff18 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -386,9 +386,9 @@ .SS "qiflush, noqiflush"
 below for a mitigation of this problem.
 You may want to call
 .B \%noqiflush
-in a signal handler
-if you want output to continue
-after the handler exits
+in a signal handler if,
+after the handler exits,
+you want output to continue
 as though the interrupt had not occurred.
 .\"
 .SS "raw, noraw"
@@ -518,10 +518,10 @@ .SH RETURN VALUE
 \fB\%newterm\fP(3X),
 or
 \fB\%setupterm\fP(3X),
+or
 .bP
 .I win
-is
-.I NULL
+is a null pointer
 (except with
 .B \%intrflush
 and
@@ -603,11 +603,13 @@ .SH EXTENSIONS
 if the option is set,
 .TP
 .B 0
-if the option is reset,
+if the option is unset,
 or
 .TP
 .B \-1
-if the library is not initialized.
+if the library's
+.I \%TERMINAL
+structure for the device has not been initialized.
 .SH PORTABILITY
 Applications employing
 .I \%ncurses
@@ -622,6 +624,10 @@ .SH PORTABILITY
 SVr4 describes a successful return value only as
 \*(``an integer value other than
 .IR ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 508
+.\" It continues "unless otherwise noted in the preceding routine
+.\" descriptions", but no notes otherwise are present; the man page
+.\" discusses getch()'s return value repeatedly, but never those of the
+.\" functions the page ostensibly documents.
 .PP
 .I \%ncurses
 follows X/Open Curses
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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