bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 47/52] man/curs_terminfo.3x: Revise "EXTENSIONS" and "PORTABILITY


From: G. Branden Robinson
Subject: [PATCH 47/52] man/curs_terminfo.3x: Revise "EXTENSIONS" and "PORTABILITY" sections.
Date: Fri, 22 Dec 2023 17:10:29 -0600

Style:
* Set "curses" in italics, not roman, when referring to specific
  implementations.
* Drop angle bracket notation from "inline" header file name, set it in
  italics instead of bold, and protect it from automatic hypehation.
* Use quotation for section cross references, not boldface.
* Use `RS`/`RE` and `EX`/`EE` for within-paragraph code display, not
  `IP` and `PP` to bracket boldface (still in Times, when typeset).
* Protect function name literals from automatic hyphenation.
* Lightly recast.

Markup:
* Favor man(7) font macros over *roff font escapes, except for
  (potential or actual) man page cross references.
* Break input lines after commas and around multi-word parentheticals.
---
 man/curs_terminfo.3x | 65 ++++++++++++++++++++++++++------------------
 1 file changed, 39 insertions(+), 26 deletions(-)

diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 80517c7ea..bc049c9a7 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -534,37 +534,50 @@ .SH NOTES
 .SH EXTENSIONS
 The functions marked as extensions were designed for
 \fB\%ncurses\fP(3X),
-and are not found in SVr4 curses, 4.4BSD curses,
-or any other previous version of curses.
+and are not found in SVr4
+.IR curses ,
+4.4BSD
+.IR curses ,
+or any other previous curses implementation.
 .\" ***************************************************************************
 .SH PORTABILITY
-The function \fBsetterm\fP is not described by X/Open and must
-be considered non-portable.
+\fBsetterm\fP is not described by X/Open and must be considered
+non-portable.
 All other functions are as described by X/Open.
 .SS "Compatibility Macros"
 This implementation provides a few macros for compatibility with systems
-before SVr4 (see \fIHISTORY\fP).
-Those include
-\fBcrmode\fP,
-\fBfixterm\fP,
-\fBgettmode\fP,
-\fBnocrmode\fP,
-\fBresetterm\fP,
-\fBsaveterm\fP, and
-\fBsetterm\fP.
-.PP
-In SVr4, those are found in \fB<curses.h>\fP,
-but except for \fBsetterm\fP, are likewise macros.
-The one function, \fBsetterm\fP, is mentioned in the manual page.
-The manual page notes that the \fBsetterm\fP routine
-was replaced by \fB\%setupterm\fP, stating that the call
-.IP
-\fBsetupterm(\fIterm\fB, 1, (int *)0)\fR
-.PP
-provides the same functionality as \fBsetterm(\fIterm\fB)\fR,
-and is not recommended for new programs.
-This implementation provides each of those symbols
-as macros for BSD compatibility.
+before SVr4
+(see section \*(``HISTORY\*('' below).
+They include
+\fB\%Bcrmode\fP,
+\fB\%Bfixterm\fP,
+\fB\%Bgettmode\fP,
+\fB\%Bnocrmode\fP,
+\fB\%Bresetterm\fP,
+\fB\%Bsaveterm\fP, and
+\fB\%Bsetterm\fP.
+.PP
+In SVr4,
+these are found in
+.IR \%curses.h ,
+but except for \fB\%setterm\fP,
+are likewise macros.
+The one function,
+\fB\%setterm\fP,
+is mentioned in the manual page.
+It further notes that \fB\%setterm\fP was replaced by \fB\%setupterm\fP,
+stating that the call
+.RS
+.EX
+setupterm(\fIterm\fB, 1, (int *)0)
+.EE
+.RE
+provides the same functionality as \fBsetterm(\fP\fIterm\fP\fB)\fP,
+discouraging the latter for new programs.
+.I \%ncurses
+implements each of these symbols as macros for BSD
+.I curses
+compatibility.
 .SS "Legacy Data"
 \fBsetupterm\fP copies the terminal name to the array \fBttytype\fP.
 This is not part of X/Open Curses, but is assumed by some applications.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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