gbranden pushed a commit to branch master
in repository groff.
commit 71bf66d0d650d281e4e75299bc0b874c863aec96
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Mar 8 17:04:43 2026 -0500
doc/groff.texi.in: Tweak documentation.
* Note, in subsection/node "Breaking", the differing impact of discard
of trailing spaces on text lines between AT&T and GNU troffs: AT&T
cancels end-of-sentence detection, while GNU does not. This was
already noted later in the manual in subsection/node "Other
differences", but is easily overlooked there.
* Clarify example of `ce` request usage with no-break control character.
* Be more specific about function of `-C` command-line option: it merely
starts the formatter up in compatibility mode. We don't want to imply
that compatibility mode is "locked" (as is the case with `-S` and
"safer mode" as of groff 1.24.0).
* Favor active voice over passive.
* Speak of "the formatter", not GNU troff, when describing generally
applicable *roff behavior.
* Tag the word "troff" with Texinfo's "@command", not "@code", to
satisfy semantic markup scruples and to ensure it gets set in a
consistent face.
* Break Texinfo input lines in a roff-friendly way.
---
doc/groff.texi.in | 32 ++++++++++++++++++++------------
1 file changed, 20 insertions(+), 12 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 4833fdaac..68eb4d417 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -6132,8 +6132,11 @@ A line that begins with one or more spaces causes a
break. The spaces
are output at the beginning of the next line without being
@emph{adjusted} (see below); however, this behavior can be modified
(@pxref{Leading Space Traps}). Again, macro packages may provide other
-methods of producing indented paragraphs. Trailing spaces on text lines
-are discarded.@footnote{@xref{text lines}.}
+methods of producing indented paragraphs.
+Trailing spaces on text lines are discarded.@footnote{@xref{text lines}.
+AT&T
+@command{troff} @c AT&T
+also cancels end-of-sentence detection.}
What if the file ends before enough words have been collected
to fill an output line?
@@ -9476,7 +9479,7 @@ do nothing.
This line is normally filled and adjusted.
.br
A line's alignment is decided
-'ce \" Center the next input line (no break).
+'ce \" Center the next input line (with no initial break).
when it is output.
This line returns to normal filling and adjustment.
@result{} This line is normally filled and adjusted.
@@ -9524,10 +9527,8 @@ quantity and its units.
Insert an adjustable,
unbreakable space.
As with ordinary spaces,
-GNU
-@command{troff} @c GNU
-discards any sequence of these at the end of an output line
-if a break occurs.
+the formatter discards any sequence of these
+at the end of an output line if a break occurs.
@Example
Set the output speed to\~1.
@@ -9536,9 +9537,14 @@ J.\~F.\~Ossanna wrote the original CSTR\~#54.
@endExample
@endDefesc
-By default, GNU @code{troff} fills text and adjusts it to reach the
-output line length. The @code{nf} request disables filling; the
-@code{fi} request re�nables it.
+By default,
+the formatter fills text and adjusts it to reach the output line length.
+The
+@code{nf}
+request disables filling;
+the
+@code{fi}
+request re�nables it.
@DefreqList {fi, }
@DefregListEndx {.u}
@@ -21799,8 +21805,10 @@ the incompatibilities they cause do not arise.
The read-only register @code{.C} interpolates@tie{}1 if compatibility
mode is enabled, 0@tie{}otherwise.
-Compatibility mode is also enabled by the @option{-C} command-line
-option.
+GNU
+@command{troff}'s @c GNU
+@option{-C}
+command-line option causes it to start up in compatibility mode.
@endDefreq
@DefreqList {do, name [@Var{argument} @r{@dots{}}]}
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
