bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 41/52] man/curs_legacy.3x: Recast "NOTES" section.


From: G. Branden Robinson
Subject: [PATCH 41/52] man/curs_legacy.3x: Recast "NOTES" section.
Date: Fri, 22 Dec 2023 17:09:02 -0600

Content:
* Clarify and offer more background on ncurses's optional "opaque"
  configuration.

Style:
* Set data type names in italics, not bold.

Markup:
* Break input lines after commas and around multi-word parentheticals.
---
 man/curs_legacy.3x | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/man/curs_legacy.3x b/man/curs_legacy.3x
index a89337c2f..d24af522e 100644
--- a/man/curs_legacy.3x
+++ b/man/curs_legacy.3x
@@ -97,13 +97,23 @@ .SH RETURN VALUE
 these functions return an integer,
 or \fBERR\fP if the window parameter is null.
 .SH NOTES
-All of these interfaces are provided as macros and functions.
-The macros are suppressed (and only the functions provided)
-when \fB\%NCURSES_OPAQUE\fP is defined.
-The standard forms such as \fB\%getyx\fP must be implemented as macros,
-and (in this implementation) are defined in terms of the functions
-described here,
-to avoid reliance on internal details of the \fB\%WINDOW\fP structure.
+All of these interfaces are implemented as macros and functions.
+The macros are suppressed
+(and only the functions provided)
+in an \*(``opaque\*(''
+.I \%ncurses
+build,
+which defines the preprocessor symbol
+.BR \%NCURSES_OPAQUE .
+See section \*(``ALTERNATE CONFIGURATIONS\*('' in \fB\%ncurses\fP(3X).
+.PP
+The standard forms such as \fB\%getyx\fP
+.I must
+be implemented as macros,
+and
+(in this implementation)
+are defined in terms of the functions described here,
+to avoid reliance on internal details of the \fI\%WINDOW\fP structure.
 .SH PORTABILITY
 These functions were supported on Version 7, BSD or System V implementations.
 None of those implementations checked the window parameter.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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