groff-commit
[Top][All Lists]
Advanced

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

[groff] 14/37: nroff(1): Fix content and style nits.


From: G. Branden Robinson
Subject: [groff] 14/37: nroff(1): Fix content and style nits.
Date: Fri, 27 Sep 2024 01:18:11 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 10f7322c94039fcbc9613688eea05e3566cc0efa
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Sep 23 13:33:03 2024 -0500

    nroff(1): Fix content and style nits.
    
    * Subordinate "TTY" as jargon with scare quotes _and_ parentheses.
    * Improve synopsis of `-v`/`--version` since its behavior is a bit more
      complex than most commands'.
    
    * Spell option-taking arguments spacefully, to assure the reader that
      such usage is valid.
    * Favor active voice over passive.
    * Tighten/recast.
---
 src/roff/nroff/nroff.1.man | 37 ++++++++++++++++++++-----------------
 1 file changed, 20 insertions(+), 17 deletions(-)

diff --git a/src/roff/nroff/nroff.1.man b/src/roff/nroff/nroff.1.man
index db935dd5b..47e238f15 100644
--- a/src/roff/nroff/nroff.1.man
+++ b/src/roff/nroff/nroff.1.man
@@ -2,14 +2,14 @@
 .SH Name
 @g@nroff \- format documents with
 .I groff
-for TTY (terminal) devices
+for terminal (\[lq]TTY\[rq]) devices
 .
 .
 .\" ====================================================================
 .\" Legal Terms
 .\" ====================================================================
 .\"
-.\" Copyright (C) 1989-2021 Free Software Foundation, Inc.
+.\" Copyright (C) 1989-2024 Free Software Foundation, Inc.
 .\"
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
@@ -98,10 +98,12 @@ for TTY (terminal) devices
 .P
 .SY @g@nroff
 .B \-v
+.RI [ other-nroff-option \~.\|.\|.]
 .YS
 .
 .SY @g@nroff
 .B \%\-\-version
+.RI [ other-nroff-option \~.\|.\|.]
 .YS
 .
 .
@@ -155,8 +157,9 @@ then checks several locale-related environment variables;
 see section \[lq]Environment\[rq] below.
 .
 If all of the foregoing fail,
-.B \-Tascii
-is implied.
+.I @g@nroff
+assumes
+.RB \[lq] "\-T ascii" \[rq].
 .
 .
 .P
@@ -186,26 +189,28 @@ options have the effects described in
 and
 .B \-h
 imply
-.RB \[lq] \-P\-c \[rq]
+.RB \[lq] "\-P \-c" \[rq]
 and
-.RB \[lq] \-P\-h \[rq],
+.RB \[lq] "\-P \-h" \[rq],
 respectively;
 .B \-c
-is also interpreted directly by
-.IR @g@troff .
+is also meaningful to
+.I @g@troff
+itself.
 .
-In addition,
-this implementation ignores the AT&T
+Further,
+GNU
+.I nroff \" GNU
+ignores the AT&T
 .I nroff \" AT&T
 options
 .BR \-e ,
 .BR \-q ,
 and
-.B \-s
-(which are not implemented in GNU
-.IR nroff ). \" GNU
+.BR \-s .
 .
-The options
+.MR groff @MAN1EXT@
+documents options
 .BR \-D ,
 .BR \-k ,
 .BR \-K ,
@@ -215,9 +220,7 @@ The options
 .BR \-t ,
 .BR \-S ,
 and
-.B \-Z
-are documented in
-.MR groff @MAN1EXT@ .
+.BR \-Z .
 .
 .B \-V
 causes



reply via email to

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