gbranden pushed a commit to branch master
in repository groff.
commit 9dacb4375380d5243dbbd1ffde5d5bc90d17a449
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Apr 12 07:19:30 2026 -0500
[doc,man]: Fix style nits in grout presentation.
* Define "whitespace" in the context of its interpretation.
* Document syntax of `u` command alongside `t` when presenting inline.
* Clarify wording. Bounding and containment are not identical.
* Favor active voice over passive.
* Break Texinfo input lines in a roff-friendly way.
---
doc/groff.texi.in | 42 ++++++++++++++++++++++++++++--------------
man/groff_out.5.man | 49 +++++++++++++++++++++++++++++++------------------
2 files changed, 59 insertions(+), 32 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index d5b8de34c..c9a015bb0 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -23856,7 +23856,11 @@ while
@dfn{page description}
denotes the language accepted
by the parser that interprets this output for the output drivers.
-This parser handles whitespace more flexibly than @acronym{AT&T}
+This parser handles whitespace
+(spaces,
+tabs,
+and newlines)
+more flexibly than @acronym{AT&T}
@command{troff}'s
implementation,
recognizes a GNU extension to the language,
@@ -23978,23 +23982,27 @@ but GNU
follows each with a newline.
Some commands have a more complex syntax;
-the GNU
+GNU
@command{troff} @c GNU
-extension command for writing glyph sequences
-(@code{t})
-accepts a variable number of arguments.
+extension commands for writing glyph sequences,
+@code{t}
+and
+@code{u},
+accept a variable number of arguments;
+whitespace must follow them.
Those that draw geometric objects
(@code{D})
or control the device
(@code{x})
-furthermore recognize subcommand arguments.
-Such commands thus must end with a newline.
+furthermore recognize a variable number of space-
+or tab-separated words as arguments;
+such commands thus must end with a newline.
In GNU
@command{troff}, @c GNU
the device extension (sub)command
@samp{@w{x X}}
uniquely supports a line continuation syntax;
-a single input line contains any other.
+a single input line bounds any other.
@node Argument Units
@subsubsection Argument Units
@@ -24011,12 +24019,18 @@ fonts and special characters. The names of
characters and fonts can be
of arbitrary length. A character that is to be printed is always in
the current font.
-A string argument is always terminated by the next whitespace character
-(space, tab, or newline); an embedded @samp{#} character is regarded as
-part of the argument, not as the beginning of a comment command. An
-integer argument is already terminated by the next non-digit character,
-which then is regarded as the first character of the next argument or
-command.
+A whitespace character
+(space, tab, or newline)
+always terminates a string argument.
+A
+@samp{#}
+character embedded in a string argument is part of that argument,
+not the beginning of a comment command.
+Any character other than a decimal numeral
+terminates a command that mtakes a numeric argument,
+and,
+if not whitespace,
+is interpreted as the start of a new command.
@anchor{Document Parts} @c 1.23.0
@node Output Structure
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index d08178cd8..5f306b09a 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -201,7 +201,11 @@ while
denotes the language accepted by the parser that interprets this output
for the output drivers.
.
-This parser handles whitespace more flexibly than AT&T
+This parser handles whitespace
+(spaces,
+tabs,
+and newlines)
+more flexibly than AT&T
.IR troff 's \" AT&T
implementation,
recognizes a GNU extension to the language,
@@ -300,25 +304,29 @@ follows each with a newline.
.
.P
Some commands have a more complex syntax;
-the GNU
+GNU
.I troff \" GNU
-extension command for writing glyph sequences
-.RB ( t )
-accepts a variable number of arguments.
+extension commands for writing glyph sequences,
+.B t
+and
+.BR u ,
+accept a variable number of arguments;
+whitespace must follow them.
+.
Those that draw geometric objects
.RB ( D )
or control the device
.RB ( x )
-furthermore recognize subcommand arguments.
-.
-Such commands thus must end with a newline.
+furthermore recognize a variable number of space-
+or tab-separated words as arguments;
+such commands thus must end with a newline.
.
In GNU
.I troff, \" GNU
the device extension (sub)command
.RB \[lq] x\~X \[rq]
uniquely supports a line continuation syntax;
-a single input line contains any other.
+a single input line bounds any other.
.
.
.\" ====================================================================
@@ -362,15 +370,20 @@ A glyph that is to be printed will always be in the
current font.
.
.
.P
-A string argument is always terminated by the next whitespace
-character (space, tab, or newline); an embedded
-.B #
-character is regarded as part of the argument, not as the beginning of
-a comment command.
-.
-An integer argument is already terminated by the next non-digit
-character, which then is regarded as the first character of the next
-argument or command.
+A whitespace character
+(space, tab, or newline)
+always terminates a string argument.
+.
+A
+.RB \[lq] # \[rq]
+character embedded in a string argument is part of that argument,
+not the beginning of a comment command.
+.
+Any character other than a decimal numeral
+terminates a command that mtakes a numeric argument,
+and,
+if not whitespace,
+is interpreted as the start of a new command.
.
.
.\" ====================================================================
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
