bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 32/51] man/curs_attr.3x: Fix "n*[cC]urses" style and markup nits.


From: G. Branden Robinson
Subject: [PATCH 32/51] man/curs_attr.3x: Fix "n*[cC]urses" style and markup nits.
Date: Fri, 26 Jul 2024 12:52:02 -0500

* Set "curses" in italics, not roman.
* Capitalize "Curses" in "X/Open Curses", and leave it in roman.
* 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_attr.3x | 116 +++++++++++++++++++++++++++++++++--------------
 1 file changed, 83 insertions(+), 33 deletions(-)

diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index e813e0899..090228cfe 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -181,7 +181,9 @@ .SS "Legacy Window Attributes"
 However, if the value does not fit, then the \fBCOLOR_PAIR\fP macro
 uses only the bits that fit.
 For example,
-because in \fI\%ncurses\fP \fBA_COLOR\fP has eight (8) bits,
+because in
+.I \%ncurses
+\fBA_COLOR\fP has eight (8) bits,
 then \fBCOLOR_PAIR(\fI259\fB)\fR is 4
 (i.e., 259 is 4 more than the limit 255).
 .PP
@@ -199,8 +201,11 @@ .SS "Legacy Window Attributes"
 .EE
 .RE
 .PP
-The \fBattrset\fP routine is a legacy feature predating SVr4 curses
-but kept in X/Open Curses for the same reason that SVr4 curses kept it:
+The \fBattrset\fP routine is a legacy feature predating SVr4
+.I curses
+but kept in X/Open Curses for the same reason that SVr4
+.I curses
+kept it:
 compatibility.
 .PP
 The remaining \fBattr\fP* functions operate exactly like the corresponding
@@ -211,7 +216,9 @@ .SS "Legacy Window Attributes"
 .PP
 There is no corresponding \fB\%attrget\fP function as such
 in X/Open Curses,
-although \fI\%ncurses\fP provides \fB\%getattrs\fP
+although
+.I \%ncurses
+provides \fB\%getattrs\fP
 (see \fB\%curs_legacy\fP(3X)).
 .\" ---------------------------------------------------------------------------
 .SS "Change Character Rendition"
@@ -363,9 +370,13 @@ .SH NOTES
 number is less than 256.
 The alternate functions such as \fBcolor_set\fP can pass a color pair
 value directly.
-However, \fI\%ncurses\fP ABI 4 and 5 simply OR this value
+However,
+.I \%ncurses
+ABI 4 and 5 simply OR this value
 within the alternate functions.
-You must use \fI\%ncurses\fP ABI 6 to support more than 256 color pairs.
+You must use
+.I \%ncurses
+ABI 6 to support more than 256 color pairs.
 .\" ---------------------------------------------------------------------------
 .SH EXTENSIONS
 This implementation provides the \fBA_ITALIC\fP attribute for terminals
@@ -415,7 +426,8 @@ .SH PORTABILITY
 .PP
 The standard defined the dedicated type for highlights,
 .IR \%attr_t ","
-which was not defined in SVr4 curses.
+which was not defined in SVr4
+.IR curses "."
 The functions taking
 .I \%attr_t
 arguments were not supported under SVr4.
