gbranden pushed a commit to branch master
in repository groff.
commit 3040f875a068d6f432b109f77f733a363ce8cc9e
Author: G. Branden Robinson <g.branden.robin...@gmail.com>
AuthorDate: Fri Mar 7 10:43:14 2025 -0600
doc/groff.texi.in: Revise cautionary notes.
---
doc/groff.texi.in | 33 +++++++++++++++++++++++++++------
1 file changed, 27 insertions(+), 6 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 026cbb886..45208643a 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -15999,12 +15999,21 @@ permitting initial embedded spaces,
and reads it to the end of the input line in copy mode.
Recall @ref{Copy Mode}.
-@strong{Caution:@:} Use of these features can put syntactically invalid
-content into GNU @command{troff}'s output, which @code{groff}'s output
-drivers then fail to process. @code{output} and use of @code{\!} from
-the top-level diversion are normally needed only for instructions to a
-postprocessor that does something with the output before sending it to
-the output device, filtering out @var{contents} again.
+@strong{Caution:@:}
+Use of these features can put syntactically invalid content
+into the formatter's output,
+which
+@code{groff}'s
+output drivers then fail to process.
+One application of
+@code{output}
+and of
+@code{\!}
+from the top-level diversion is to pass instructions
+to a postprocessor that interprets
+@var{anything}
+and filters it out
+before sending it to the output device.
@c TODO: Once the dust settles from Savannah #63074, document how these
@c can be used to construct device extension commands without special
@c character processing.
@@ -16680,6 +16689,18 @@ For @code{cf}, within a diversion, ``completely
unprocessed'' means that
each line of a file to be inserted is handled as if it were preceded by
@code{\!\\!}.
+@strong{Caution:@:}
+Use of these requests can put syntactically invalid content
+into the formatter's output,
+which
+@code{groff}'s
+output drivers then fail to process.
+One application is to pass instructions
+to a postprocessor that interprets
+@var{file}'s
+contents and filters it out
+before sending it to the output device.
+
To define a macro@tie{}@code{x} containing the contents of
file@tie{}@file{f}, use
_______________________________________________
groff-commit mailing list
groff-commit@gnu.org
https://lists.gnu.org/mailman/listinfo/groff-commit
