gbranden pushed a commit to branch master
in repository groff.
commit 27a90c3a1b8365f885b9f106677264c75a8f4908
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri Jul 18 09:56:58 2025 -0500
[ms]: Annotate pedagogical point in documentation.
Also sync input line breaks between Texinfo and *roff documents.
---
doc/groff.texi.in | 19 ++++++++++++++++---
doc/ms.ms | 10 ++++++++++
tmac/groff_ms.7.man | 10 ++++++++++
3 files changed, 36 insertions(+), 3 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 093ad655d..9509f1858 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -4848,9 +4848,22 @@ by@tie{}1,000.@footnote{Register values are converted to
and stored as
basic units. @xref{Measurements}.} This threshold makes use of a
scaling unit with these parameters practical for high-resolution
devices while preserving backward compatibility. It also permits
-expression of non-integral type sizes. For example, @samp{groff
--rPS=10.5p} at the shell prompt is equivalent to placing @samp{.nr PS
-10.5p} at the beginning of the document.
+expression of non-integral type sizes.
+For example,
+@samp{groff -rPS=10.5p}
+at the shell prompt is equivalent to placing
+@samp{.nr PS 10.5p}
+at the beginning of the document.
+@c Note to document maintainers:
+@c
+@c We use the integral point scaling unit `p` instead of the
+@c typographical point ("scaled point") `z` because this is a register
+@c assignment; the value gets coverted to scaled points automatically.
+@c Observe:
+@c $ printf '.nr PS 10.5p\n.pnr PS\n' | groff # 1.24 or later
+@c PS 10500 +0 0
+@c
+@c groff ms users can thus remain innocent of the z unit if they like.
@item
@acronym{AT&T} @file{ms}'s @code{AU} macro supported arguments whose
diff --git a/doc/ms.ms b/doc/ms.ms
index e92225168..be9e7905d 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -4136,6 +4136,16 @@ For example,
at the shell prompt is equivalent to placing
.CW ".nr PS 10.5p" \[rq] \[lq]
at the beginning of the document.
+.\" Note to document maintainers:
+.\"
+.\" We use the integral point scaling unit `p` instead of the
+.\" typographical point ("scaled point") `z` because this is a register
+.\" assignment; the value gets coverted to scaled points automatically.
+.\" Observe:
+.\" $ printf '.nr PS 10.5p\n.pnr PS\n' | groff # 1.24 or later
+.\" PS 10500 +0 0
+.\"
+.\" groff ms users can thus remain innocent of the z unit if they like.
.
.
.PP
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 26d0066a7..05f46352c 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -2488,6 +2488,16 @@ For example,
at the shell prompt is equivalent to placing
.RB \[lq] ".nr PS 10.5p" \[rq]
at the beginning of the document.
+.\" Note to document maintainers:
+.\"
+.\" We use the integral point scaling unit `p` instead of the
+.\" typographical point ("scaled point") `z` because this is a register
+.\" assignment; the value gets coverted to scaled points automatically.
+.\" Observe:
+.\" $ printf '.nr PS 10.5p\n.pnr PS\n' | groff # 1.24 or later
+.\" PS 10500 +0 0
+.\"
+.\" groff ms users can thus remain innocent of the z unit if they like.
.
.
.IP \[bu]
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
