gbranden pushed a commit to branch master
in repository groff.
commit d52596aa7b1dfee66e1825f09abf23f1068d7023
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Mar 15 07:41:04 2026 -0500
[doc,man]: Clarify .{ce,it,rj} register meanings.
They each store a count of _productive_ input lines, not input lines in
general.
Also break Texinfo input lines in a roff-friendly way.
---
doc/groff.texi.in | 71 +++++++++++++++++++++++++++++++++++++---------------
man/groff.7.man | 12 ++++-----
man/groff_diff.7.man | 12 ++++-----
3 files changed, 63 insertions(+), 32 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 2d0e87748..9d0fd987d 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -9810,15 +9810,26 @@ Went the day well?
@cindex centered text (unfilled)
@cindex centering lines (@code{ce})
@cindex lines, centering (@code{ce})
-Break (unless the no-break control character is used), center the output
-of the next @var{n} productive input lines with respect to the line
-length and indentation without filling, then break again regardless of
-the invoking control character.
+Break
+(unless the no-break control character is used),
+center the output of the next
+@var{n}
+productive input lines
+with respect to the line length and indentation,
+without filling,
+then break again regardless of the invoking control character.
@c Temporary indentation is ignored.
-If the argument is not positive, centering is disabled. Omitting the
-argument implies an @var{n} of @samp{1}. The count of input lines
-remaining to be centered is stored in the read-only register @code{.ce}
-and is associated with the environment (@pxref{Environments}).
+A nonpositive argument cancels any pending centering.
+Omitting the argument implies an
+@var{n}
+of
+@samp{1}.
+The read-only register
+@code{.ce}
+stores the count of productive input lines
+remaining to be centered,
+which is associated with the environment
+(@pxref{Environments}).
@cindex @code{ce} request, difference from @w{@samp{.ad c}}
While the @w{@samp{.ad c}} request also centers text, it fills the text
@@ -9868,14 +9879,24 @@ for requests that take a count of input lines as an
argument.
@DefregListEndx {.rj}
@cindex right-aligning text (@code{rj})
@cindex text, right-aligning (@code{rj})
-Break (unless the no-break control character is used), align the output
-of the next @var{n} productive input lines to the right margin without
-filling, then break again regardless of the control character.
+Break
+(unless the no-break control character is used),
+align the output of the next
+@var{n}
+productive input lines to the right margin,
+without filling,
+then break again regardless of the control character.
@c Temporary indentation is ignored.
-If the argument is not positive, right-alignment is disabled. Omitting
-the argument implies an @var{n} of @samp{1}. The count of input lines
-remaining to be right-aligned is stored in the read-only registeinput r
-@code{.rj} and is associated with the environment
+A nonpositive argument cancels any pending right-alignment.
+Omitting the argument implies an
+@var{n}
+of
+@samp{1}.
+The read-only register
+@code{.rj}
+stores the count of productive input lines
+remaining to be right-aligned,
+which is associated with the environment
(@pxref{Environments}).
@Example
@@ -18482,11 +18503,21 @@ the trap is sprung.
..
@endExample
-The @code{.it}, @code{.itc}, and @code{.itm} registers report the number
-of input lines remaining in a pending input trap, a Boolean indication
-of whether that pending input trap honors output line continuation, and
-the name of the macro associated with the pending input trap,
-respectively. All are read-only; @code{.itm} is string-valued as well.
+The
+@code{.it},
+@code{.itc},
+and
+@code{.itm}
+registers respectively report
+the number of remaining productive input lines
+to be formatted before a pending input trap springs,
+a Boolean indication of whether
+that pending input trap honors output line continuation,
+and
+the name of the macro associated with the pending input trap.
+All are read-only;
+@code{.itm}
+is string-valued as well.
@need 500
Let us consider in more detail the sorts of input lines that are or are
diff --git a/man/groff.7.man b/man/groff.7.man
index ed7aa3a0d..6122082fa 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -7181,8 +7181,8 @@ positive if glyph extends below the baseline.
.
.TP
.REG .ce
-Count of input lines remaining to be centered
-in the environment.
+Count of productive input lines
+remaining to be centered in the environment.
.
.TP
.REG .cht
@@ -7317,8 +7317,8 @@ was \[lq]interrupted\[rq] or continued with
.
.TP
.REG .it
-Count of input lines remaining
-in the environment's pending input trap.
+Count of productive input lines remaining
+before the environment's pending input trap springs.
.
.TP
.REG .itc
@@ -7483,8 +7483,8 @@ Maximum representable integer in GNU
.
.TP
.REG .rj
-Count of input lines remaining to be right-aligned
-in the environment.
+Count of productive input lines
+remaining to be right-aligned in the environment.
.
.TP
.REG .s
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 46aef7a3f..8b06cf661 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4933,8 +4933,8 @@ It is positive if the glyph extends below the baseline.
.
.TP
.B \[rs]n[.ce]
-Interpolate count of input lines remaining to be centered
-in the environment.
+Interpolate count of productive input lines
+remaining to be centered in the environment.
.
.
.TP
@@ -5077,8 +5077,8 @@ was \[lq]interrupted\[rq] or continued with
.
.TP
.B \[rs]n[.it]
-Interpolate count of input lines remaining
-in the environment's pending input trap.
+Interpolate count of productive input lines remaining
+before the environment's pending input trap springs.
.
.
.TP
@@ -5220,8 +5220,8 @@ Interpolate the environment's post-vertical line spacing
amount.
.
.TP
.B \[rs]n[.rj]
-Interpolate count of input lines remaining to be right-aligned
-in the environment.
+Interpolate count of productive input lines
+remaining to be right-aligned in the environment.
.
.
.TP
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
