bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 10/23] man/curs_termcap.3x: Fix style and markup nits.


From: G. Branden Robinson
Subject: [PATCH 10/23] man/curs_termcap.3x: Fix style and markup nits.
Date: Thu, 26 Dec 2024 21:34:57 -0600

Style:
* Set possible `tgetent()` return values in bold, not roman, for
  consistency with terminfo's `setupterm()` man page.
* Favor active voice over passive.

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_termcap.3x | 48 +++++++++++++++++++++++++++++----------------
 1 file changed, 31 insertions(+), 17 deletions(-)

diff --git a/man/curs_termcap.3x b/man/curs_termcap.3x
index 67a394c3a..2463eea03 100644
--- a/man/curs_termcap.3x
+++ b/man/curs_termcap.3x
@@ -138,10 +138,10 @@ .SS Initialization
 It returns
 .RS 3
 .TP 5 \" "-1" + 2n + adjust for PDF
-1
+.B 1
 on success,
 .TP
-0
+.B 0
 if there is no such entry
 (or if the matching entry describes a generic terminal,
 having too little information for
@@ -149,8 +149,10 @@ .SS Initialization
 applications to run),
 and
 .TP
-\-1
-if the \fI\%term\%info\fP database could not be found.
+.B \-1
+if the
+.I \%term\%info
+database could not be found.
 .RE
 .PP
 This implementation differs from those of historical \fItermcap\fP
@@ -264,20 +266,32 @@ .SS "Applying String Capabilities"
 It can retrieve capabilities by either \fItermcap\fP or
 \fI\%term\%info\fP code.
 .SS "Global Variables"
-The variables
-\fBPC\fP,
-\fBUP\fP and
-\fBBC\fP
-are set by \fB\%tgetent\fP to the \fI\%term\%info\fP entry's data for
-\fB\%pad_char\fP,
-\fB\%cursor_up\fP and
-\fB\%backspace_if_not_bs\fP,
+.B \%tgetent
+sets the variables
+.BR PC ","
+.BR UP ","
+and
+.B BC
+to the
+.I \%term\%info
+entry's data for
+.BR \%pad_char ","
+.BR \%cursor_up ","
+and
+.BR \%backspace_if_not_bs ","
 respectively.
-\fBUP\fP is not used by \fI\%ncurses\fP.
-\fBPC\fP is used by \fB\%delay_output\fP(3X).
-\fBBC\fP is used by \fB\%tgoto\fP emulation.
-The variable \fB\%ospeed\fP is set by \fI\%ncurses\fP using a
-system-specific encoding to indicate the terminal's data rate.
+\fBUP\fP is not used by
+.IR \%ncurses "."
+.B PC
+is used by \fB\%delay_output\fP(3X).
+.B BC
+is used by
+.B \%tgoto
+emulation.
+.I \%ncurses
+assigns the variable
+.B \%ospeed
+a system-specific value to encode the terminal's data rate.
 .SS "Releasing Memory"
 The \fItermcap\fP functions provide no means of freeing memory,
 because legacy \fItermcap\fP implementations used only the buffer
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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