[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 03/33: doc/groff.texi: Clarify diversion behavior.
From: |
G. Branden Robinson |
Subject: |
[groff] 03/33: doc/groff.texi: Clarify diversion behavior. |
Date: |
Sun, 29 Jan 2023 19:35:23 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit c31921299328b2d20127f953a2230b4ababc6ebe
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Jan 20 19:46:47 2023 -0600
doc/groff.texi: Clarify diversion behavior.
* State how to recall/output a diversion.
* State that they don't interpret arguments.
---
doc/groff.texi | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index d9e62cf74..86da4deac 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -14858,16 +14858,17 @@ end-of-input macro using the @code{am} request.
In @code{roff} systems it is possible to format text as if for output,
but instead of writing it immediately, one can @dfn{divert} the
-formatted text into a named storage area. The same name space is used
-for such @slanted{diversions} as for strings and macros; see
+formatted text into a named storage area. It is retrieved later by
+specifying its name after a control character. The same name space is
+used for such @slanted{diversions} as for strings and macros; see
@ref{Identifiers}. Such text is sometimes said to be ``stored in a
macro'', but this coinage obscures the important distinction between
macros and strings on one hand and diversions on the other; the former
store @emph{unformatted} input text, and the latter capture
-@emph{formatted} output. Applications of diversions include ``keeps''
-(preventing a page break from occurring at an inconvenient place by
-forcing a set of output lines to be set as a group), footnotes, tables
-of contents, and indices.
+@emph{formatted} output. Diversions also do not interpret arguments.
+Applications of diversions include ``keeps'' (preventing a page break
+from occurring at an inconvenient place by forcing a set of output lines
+to be set as a group), footnotes, tables of contents, and indices.
@cindex top-level diversion
@cindex diversion, top-level
For orthogonality it is said that GNU @code{troff} is in the
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 03/33: doc/groff.texi: Clarify diversion behavior.,
G. Branden Robinson <=