bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 21/43] man/curs_kernel.3x: Revise "NOTES" section.


From: G. Branden Robinson
Subject: [PATCH 21/43] man/curs_kernel.3x: Revise "NOTES" section.
Date: Mon, 9 Sep 2024 09:16:14 -0500

Style:
* Recast, including a Kemper notectomy.
* Protect function names from hyphenation.

Markup:
* 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_kernel.3x | 37 ++++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 11 deletions(-)

diff --git a/man/curs_kernel.3x b/man/curs_kernel.3x
index b0c012ebb..51853a607 100644
--- a/man/curs_kernel.3x
+++ b/man/curs_kernel.3x
@@ -266,20 +266,35 @@ .SH RETURN VALUE
 if the maximum number of ripped-off lines
 exceeds the maximum (5).
 .SH NOTES
-Note that \fBgetsyx\fP is a macro, so \fB&\fP is not necessary before
-the variables \fIy\fP and \fIx\fP.
+.B \%getsyx
+is a macro;
+use of the
+.B &
+operator before its arguments is unnecessary.
 .PP
-Older SVr4 man pages warn that the return value
-of \fBcurs_set\fP \*(``is currently incorrect\*(''.
-This implementation gets it right, but it may be unwise to count
-on the correctness of the return value anywhere else.
+Older SVr4 man pages warn that the return value of
+.B \%curs_set
+\*(``is currently incorrect\*(''.
+.I \%ncurses
+gets it right,
+but counting on its correctness anywhere else may be unwise.
 .PP
-Both \fI\%ncurses\fP and SVr4 will call \fBcurs_set\fP in \fBendwin\fP
-if \fBcurs_set\fP
-has been called to make the cursor other than normal, i.e., either
+The
+.B \%endwin
+function of both
+.I \%ncurses
+and SVr4
+.I curses
+calls
+.B \%curs_set
+if the latter has previously been called to set the cursor visiblility
+to a value other than normal;
+that is,
+either
 invisible or very visible.
-There is no way for \fI\%ncurses\fP to determine the initial cursor
-state to restore that.
+There is no way for
+.I \%ncurses
+to determine the initial cursor visibility to restore it.
 .SH EXTENSIONS
 In
 .IR \%ncurses ","
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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