gbranden pushed a commit to branch master
in repository groff.
commit 3ef08325bb21657e84d895124d5cde3ed2dfa33e
Author: G. Branden Robinson <[email protected]>
AuthorDate: Mon Apr 14 17:05:38 2025 -0500
[doc],groff(7): Recast escape sequence basics.
Generalize language; the basic behavior of an unrecognized escape
sequence is common to *roff formatters.
Favor active voice over passive.
Parallelize input line breaks between Texinfo and man page (where
possibly; Texinfo is annoying about footnotes).
---
doc/groff.texi.in | 11 +++++++----
man/groff.7.man | 20 +++++++++++---------
2 files changed, 18 insertions(+), 13 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 98fac4d90..eba9d746e 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -7176,10 +7176,13 @@ macro package you use; consult its documentation to
learn of ``safe''
sequences or alternative facilities it provides to achieve the desired
result.
-If an escape character is followed by a character that does not identify
-a defined operation, GNU @code{troff} ignores the escape character
-(producing a warning in category @samp{escape} if enabled), processing
-the next character as if it were not preceded by an escape character.
+If the character that follows the escape character
+does not identify a valid operation,
+the formatter ignores the escape character.@footnote{GNU
+@code{troff} @c GNU
+produces a warning in category
+@samp{escape}.
+@xref{Warnings}.}
@Example
$ groff -T ps -ww
diff --git a/man/groff.7.man b/man/groff.7.man
index 2b5273e86..728a70724 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -1711,16 +1711,18 @@ newline.
.
.
.P
-If an escape character is followed by a character
-that does not identify a defined operation,
-GNU
+If the character that follows the escape character
+does not identify a defined operation,
+the formatter ignores the escape character.
+.
+(GNU
.I troff \" GNU
-ignores the escape character
-(producing a warning in category
-.RB \[lq] escape \[rq]
-if enabled),
-processing the next character
-as if it were not preceded by an escape character.
+produces a warning in category
+.RB \%\[lq] escape \[rq].
+@xref{Warnings}.
+.
+See section \[lq]Warnings\[rq] in
+.MR @g@troff 1 .)
.
.
.P
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
