gbranden pushed a commit to branch master
in repository groff.
commit 844acced2abef464add8532f5eccd89dbd7e166f
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Aug 10 11:04:40 2025 -0500
[ms]: Clarify documentation re: escape sequences.
* Escape sequences can't occur _literally_ anywhere in GNU troff input;
outside of compatibility mode, they can't be used to interpolate
another escape sequence's function selector or delimiter character.
* Document recognition of "no-renumber" and "no-repeat-info" arguments
to `RP` macro as GNU extensions.
Also align input line breaks between Texinfo on the one hand and ms(7)
and man(7) on the other.
---
doc/groff.texi.in | 30 ++++++++++++++++++++++--------
doc/ms.ms.in | 8 +++++++-
tmac/groff_ms.7.man | 4 ++++
3 files changed, 33 insertions(+), 9 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 04ac96ccc..224cdfe1d 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -2778,15 +2778,26 @@ represents a length, size, or distance.
@endExample
@noindent
-In the foregoing, we see that @code{\"} begins a comment. This is an
-example of an @dfn{escape sequence}, the other kind of formatting
-instruction. Escape sequences can appear anywhere. They begin with the
-escape character (@code{\}) and are followed by at least one more
-character. @file{ms} documents
+In the foregoing,
+we see that
+@code{\"}
+begins a comment.
+This is an example of an
+@dfn{escape sequence},
+the other kind of formatting instruction.
+Escape sequences can appear almost anywhere.
+They begin with the escape character
+(@code{\})
+and are followed by at least one more character.
+@file{ms}
+documents
@c like this one
-tend to use only a few of @code{groff}'s many requests and escape
-sequences; see @ref{Request Index} and @ref{Escape Sequence Index} or
-the @cite{groff@r{(7)}} man page for complete lists.
+tend to use only a few of
+@code{groff}'s
+many requests and escape sequences;
+see @ref{Request Index} and @ref{Escape Sequence Index} or the
+@cite{groff@r{(7)}}
+man page for complete lists.
@table @code
@item \"
@@ -3311,6 +3322,9 @@ recognizes
as a synonym of
@code{no-repeat-info}
to maintain @acronym{AT&T} compatibility.
+Options other than
+@code{no}
+are GNU extensions.
@endDefmac
@Defmac {TL, , ms}
diff --git a/doc/ms.ms.in b/doc/ms.ms.in
index 529e42dc1..73a5e4661 100644
--- a/doc/ms.ms.in
+++ b/doc/ms.ms.in
@@ -332,7 +332,9 @@ This is an example of an
.I "escape sequence,"
the other kind of formatting instruction.
.
-Escape sequences can appear anywhere.
+Escape sequences can appear almost anywhere.
+.\" ...but not where GNU troff expects an escape function selector or
+.\" delimiter.
.
They begin with the escape character
.CW \[rs] ) (
@@ -794,6 +796,10 @@ recognizes
as a synonym of
.CW no\-\:\%repeat\-\:\%info
to maintain AT&T compatibility.
+.
+Options other than
+.CW no
+are GNU extensions.
T}
_
\&.TL T{
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index e41254aee..85f6637d3 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -513,6 +513,10 @@ as a synonym of
.B no\-\:\%repeat\-\:\%info
to maintain AT&T compatibility.
.
+Options other than
+.B no
+are GNU extensions.
+.
.
.TP
.B .TL
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
