[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 44/61] man/captoinfo.1m, man/infotocap.1m: Fix style nits.
From: |
G. Branden Robinson |
Subject: |
[PATCH 44/61] man/captoinfo.1m, man/infotocap.1m: Fix style nits. |
Date: |
Fri, 24 Nov 2023 12:07:56 -0600 |
* Add introductory sentence presenting purpose of utility.
* Favor active voice over passive.
* Protect "termcap", "terminfo", and "ncurses" from hyphenation.
* Drop pointless adverb "directly". (Would it make a different if the
capabilities were _indirectly_ translated?)
* Set environment variable names in italics, not bold.
* Break input lines after command and around multi-word parentheticals.
---
man/captoinfo.1m | 54 +++++++++++++++++++++++++-----------------------
man/infotocap.1m | 23 ++++++++++++---------
2 files changed, 41 insertions(+), 36 deletions(-)
diff --git a/man/captoinfo.1m b/man/captoinfo.1m
index 98623bbb..b22132cf 100644
--- a/man/captoinfo.1m
+++ b/man/captoinfo.1m
@@ -57,20 +57,20 @@ .SH SYNOPSIS
.P
.B "@CAPTOINFO@ \-V"
.SH DESCRIPTION
-\fB\%@CAPTOINFO@\fP looks in each given text
-\fIfile\fP for \fItermcap\fP descriptions.
-For each one found,
-it writes an equivalent \fIterminfo\fP description to the standard
-output stream.
-\fItermcap\fP \fBtc\fP capabilities are translated directly to
-\fIterminfo\fP \*(``\fBuse\fP\*('' capabilities.
+\fB\%@CAPTOINFO@\fP translates terminal descriptions.
+It looks in each given text \fIfile\fP for \fI\%termcap\fP entries and,
+for each one found,
+writes an equivalent \fI\%terminfo\fP description to the standard output
+stream.
+\fI\%termcap\fP \fBtc\fP capabilities translate to \fI\%terminfo\fP
+\*(``\fBuse\fP\*('' capabilities.
.PP
If no \fIfile\fPs are specified,
\fB\%@CAPTOINFO@\fP interprets the content of the environment variable
-\fB\%TERMCAP\fP as a file name,
+\fI\%TERMCAP\fP as a file name,
and extracts only the entry for the terminal named in the environment
-variable \fB\%TERM\fP from it.
-If the environment variable \fB\%TERMCAP\fP is not set,
+variable \fITERM\fP from it.
+If the environment variable \fI\%TERMCAP\fP is not set,
\fB\%@CAPTOINFO@\fP reads \fI\%\*d\fP.
.PP
This utility is implemented as a link to \fB\%@TIC@\fP(1M),
@@ -84,12 +84,13 @@ .SH DESCRIPTION
.BR \-w ,
and
.BR \-x .
-The \fB\-V\fP option reports the version of \fIncurses\fP associated
+The \fB\-V\fP option reports the version of \fI\%ncurses\fP associated
with this program and exits with a successful status.
.SS "Translations from nonstandard capabilities"
\fB\%@CAPTOINFO@\fP translates some obsolete,
-nonstandard capabilities into standard (SVr4/XSI Curses) \fIterminfo\fP
-capabilities.
+nonstandard capabilities into standard
+(SVr4/XSI Curses)
+\fI\%terminfo\fP capabilities.
It issues a diagnostic to the standard error stream for each,
inviting the user to check that it has not mistakenly translated an
unknown or mistyped capability name.
@@ -131,7 +132,7 @@ .SS "Translations from nonstandard capabilities"
HS mh IRIX enter_dim_mode
.TE
.PP
-XENIX \fItermcap\fP had a set of extension capabilities,
+XENIX \fI\%termcap\fP had a set of extension capabilities,
corresponding to box drawing characters of CCSID
(\*(``code page\*('') 437,
as follows.
@@ -171,13 +172,13 @@ .SS "Translations from nonstandard capabilities"
GG ACS magic cookie count
.TE
.PP
-If the single-line capabilities occur in an entry,
-they are composed into an \fBacsc\fP string.
-The double-line capabilities and
-\fBGG\fP are discarded with a warning message.
+\fB\%@CAPTOINFO@\fP composes single-line capabilities into an \fBacsc\fP
+string,
+and discards \fBGG\fP and double-line capabilities with a warning
+diagnostic.
.PP
-IBM's AIX has a \fIterminfo\fP facility descended from SVr1
-\fIterminfo\fP,
+IBM's AIX has a \fI\%terminfo\fP facility descended from SVr1
+\fI\%terminfo\fP,
but which is incompatible with the SVr4 format.
\fB\%@CAPTOINFO@\fP translates the following AIX extensions.
.PP
@@ -198,21 +199,22 @@ .SS "Translations from nonstandard capabilities"
this program translates the AIX \fBbox1\fP capability to an \fBacsc\fP
string.
.PP
-The HP-UX \fIterminfo\fP library supports two nonstandard \fIterminfo\fP
-capabilities,
+The HP-UX \fI\%terminfo\fP library supports two nonstandard
+\fI\%terminfo\fP capabilities,
\fBmeml\fP (memory lock) and \fBmemu\fP (memory unlock).
\fB\%@CAPTOINFO@\fP discards these with a warning message.
.SH FILES
.TP
\fI\*d\fP
-default \fItermcap\fP terminal capability database
+default \fI\%termcap\fP terminal capability database
.SH NOTES
The verbose option is not identical to SVr4's.
-Under SVr4, instead of following
-the \fB\-v\fP with a trace level \fIn\fP,
+Under SVr4,
+instead of following the \fB\-v\fP with a trace level \fIn\fP,
you repeat it \fIn\fP times.
.SH PORTABILITY
-X/Open Curses, Issue 7 (2009) describes \fBtic\fP briefly,
+X/Open Curses,
+Issue 7 (2009) describes \fBtic\fP briefly,
but omits this program.
SVr4 systems provide \fB\%captoinfo\fP as a separate application from
\fBtic\fP.
diff --git a/man/infotocap.1m b/man/infotocap.1m
index f2c006cb..6b5414cb 100644
--- a/man/infotocap.1m
+++ b/man/infotocap.1m
@@ -44,7 +44,8 @@
.ds d @TERMINFO@
.SH NAME
\fB\%@INFOTOCAP@\fP \-
-convert a \fIterminfo\fR description into a \fItermcap\fR description
+convert a \fI\%terminfo\fR description into a \fI\%termcap\fR
+description
.SH SYNOPSIS
.B @INFOTOCAP@
.RI [ tic-option ]
@@ -53,14 +54,15 @@ .SH SYNOPSIS
.P
.B "@INFOTOCAP@ \-V"
.SH DESCRIPTION
-\fB\%@INFOTOCAP@\fP looks in each given text
-\fIfile\fP for \fIterminfo\fP descriptions.
+\fB\%@INFOTOCAP@\fP translates terminal descriptions.
+It looks in each given text \fIfile\fP for \fI\%terminfo\fP entries and,
For each one found,
-it writes an analogous \fItermcap\fP description to the standard output
-stream.
-\fIterminfo\fP \*(``\fBuse\fP\*('' capabilities are translated directly
-to \fItermcap\fP \fBtc\fP capabilities.
-Because \fItermcap\fP is a less expressive format than \fIterminfo\fP,
+it writes an analogous \fI\%termcap\fP description to the standard
+output stream.
+\fI\%terminfo\fP \*(``\fBuse\fP\*('' capabilities translate to
+\fI\%termcap\fP \fBtc\fP capabilities.
+Because \fI\%termcap\fP is a less expressive format than
+\fI\%terminfo\fP,
some capabilities cannot be translated.
.PP
This utility is implemented as a link to \fB\%@TIC@\fP(1M),
@@ -74,14 +76,15 @@ .SH DESCRIPTION
.BR \-w ,
and
.BR \-x .
-The \fB\-V\fP option reports the version of \fIncurses\fP associated
+The \fB\-V\fP option reports the version of \fI\%ncurses\fP associated
with this program and exits with a successful status.
.SH FILES
.TP
.I \*d
compiled terminal description database
.SH PORTABILITY
-None of X/Open Curses, Issue 7 (2009),
+None of X/Open Curses,
+Issue 7 (2009),
SVr4,
or NetBSD document this application.
.SH AUTHOR
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 44/61] man/captoinfo.1m, man/infotocap.1m: Fix style nits.,
G. Branden Robinson <=