bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 21/52] Fix style nits when referring to shells.


From: G. Branden Robinson
Subject: [PATCH 21/52] Fix style nits when referring to shells.
Date: Fri, 22 Dec 2023 17:04:24 -0600

* man/tput.1: Drop unnecessary parenthetical cross reference to sh(1).
  Break input lines after commas.  Say "exit status" instead of "exit
  code" (following the man page section title).  Clarify which command's
  exit status should be tested.  Set man page name in cross reference in
  italics, not bold, because "sh" is not an ncurses page name.
* man/tset.1: Set names of "csh" and "sh" shells in italics, not bold,
  as above.  Break input lines after commas.  Perform Kemper notectomy.
  Break long input lines.
---
 man/tput.1 | 11 +++++++----
 man/tset.1 | 16 +++++++++-------
 2 files changed, 16 insertions(+), 11 deletions(-)

diff --git a/man/tput.1 b/man/tput.1
index a7a3b2d9b..b353c10f6 100644
--- a/man/tput.1
+++ b/man/tput.1
@@ -67,8 +67,9 @@ .SH SYNOPSIS
 .SH DESCRIPTION
 The \fB@TPUT@\fP utility uses the \fBterminfo\fP database to make the
 values of terminal-dependent capabilities and information available to
-the shell (see \fBsh\fP(1)), to initialize or reset the terminal, or
-return the long name of the requested terminal type.
+the shell,
+to initialize or reset the terminal,
+or return the long name of the requested terminal type.
 The result depends upon the capability's type:
 .RS 3
 .TP 5
@@ -88,8 +89,10 @@ .SH DESCRIPTION
 .RE
 .PP
 Before using a value returned on the standard output,
-the application should test the exit code
-(e.g., \fB$?\fP, see \fBsh\fP(1)) to be sure it is \fB0\fP.
+the application should test \fB@TPUT@\fP's exit status
+(for example,
+using \fB$?\fP in \fIsh\fP(1))
+to be sure it is \fB0\fP.
 (See the \fBEXIT STATUS\fP and \fBDIAGNOSTICS\fP sections.)
 For a complete list of capabilities
 and the \fIcapname\fP associated with each, see \fBterminfo\fP(5).
diff --git a/man/tset.1 b/man/tset.1
index c5f46c894..ae4128a1e 100644
--- a/man/tset.1
+++ b/man/tset.1
@@ -166,9 +166,11 @@ .SS "Setting the Environment"
 into the shell's environment are written to the standard output.
 If the \fISHELL\fP environmental variable ends in \*(``csh\*('',
 the commands
-are for \fBcsh\fP, otherwise, they are for \fBsh\fP(1).
-Note, the \fBcsh\fP commands set and unset the shell variable
-\fBnoglob\fP, leaving it unset.
+are for \fIcsh\fP(1),
+otherwise,
+they are for \fIsh\fP(1).
+The \fIcsh\fP commands set and unset the shell variable \fBnoglob\fP,
+leaving it unset.
 The following line in the \fB.login\fP
 or \fB.profile\fP files will initialize the environment correctly:
 .sp
@@ -234,8 +236,8 @@ .SS "Terminal Type Mapping"
 No whitespace characters are permitted in the \fB\-m\fP option argument.
 Also, to avoid problems with meta-characters, it is suggested that the
 entire \fB\-m\fP option argument be placed within single quote characters,
-and that \fBcsh\fP users insert a backslash character (\*(``\e\*('') before
-any exclamation marks (\*(``!\*('').
+and that \fIcsh\fP users insert a backslash character (\*(``\e\*('')
+before any exclamation marks (\*(``!\*('').
 .SH OPTIONS
 The options are as follows:
 .TP 5
@@ -295,8 +297,8 @@ .SH ENVIRONMENT
 The \fB@TSET@\fP command uses these environment variables:
 .TP 5
 .I SHELL
-tells \fB@TSET@\fP whether to initialize \fITERM\fP using \fBsh\fP(1) or
-\fBcsh\fP(1) syntax.
+tells \fB@TSET@\fP whether to initialize \fITERM\fP using \fIsh\fP(1) or
+\fIcsh\fP(1) syntax.
 .TP 5
 .I TERM
 Denotes your terminal type.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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