gbranden pushed a commit to branch master
in repository groff.
commit 0ac582934447e03ed9113fc31e6e01916f180bc9
Author: G. Branden Robinson <[email protected]>
AuthorDate: Thu Jan 1 23:38:31 2026 -0600
[doc,man]: Tweak discussion of traps.
* Distinguish generic *roff behavior ("the formatter") from GNU troff
peculiarities.
* Favor active voice over passive.
* Tweak wording.
* Break input lines similarly in *roff and Texinfo.
* Sync material between our Texinfo manual and man pages.
* Bump Texinfo manual's revision date.
---
doc/groff.texi.in | 32 +++++++++++++++++++++++---------
man/groff.7.man | 25 +++++++++++++++++--------
man/groff_diff.7.man | 4 +++-
3 files changed, 43 insertions(+), 18 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 60e6d3f14..f4615bac5 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -467,7 +467,7 @@ Documentation License''.
@title groff
@subtitle The GNU implementation of @code{troff}
@subtitle version @VERSION@
-@subtitle December 2025
+@subtitle January 2026
@author Trent@tie{}A.@: Fisher
@author Werner Lemberg
@author G.@tie{}Branden Robinson
@@ -16998,16 +16998,30 @@ CFIT (controlled flight into terrain) incident of
.\" @i{...and so on...}
@endExample
-A trap above the top or at or below the bottom of the page can be made
-visible by either moving it into the page area or increasing the page
-length so that the trap is on the page. Negative trap values always use
-the @emph{current} page length; they are not converted to an absolute
-vertical position.
+A trap above the top or at or below the bottom of the page
+can be made visible
+by either moving it into the page area
+or increasing the page length so that the trap is on the page.
+A negative trap value always uses the
+@emph{current}
+page length;
+the formatter does not convert it to an absolute vertical position.
@cindex page location traps, debugging
@cindex debugging page location traps
-We can use the @code{ptr} request to dump our page location traps to the
-standard error stream (@pxref{Debugging}). Their positions are reported
-in basic units; an @code{nroff} device example follows.
+We can use the
+@code{ptr}
+request to dump page location traps to the standard error stream
+(@pxref{Debugging}).
+GNU
+@command{troff} @c GNU
+reports their positions in basic units,
+and includes empty slots in the list,
+where a trap had been planted
+but subsequently (re)moved,
+because they can affect the visibility of subsequently planted traps.
+An
+@code{nroff}
+device example follows.
@Example
.pl 5i
diff --git a/man/groff.7.man b/man/groff.7.man
index 274a56f40..f25fbbf44 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -8631,19 +8631,28 @@ on a page of length \[lq]11i\[rq].)
.
.
.P
-A trap above the top or at or below the bottom of the page can be made
-visible by either moving it into the page area or increasing the page
-length so that the trap is on the page.
+A trap above the top or at or below the bottom of the page
+can be made visible
+by either moving it into the page area
+or increasing the page length so that the trap is on the page.
.
-Negative trap values always use the
+A negative trap value always uses the
.I current
page length;
-they are not converted to an absolute vertical position.
+the formatter does not convert it to an absolute vertical position.
.
-Use
+We can use the
.B ptr
-to dump page location traps to the standard error stream;
-their positions are reported in basic units.
+request to dump page location traps to the standard error stream;
+see section \[lq]Debugging\[rq] below.
+.
+GNU
+.I troff \" GNU
+reports their positions in basic units,
+and includes empty slots in the list,
+where a trap had been planted
+but subsequently (re)moved,
+because they can affect the visibility of subsequently planted traps.
.
.
.br
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 0cf0eb1e4..34822ac68 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -3999,7 +3999,9 @@ and its mode
.
.TP
.B .ptr
-Report the names and vertical positions of all page location traps
+Report the names and vertical positions,
+in basic units,
+of all page location traps
to the standard error stream.
.
GNU
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
