groff-commit
[Top][All Lists]
Advanced

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

[groff] 02/05: [docs]: Fix content and style nits.


From: G. Branden Robinson
Subject: [groff] 02/05: [docs]: Fix content and style nits.
Date: Fri, 21 Apr 2023 20:53:00 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 247da31b5109352448d849d812f788e1c0c70ec2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Apr 21 14:50:39 2023 -0500

    [docs]: Fix content and style nits.
    
    Discuss alignment, adjustment, and margins more carefully.  Adjustment
    doesn't spread output lines to "both margins" if the indentation is
    nonzero.  Describe the adjustment process explicitly.  Add emphasis
    distinguishing `.ce` from `.ad c`.  Drop terms "ragged-left" and
    "ragged-right" from running text (but keep their concept index entries).
---
 doc/groff.texi  | 26 ++++++++++++++------------
 man/groff.7.man | 11 ++++++-----
 2 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 597188319..77a3b5af4 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -7949,9 +7949,9 @@ J.\~F.\~Ossanna wrote the original CSTR\~#54.
 @endExample
 @endDefesc
 
-By default, GNU @code{troff} fills text and adjusts it to both margins.
-Filling can be disabled via the @code{nf} request and re-enabled with
-the @code{fi} request.
+By default, GNU @code{troff} fills text and adjusts it to reach the
+output line length.  Filling can be disabled via the @code{nf} request
+and re´┐Żnabled with the @code{fi} request.
 
 @DefreqList {fi, }
 @DefregListEndx {.u}
@@ -7991,22 +7991,25 @@ filling is.  @var{mode} can have one of the following 
values.
 @table @code
 @item b
 @itemx n
-Adjust ``normally'': to both margins.  This is the GNU @code{troff}
+Adjust ``normally'': if the output line does not occupy the distance
+between the indentation and the configured output line length, GNU
+@code{troff} stretches adjustable spaces within the line until that
+length is reached.  When the indentation is zero, this mode spreads the
+line to both the left and right margins.  This is the GNU @code{troff}
 default.
 
 @item c
 @cindex centered text (filled)
 Center filled text.  Contrast with the @code{ce} request, which centers
-text without filling it.
+text @emph{without} filling it.
 
 @item l
 @cindex ragged-right text
-Align text to the left margin, producing what is sometimes called
-ragged-right text.
+Align text to the left, without adjusting it.
 
 @item r
 @cindex ragged-left text
-Align text to the right margin, producing ragged-left text.
+Align text to the right, without adjusting it.
 @end table
 
 @var{mode} can also be a value previously stored in the @code{.j}
@@ -8061,10 +8064,9 @@ not write logic to interpret or perform arithmetic on it.
 
 @Defreq {na, }
 Disable output line adjustment.  This produces the same output as
-alignment to the left margin, but the value of the adjustment mode
-register @code{.j} is altered differently.  The adjustment mode and
-enablement status are associated with the environment
-(@pxref{Environments}).
+left-alignment, but the value of the adjustment mode register @code{.j}
+is altered differently.  The adjustment mode and enablement status are
+associated with the environment (@pxref{Environments}).
 @endDefreq
 
 @DefreqList {brp, }
diff --git a/man/groff.7.man b/man/groff.7.man
index d1c4ac47e..8c50052bc 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -531,7 +531,7 @@ When filling is enabled
 (the default),
 a line may be broken at a space.
 .
-When adjustment to both margins is enabled
+When adjustment is enabled
 (the default),
 inter-word spaces are expanded until the output line reaches the
 configured length.
@@ -2335,13 +2335,13 @@ to the standard error stream and exit with failure 
status.
 .
 .TPx
 .REQ .ad
-Enable output line adjustment using mode stored in
+Enable output line alignment and adjustment using the mode stored in
 .BR \[rs]n[.j] .
 .
 .
 .TPx
 .REQ .ad c
-Enable output line adjustment in mode
+Enable output line alignment and adjustment in mode
 .I c
 .RI ( c =\c
 .BR b , c , l , n , r ).
@@ -4004,7 +4004,7 @@ value.
 Emit a
 .B break
 warning if the additional space inserted for each space between words in
-an output line adjusted to both margins is larger than or equal to
+an adjusted output line is greater than or equal to
 .IR N .
 .
 A negative
@@ -4559,7 +4559,8 @@ Move right one word space.
 .
 .TP
 .ESC \[ti]
-Insert an unbreakable, adjustable space.
+Insert an unbreakable,
+adjustable space.
 .
 .
 .TP



reply via email to

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