gbranden pushed a commit to branch master
in repository groff.
commit 06c009c4862d1eb941848b03d5e5c678333dab1a
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Dec 19 13:12:35 2024 -0600
[doc,man]: Clarify untokenized escape sequences.
---
doc/groff.texi.in | 10 +++++++---
man/groff.7.man | 16 ++++++++++------
2 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 3fd9b3cfd..88a584426 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -7564,9 +7564,13 @@ interpolated. @xref{Auto-increment}.)
@cindex @code{\R} escape sequence, untokenized on input
@cindex untokenized escape sequence, @code{\R}
-@code{\R} is not tokenized when GNU @code{troff} reads its input; it
-updates only the formatter's internal state and does not contribute
-(directly) to output. @xref{Gtroff Internals}.
+@code{\R}
+is not tokenized when GNU
+@command{troff}
+reads its input;
+it updates only the formatter's register dictionary
+and does not contribute (directly) to output.
+@xref{Gtroff Internals}.
Further surprise can occur if you use registers like
@code{.k},@footnote{@xref{Page Motions}.} whose values are not
diff --git a/man/groff.7.man b/man/groff.7.man
index bde5a6e81..a0faabe2f 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -4939,14 +4939,18 @@ The escape sequences
and
.esc S
are not tokenized when
-.I groff
-reads its input;
+GNU
+.I troff \" GNU
+reads its input.
+.
.esc R
-updates only the formatter's internal state,
-and the rest only the environment.
+updates only the formatter's register dictionary,
+and does not contribute (directly) to output.
+.
+The others alter the environment
+(see section \[lq]Environments\[rq] below).
.
-They do not contribute (directly) to output;
-see the \[lq]Gtroff Internals\[rq] section of the
+See the \[lq]Gtroff Internals\[rq] section of the
.I groff
Texinfo manual.
.
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