@@ -429,7 +441,9 @@ .SH PORTABILITY
 \fBA_BLINK\fP, \fBA_BOLD\fP, \fBA_DIM\fP, \fBA_REVERSE\fP, \fBA_STANDOUT\fP, or
 \fBA_UNDERLINE\fP is \*(``unspecified\*(''.
 Under this implementation as well as
-SVr4 curses, these functions correctly manipulate all other highlights
+SVr4
+.IR curses ","
+these functions correctly manipulate all other highlights
 (specifically, \fBA_ALTCHARSET\fP, \fBA_PROTECT\fP, and \fBA_INVIS\fP).
 .PP
 X/Open Curses added these entry points:
@@ -474,7 +488,9 @@ .SH PORTABILITY
 .bP
 However, in some implementations, those symbols have unrelated values.
 .IP
-For example, the Solaris \fIxpg4\fP (X/Open) curses declares
+For example, the Solaris \fIxpg4\fP (X/Open)
+.I curses
+declares
 .I \%attr_t
 to be an unsigned short integer (16-bits),
 while
@@ -491,7 +507,8 @@ .SH PORTABILITY
 .I \%cchar_t
 variables.
 .bP
-Because \fI\%ncurses\fP's
+Because
+.IR \%ncurses 's
 .I \%attr_t
 can hold a color pair
 (in the \fBA_COLOR\fP field),
@@ -503,7 +520,8 @@ .SH PORTABILITY
 If the color pair information in the attribute parameter is zero,
 no change is made to the window's color.
 .IP
-This is consistent with SVr4 curses;
+This is consistent with SVr4
+.IR curses ";"
 X/Open Curses does not specify this.
 .PP
 The X/Open Curses extended conformance level adds new highlights
@@ -514,24 +532,39 @@ .SH PORTABILITY
 (i.e., via the \fBsgr1\fP capability).
 .\" ---------------------------------------------------------------------------
 .SH HISTORY
-X/Open Curses is largely based on SVr4 curses,
+X/Open Curses is largely based on SVr4
+.IR curses ","
 adding support for \*(``wide-characters\*('' (not specific to Unicode).
-Some of the X/Open differences from SVr4 curses address the way
+Some of the X/Open differences from SVr4
+.I curses
+address the way
 video attributes can be applied to wide-characters.
 But aside from that, \fBattrset\fP and \fBattr_set\fP are similar.
-SVr4 curses provided the basic features for manipulating video attributes.
-However, earlier versions of curses provided a part of these features.
-.PP
-As seen in 2.8BSD, curses assumed 7-bit characters,
+SVr4
+.I curses
+provided the basic features for manipulating video attributes.
+However, earlier versions of
+.I curses
+provided a part of these features.
+.PP
+As seen in 2.8BSD,
+.I curses
+assumed 7-bit characters,
 using the eighth bit of a byte to represent the \fIstandout\fP
 feature (often implemented as bold and/or reverse video).
-The BSD curses library provided functions \fBstandout\fP and \fBstandend\fP
+The BSD
+.I curses
+library provided functions \fBstandout\fP and \fBstandend\fP
 which were carried along into X/Open Curses due to their pervasive use
 in legacy applications.
 .PP
 Some terminals in the 1980s could support a variety of video attributes,
-although the BSD curses library could do nothing with those.
-System V (1983) provided an improved curses library.
+although the BSD
+.I curses
+library could do nothing with those.
+System V (1983) provided an improved
+.I curses
+library.
 It defined the \fBA_\fP symbols for use by applications to manipulate the
 other attributes.
 There are few useful references for the chronology.
@@ -541,7 +574,9 @@ .SH HISTORY
 commenting on several functions:
 .bP
 the \fBattron\fP, \fBattroff\fP, \fBattrset\fP functions
-(and most of the functions found in SVr4 but not in BSD curses) were
+(and most of the functions found in SVr4 but not in BSD
+.IR curses ")"
+were
 introduced by System V,
 .bP
 the alternate character set feature with \fBA_ALTCHARSET\fP was
@@ -566,7 +601,9 @@ .SH HISTORY
 .PP
 This table showing the number of bits for \fBA_COLOR\fP
 and \fBA_CHARTEXT\fP
-was gleaned from the curses header files for
+was gleaned from the
+.I curses
+header files for
 various operating systems and architectures.
 The inferred architecture and notes reflect
 the format and size of the defined constants
@@ -602,32 +639,41 @@ .SH HISTORY
 HP-UX 10.20 (1996) added support for 64-bit PA-RISC processors in 1996.
 .bP
 HP-UX 10.30 (1997) marked \*(``curses_colr\*('' obsolete.
-That version of curses was dropped with HP-UX 11.30 in 2006.
+That version of
+.I curses
+was dropped with HP-UX 11.30 in 2006.
 .PP
 Regarding OSF/1 (and Tru64),
 .bP
 These used 64-bit hardware.
-Like \fI\%ncurses\fP,
-the OSF/1 curses interface is not customized for 32-bit and 64-bit
+Like
+.IR \%ncurses ","
+the OSF/1
+.I curses
+interface is not customized for 32-bit and 64-bit
 versions.
 .bP
 Unlike other systems which evolved from AT&T code,
-OSF/1 provided a new implementation for X/Open curses.
+OSF/1 provided a new implementation for X/Open Curses.
 .PP
 Regarding Solaris,
 .bP
 The initial release of Solaris was in 1992.
 .bP
-The \fIxpg4\fP (X/Open) curses was developed by MKS from 1990 to 1995.
+The \fIxpg4\fP (X/Open) Curses was developed by MKS from 1990 to 1995.
 Sun's copyright began in 1996.
 .bP
-Sun updated the X/Open curses interface
+Sun updated the X/Open Curses interface
 after 64-bit support was introduced in 1997,
-but did not modify the SVr4 curses interface.
+but did not modify the SVr4
+.I curses
+interface.
 .PP
 Regarding U/Win,
 .bP
-Development of the curses library began in 1991, stopped in 2000.
+Development of the
+.I curses
+library began in 1991, stopped in 2000.
 .bP
 Color support was added in 1998.
 .bP
@@ -637,7 +683,7 @@ .SH HISTORY
 .IR \%cchar_t ")."
 .RE
 .PP
-Once X/Open curses was adopted in the mid-1990s, the constraint of
+Once X/Open Curses was adopted in the mid-1990s, the constraint of
 a 32-bit interface with many colors and wide-characters for
 .I \%chtype
 became a moot point.
@@ -648,11 +694,15 @@ .SH HISTORY
 .PP
 Other interfaces are rarely used now:
 .bP
-BSD curses was improved slightly in 1993/1994 using Keith Bostic's
+BSD
+.I curses
+was improved slightly in 1993/1994 using Keith Bostic's
 modification to make the library 8-bit clean for \fBnvi\fP(1).
 He moved \fIstandout\fP attribute to a structure member.
 .IP
-The resulting 4.4BSD curses was replaced by \fI\%ncurses\fP over the
+The resulting 4.4BSD
+.I curses
+was replaced by \fI\%ncurses\fP over the
 next ten years.
 .bP
 U/Win is rarely used now.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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