gbranden pushed a commit to branch master
in repository groff.
commit d37e50f32c3b4bb70eeb89671acc2daa9ffd9bd4
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri Jul 28 04:21:01 2023 -0500
[ms]: Fix documentation nits.
* Sync update to `UL` macro description to groff.texi and groff_ms(7).
* Annotate GROWPS, PSINCR, and HORPHANS features as GNU extensions.
* Tweak saber-toothed cat example.
* Apply poor man's keeps to groff_ms(7), preventing grody pagination.
---
doc/groff.texi | 14 ++++++++------
doc/ms.ms | 14 ++++++++++----
tmac/groff_ms.7.man | 15 +++++++++++++++
3 files changed, 33 insertions(+), 10 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index a5d66e112..ef134fe5d 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3485,8 +3485,9 @@ heading produced by these macros increases by
@code{PSINCR} units over
the size specified by @code{PS} multiplied by the difference of
@code{GROWPS} and @var{level}. The value stored in @code{PSINCR} is
interpreted in @code{groff} basic units; the @code{p} scaling unit
-should be employed when assigning a value specified in points. For
-example, the sequence
+should be employed when assigning a value specified in points.
+
+The input
@CartoucheExample
.nr PS 10
@@ -3503,9 +3504,9 @@ Machairodontinae
@endCartoucheExample
@noindent
-will cause ``1. Carnivora'' to be printed in 13-point text, followed by
+causes ``1. Carnivora'' to be printed in 13-point text, followed by
``1.1. Felinae'' in 11.5-point text, while ``1.1.1. Felis catus'' and
-all more deeply nested heading levels will remain in the 10-point text
+all more deeply nested heading levels remains in the 10-point text
specified by the @code{PS} register. ``Machairodontinae'' is printed at
11.5 points, since it corresponds to heading level@tie{}2.
@@ -3572,8 +3573,9 @@ use unbreakable space or horizontal motion escape
sequences (@code{\~},
@endDefmac
@Defmac {UL, [@Var{text} [@Var{post}]], ms}
-Typeset @var{text} with an underline. @var{post}, if present, is set
-after @var{text} with no intervening space.
+Typeset @var{text} with an underline. On terminal devices, @var{text}
+is bracketed with underscores `_'. @var{post}, if present, is set after
+@var{text} with no intervening space.
@endDefmac
@Defmac {LG, , ms}
diff --git a/doc/ms.ms b/doc/ms.ms
index de4b3d9b7..bad95b2a1 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -1473,9 +1473,13 @@ multiplied by the difference of
and
.I depth .
.
+.CW GROWPS
+and
+.CW PSINCR
+are GNU extensions.
.
-For example,
-the sequence
+.
+The input
.
.TS
box center;
@@ -1495,10 +1499,10 @@ Machairodontinae
.
.
.LP
-will cause \[lq]1. Carnivora\[rq] to be printed in 13-point text,
+causes \[lq]1. Carnivora\[rq] to be printed in 13-point text,
followed by \[lq]1.1. Felinae\[rq] in 11.5-point text,
while \[lq]1.1.1. Felis catus\[rq] and all more deeply nested headings
-will remain in the 10-point text specified by the
+remain in the 10-point text specified by the
.CW PS
register.
.
@@ -1532,6 +1536,8 @@ region
between the heading and the subsequent paragraph suppresses this
grouping.
.
+This is a GNU extension.
+.
.
.\" The next table is huge and we need a lot of room for it, but we
.\" can't use a keep because it's a boxed repeated-heading table. Flush
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 0c7480ed5..32bfe2960 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1013,6 +1013,11 @@ multiplied by the difference of
and
.IR depth .
.
+.B GROWPS
+and
+.B PSINCR
+are GNU extensions.
+.
.
.P
The
@@ -1038,6 +1043,8 @@ or
region between the heading and the subsequent paragraph suppresses this
grouping.
.
+This is a GNU extension.
+.
.
.\" ====================================================================
.SS "Typeface and decoration"
@@ -1155,6 +1162,10 @@ Typeset
.I text
with an underline.
.
+On terminal devices,
+.I text
+is bracketed with underscores (\[lq]_\[rq]).
+.
.I post,
if present,
is set after
@@ -1308,6 +1319,8 @@ request forces a page break if there is not at least the
amount of
vertical space specified in its argument remaining on the page.
.
.
+.br
+.ne 5v
.PP
A
.I boxed keep
@@ -1572,6 +1585,8 @@ If specified,
is set right-aligned.
.
.
+.br
+.ne 3v
.TP
.B .[
.TQ
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
