[PATCH 18/40] man/tput.1: Revise (7/10) (OPTIONS).

[G. Branden Robinson]

Content:
* Add forward reference to "EXAMPLES" section when presenting `-S`
  option.
* Clarify that the `-x` option affects only the "clear" cap-code.

Style:
* Recast.
* Adjust paragraph tag width.

Markup:
* Favor man(7) font style macros over *roff font selection escape
  sequences, except for man page cross references.
* Protect "@TPUT@" and operand literals from hyphenation.
---
 man/tput.1 | 66 +++++++++++++++++++++++++++++++++---------------------
 1 file changed, 41 insertions(+), 25 deletions(-)

diff --git a/man/tput.1 b/man/tput.1
index 2063edf22..235f3d570 100644
--- a/man/tput.1
+++ b/man/tput.1
@@ -327,37 +327,53 @@ .SS "Terminal Size"
 ultimately,
 the terminal database).
 .SH OPTIONS
-.TP
-\fB\-S\fP
-allows more than one capability per invocation of \fB@TPUT@\fP.
-The capabilities must be passed to \fB@TPUT@\fP from the standard input
-instead of from the command line
-(see example).
-Only one \fIcap-code\fP is allowed per line.
-The \fB\-S\fP option changes the
-meaning of the \fB0\fP and \fB1\fP Boolean and string exit statuses
+.TP 9n \" "-T type" + 2n
+.B \-S
+retrieves more than one capability per invocation of \fB\%@TPUT@\fP.
+The capabilities must be passed to \fB\%@TPUT@\fP from the standard
+input stream instead of from the command line
+(see section \*(``EXAMPLES\*('' below).
+Only one
+.I cap-code
+is allowed per line.
+The
+.B \-S
+option changes the meanings of the
+.B 0
+and
+.B 1
+exit statuses
 (see section \*(``EXIT STATUS\*('' below).
 .IP
-Because some capabilities may use
-\fIstring\fP parameters rather than \fInumbers\fP,
-\fB@TPUT@\fP uses a table and the presence of parameters in its input
-to decide whether to use \fBtparm\fP(3X),
-and how to interpret the parameters.
+Some capabilities use string parameters rather than numeric ones.
+\fB\%@TPUT@\fP employs a built-in table and the presence of parameters
+in its input to decide how to interpret them,
+and whether to use \fB\%tparm\fP(3X).
 .TP
-\fB\-T\fItype\fR
-indicates the \fItype\fP of terminal.
-Normally this option is
-unnecessary, because the default is taken from the environment
-variable \fITERM\fP.
-If \fB\-T\fP is specified, then the shell
-variables \fILINES\fP and \fI\%COLUMNS\fP will also be ignored.
+.BI \-T\  type
+indicates the terminal's
+.I type.
+Normally this option is unnecessary,
+because a default is taken from the
+.I TERM
+environment variable.
+If specified,
+the environment variables
+.I LINES
+and
+.I \%COLUMNS
+are also ignored.
 .TP
-\fB\-V\fP
-reports the version of \fI\%ncurses\fP which was used in this program,
-and exits.
+.B \-V
+reports the version of
+.I \%ncurses
+associated with \fB\%@TPUT@\fP,
+and exits with a successful status.
 .TP
 .B \-x
-prevents \fB\%@TPUT@\fP from attempting to clear the scrollback buffer.
+prevents
+.RB \%\*(`` "@TPUT@ clear" \*(''
+from attempting to clear the scrollback buffer.
 .SH ENVIRONMENT
 \fB@TPUT@\fP command reads one environment variable.
 .TP 8n \" "TERM" + 2n + adjustment for PDF
-- 
2.30.2

signature.asc
Description: PGP signature