bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 024/177] man/curs_attr.3x: Revise "Video Attributes" subsection.


From: G. Branden Robinson
Subject: [PATCH 024/177] man/curs_attr.3x: Revise "Video Attributes" subsection.
Date: Mon, 13 Jan 2025 11:17:45 -0600

Content:
* Document `A_ATTRIBUTES` macro.

Style:
* Tighten wording.
* Recast some table entries to fit in 65n without requiring text blocks.
* Set file names (including header file names) in italics and protect
  them from hyphenation.

Markup:
* When using `ne` ("need") request to keep a table from breaking across
  a page, specify only the number of lines (vees) required.  For tables
  using horizontal rules (or boxed tables), this differs for nroff-
  and troff-mode formatting, because the rules occupy character cells on
  terminal devices, and take negligible space on typesetters.
* 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 | 43 +++++++++++++++++++++----------------------
 1 file changed, 21 insertions(+), 22 deletions(-)

diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index e5822f850..888536de3 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -256,11 +256,18 @@ .SS Standout
 might be combined with a color pair.
 .\" ---------------------------------------------------------------------------
 .SS "Video Attributes"
-The following video attributes, defined in \fB<curses.h>\fP, can be passed to
-the routines \fBattron\fP, \fBattroff\fP, and \fBattrset\fP,
-or logically \*(``or\*(''-ed with characters passed to \fBaddch\fP(3X).
+The following video attributes,
+defined in
+.IR \%curses.h ","
+can be passed to
+.BR \%attron ","
+.BR \%attroff ","
+.BR \%attrset ","
+and
+logically \*(``or\*(''-ed with characters passed to \fBaddch\fP(3X).
 .PP
-.ne 15
+.if t .ne 15
+.if n .ne 16
 .RS
 .TS
 Lb Lb
@@ -268,9 +275,7 @@ .SS "Video Attributes"
 Name   Description
 _
 A_NORMAL       Normal display (no highlight)
-A_STANDOUT     T{
-Best highlighting mode of the terminal
-T}
+A_STANDOUT     Best highlighting mode available
 A_UNDERLINE    Underlining
 A_REVERSE      Reverse video
 A_BLINK        Blinking
@@ -280,26 +285,20 @@ .SS "Video Attributes"
 A_INVIS        Invisible or blank mode
 A_ALTCHARSET   Alternate character set
 A_ITALIC       Italics (non-X/Open extension)
-A_CHARTEXT     Bit-mask to extract a character
-A_COLOR        T{
-Bit-mask to extract a color (legacy routines)
-T}
+A_ATTRIBUTES   Mask to extract character code
+A_CHARTEXT     Mask to extract atributes
+A_COLOR        Mask to extract color pair identifier
 .TE
 .RE
 .PP
-You can thus use
-.B \%A_CHARTEXT
-to extract the character from a
-.IR chtype ","
-.B \%A_ATTRIBUTES
-to obtain its rendering attributes,
+.BR \%attr_on ","
+.BR \%attr_off ","
 and
-.B \%A_COLOR
-to find the color pair it uses.
-.PP
-These video attributes are supported by \fBattr_on\fP and related functions
-(which also support the attributes recognized by \fBattron\fP, etc.):
+.B \%attr_set
+support the foregoing as well as the following additional attributes.
 .PP
+.if t .ne 7
+.if n .ne 8
 .RS
 .TS
 Lb Lb
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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