groff-commit
[Top][All Lists]
Advanced

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

[groff] 14/14: groff_mm(7): Expand description of `SA` request.


From: G. Branden Robinson
Subject: [groff] 14/14: groff_mm(7): Expand description of `SA` request.
Date: Fri, 6 Jan 2023 16:20:14 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 6626b5e9889bf3db23813d82402f76c276f7ab20
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Jan 6 13:53:17 2023 -0600

    groff_mm(7): Expand description of `SA` request.
    
    * More clearly document the fact that an argument sets a default for
      adjustment enablement, and omitting the argument restores this
      user-configured default.
    * Stop using term "justification", in alignment with other groff docs.
    * Document valid range of argument.
    * Document use of `na` request in mm(7) documents since this seems to be
      historical practice.
    * Document reset of adjustment by `H` and `HU` macros.
    
    Also tweak markup to use font style macros and unadjustable space escape
    sequence instead of font selection and unbreakable space escape
    sequences.
---
 contrib/mm/groff_mm.7.man | 36 +++++++++++++++++++++++++++++++-----
 1 file changed, 31 insertions(+), 5 deletions(-)

diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index 6fbfe07c3..8b58e3f98 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -3075,14 +3075,40 @@ and \[lq]D\[rq] the default value.
 If \[lq]+\[rq] or \[lq]\-\[rq] is used before the value,
 the current value is incremented or decremented, respectively.
 .
+.
 .TP
-.BI SA\  \fR[\fParg\fR]\fP
-Set right-margin justification.
+.BR SA \~\c
+.RI [ mode ]
+Set or restore the default enablement of adjustment.
+.
+Adjustment is on by default.
+.
+To set the adjustment default for the document,
+specify
+.B 0
+or
+.B 1
+as
+.I mode,
+to disable or enable it,
+respectively.
+.
+Adjustment can be temporarily suspended with the
+.B na
+request.
 .
-Justification is turned on by default.
+When the
+.B H
+or
+.B HU
+macros are used to format a heading,
+or when
+.B SA
+is called without a
+.I mode
+argument,
+the default adjustment is restored.
 .
-No argument or value \[lq]0\[rq] turns off justification,
-and \[lq]1\[rq] turns on justification.
 .
 .TP
 .BI SETR\  "refname \fR[\fPstring\fR]\fP"



reply via email to

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