[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: groff_out(5): Fix content, style, and markup nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 01/01: groff_out(5): Fix content, style, and markup nits. |
Date: |
Mon, 8 May 2023 21:36:53 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 51a03db0d768b55320023a5750db3b8759c7ca37
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon May 8 15:35:25 2023 -0500
groff_out(5): Fix content, style, and markup nits.
Content:
* Say "break" instead of "line break".
* Say "GNU troff" instead of "groff" where we are specifically
describing the formatter's behavior.
* Clarify that "w" command applies only to "normal" inter-word spaces.
Style:
* Simplify internal cross references to other commands.
* Clarify contextuality of positioning, writing, and drawing commands.
Markup:
* Drop unnecessary macro agument quotation.
* Fix missing input line break after macro call.
---
man/groff_out.5.man | 40 +++++++++++++++++++++++-----------------
1 file changed, 23 insertions(+), 17 deletions(-)
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index bc5662fb9..e2555a8f2 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -616,7 +616,7 @@ black in most cases).
.
.
.TP
-.command mg "gray"
+.command mg gray
Use a grayscale color scheme with a component ranging
between 0 (black) and \n[@maxcolor] (white).
.
@@ -645,7 +645,8 @@ Typeset the glyph with
.RI index\~ n
in the current font.
.
-.IR n\~ is normally a non-negative integer.
+.IR n\~ is
+normally a non-negative integer.
.
The drawing position is not advanced.
.
@@ -662,8 +663,8 @@ is taken and interpreted in basic units.
.
.
.TP
-.command n b\ a
-Describe a line break.
+.command n b\~a
+Describe a break.
.
In AT&T
.IR troff ,
@@ -674,13 +675,14 @@ describe the vertical space amounts before and after the
break,
respectively,
to make the output more readable by humans.
.
-.I groff
+GNU
+.I troff \" GNU
reports these values but its output driver library ignores them.
.
-Vertical space is applied with
-.B V
-.RB or\~ v
-commands.
+See
+.B v
+and
+.BR V .
.
.
.TP
@@ -696,10 +698,10 @@ The vertical drawing position is set to\~0.
.
All positioning,
writing,
-and drawing command are done in the context of a page,
+and drawing commands are interpreted in the context of a page,
so a
.BR p \~command
-must precede any of these.
+must precede them.
.
.
.TP
@@ -818,15 +820,19 @@ output driver library handles them.
.
.TP
.command w
-Describe an adjustable space.
+Describe an inter-word space.
.
This performs no action;
-it is present for documentary purposes.
+it is present to make the output more readable by humans.
.
-Horizontal space is applied with
-.B H
-.RB or\~ h
-commands.
+Only adjustable,
+breakable inter-word spaces are thus described;
+those resulting from horizontal motion escape sequences are not.
+.
+See
+.B h
+and
+.BR H .
.
.
.\" ====================================================================
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: groff_out(5): Fix content, style, and markup nits.,
G. Branden Robinson <=