gbranden pushed a commit to branch master
in repository groff.
commit 2e6f74125c8a2e97d5b91f532ef9c0b700116137
Author: G. Branden Robinson <[email protected]>
AuthorDate: Mon Dec 29 03:34:59 2025 -0600
[doc,man]: Document behavior of `'brp`.
Somehow this has gone unremarked all these years.
---
doc/groff.texi.in | 51 +++++++++++++++++++++++++++++++++++++++++++--------
man/groff.7.man | 6 ++++--
man/groff_diff.7.man | 12 ++++++------
3 files changed, 53 insertions(+), 16 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index c3b9dc307..108a30952 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -8995,13 +8995,35 @@ ISO 8601 date stamp:
@cindex @code{trf} request, causing implicit break
When an output line is pending (see below), a break moves the drawing
position to the beginning of the next text baseline, interrupting
-filling. Various ways of causing breaks were shown in @ref{Breaking}.
-The @code{br} request likewise causes a break. Several other requests
-imply breaks:@: @code{bp}, @code{ce}, @code{cf}, @code{fi}, @code{fl},
-@code{in}, @code{nf}, @code{rj}, @code{sp}, @code{ti}, and @code{trf}.
+filling.
+Recall @ref{Breaking}.
+The
+@code{br}
+request likewise causes a break.
+Several other requests imply breaks:@:
+@code{bp},
+@code{brp},
+@code{ce},
+@code{cf},
+@code{fi},
+@code{fl},
+@code{in},
+@code{nf},
+@code{rj},
+@code{sp},
+@code{ti},
+and @code{trf}.
If the no-break control character is used with any of these requests,
-GNU @code{troff} suppresses the break; instead the requested operation
-takes effect at the next break. @samp{'br} does nothing.
+GNU
+@command{troff} @c GNU
+suppresses the break;
+instead the requested operation takes effect at the next break.
+@cindex @code{br} request, nilpotence with no-break control character
+@cindex @code{brp} request, nilpotence with no-break control character
+@samp{'br}
+and
+@samp{'brp}
+do nothing.
@Example
.ll 55n
@@ -9192,10 +9214,23 @@ and enablement status
are associated with the environment.@footnote{@xref{Environments}.}
@endDefreq
+Normally,
+an explicit break implies non-adjustment of the pending output line,
+as at the end of a paragraph.
+
@DefreqList {brp, }
@DefescListEndx {\\p, , , }
-Break,
-adjusting the line per the current adjustment mode.
+The
+@code{brp}
+request commands a break as
+@code{br}
+does,
+but also forces adjustment of the output line
+per the current adjustment mode.
+Like
+@code{br},
+it does nothing if invoked with the no-break control character.
+
@code{\p}
schedules a break with adjustment at the next word boundary.
The escape sequence
diff --git a/man/groff.7.man b/man/groff.7.man
index c1dc70095..a26728666 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -490,6 +490,8 @@ The requested operation takes effect at the next break.
.
It makes
.request br
+and
+.request brp
nilpotent.
.
The no-break control character can be changed with the
@@ -3004,8 +3006,8 @@ Break output line.
.
.TPx
.REQ .brp
-Break output line;
-adjust if applicable.
+Break and force adjustment of the output line
+per the current adjustment mode.
.
.TPx
.REQ .break
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index fde8c0236..1444efcdd 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -2277,12 +2277,12 @@ See
.
.TP
.B .brp
-Break and adjust line;
-this is the AT&T
-.I troff \" AT&T
-escape sequence
-.B \[rs]p
-in request form.
+Break and force adjustment of the output line
+per the current adjustment mode.
+.
+Like
+.BR br ,
+it does nothing if invoked with the no-break control character.
.
.
.TP
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
