gbranden pushed a commit to branch master
in repository groff.
commit f1260ca8fccac7d6a534b382072a11566378fe6d
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Dec 7 00:57:00 2025 -0600
[doc,man]: Recast introduction to traps.
Also sync input line breaks between our Texinfo manual and man pages.
The Texinfo form of the presentation is more hierarchal, so we give
vertical position traps attention earlier in groff(7).
---
doc/groff.texi.in | 22 +++++++++++++++-------
man/groff.7.man | 28 ++++++++++++++++------------
2 files changed, 31 insertions(+), 19 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 3f6e5c54e..4a3811c0f 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -16493,19 +16493,27 @@ Environments save us considerable effort.
@section Traps
@cindex traps
-@dfn{Traps} are locations in the output or conditions on the input that,
-when reached or fulfilled, call a specified macro. These traps can
-occur at a given location on the page, at a given location in the
-current diversion (together, these are known as @slanted{vertical
-position traps}), at a blank line, at a line with leading space
-characters, after a quantity of input lines, or at the end of input.
-Macros called by traps are passed no arguments.
+@dfn{Traps}
+are locations in the output,
+or conditions on the input that,
+when reached or fulfilled,
+call a specified macro.
+These traps can occur at a given location either on the page
+or in the current diversion
+(together,
+these are known as
+@slanted{vertical position traps}),
+at a blank line,
+at a line with leading space characters,
+after a quantity of input lines,
+or at the end of input.
@cindex planting a trap
@cindex trap, planting
Setting a trap is also called @dfn{planting} one.
@cindex trap, springing
@cindex springing a trap
It is said that a trap is @dfn{sprung} if its condition is fulfilled.
+The formatter passes no arguments to macros called by traps.
@c END Keep (roughly) parallel with subsection "Traps" of groff(7).
@menu
diff --git a/man/groff.7.man b/man/groff.7.man
index 78983ab13..5ababe4f3 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -8452,23 +8452,15 @@ Its applications include setting page headers and
footers,
body text in multiple columns,
and footnotes.
.
-These traps can occur at a given location on the page
-.RB ( wh ,\~ ch );
-at a given location in the current diversion
+These traps can occur at a given location either on the page
+.RB ( wh ,\~ ch )
+or in the current diversion
.RB ( dt )\[em]together,
these are known as
vertical position traps,
which can be disabled and re\[e ad]nabled
.RB ( vpt ).
.
-Setting a trap is also called
-.I planting
-one.
-.
-It is said that a trap is
-.I sprung
-if its condition is fulfilled.
-.
.
.P
A diversion is not formatted in the context of a page,
@@ -8490,7 +8482,19 @@ after a certain number of productive input lines
or at the end of input
.RB ( em ).
.
-Macros called by traps are passed no arguments.
+.
+.P
+Setting a trap is also called
+.I planting
+one.
+.
+It is said that a trap is
+.I sprung
+if its condition is fulfilled.
+.
+.
+.P
+The formatter passes no arguments to macros called by traps.
.\" END Keep (roughly) parallel with groff.texi node "Traps".
.
.
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
