gbranden pushed a commit to branch master
in repository groff.
commit 7214ba10ad2c92d352a693739295e785edda8afb
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Mar 15 08:10:01 2026 -0500
[doc,man]: Recast `ul` request description.
Also break Texinfo input lines in a roff-friendly way.
---
doc/groff.texi.in | 50 ++++++++++++++++++++++++++++++--------------------
man/groff.7.man | 12 ++++++++++--
2 files changed, 40 insertions(+), 22 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 9d0fd987d..0a94f69d8 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -13948,26 +13948,36 @@ the slant is only assigned,
never incremented or decremented.
@endDefesc
-@Defreq {ul, [@Var{lines}]}
+@Defreq {ul, [@Var{n}]}
@cindex underlining (@code{ul})
-The @code{ul} request normally underlines subsequent lines if a TTY
-output device is used. Otherwise, the lines are printed in italics
-(only the term `underlined' is used in the following). The single
-argument is the quantity of input lines to be underlined; with no
-argument, the next line is underlined. If @var{lines} is zero or
-negative, stop the effects of @code{ul} (if it was active). Requests
-and empty lines do not count for computing the number of underlined
-input lines, even if they produce some output like @code{tl}. Lines
-inserted by macros (e.g., invoked by a trap) do count.
-
-At the beginning of @code{ul}, the current font is stored and the
-underline font is activated. Within the span of a @code{ul} request, it
-is possible to change fonts, but after the last line affected by
-@code{ul} the saved font is restored.
-
-This number of lines still to be underlined is associated with the
-environment (@pxref{Environments}). The underline font can be changed
-with the @code{uf} request.
+Underline
+(in
+@code{nroff}
+mode)
+or italicize
+(in
+@code{troff}
+mode)@footnote{Recall
+@ref{@code{troff} and @code{nroff} Modes}.}
+the next
+@var{n}
+productive input lines.
+A nonpositive argument cancels any pending underlining.
+Omitting the argument implies an
+@var{n}
+of
+@samp{1}.
+
+When
+@code{ul}
+commences underlining,
+the formatter stores the currently selected font
+(strictly,
+its mounting position),
+and restores that font when underlining ceases.
+Use the
+@code{uf}
+request to select an alternative underline font.
@c XXX @xref should be changed to grotty
@@ -13975,7 +13985,7 @@ with the @code{uf} request.
@c underlining is implemented for terminal output devices, and what
@c problems can arise.
-The @code{ul} request does not underline spaces.
+The @code{ul} request does not cause spaces to be underlined.
@endDefreq
@Defreq {cu, [@Var{lines}]}
diff --git a/man/groff.7.man b/man/groff.7.man
index 6122082fa..c25944f6a 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -5422,7 +5422,11 @@ to
.TPx
.REQ .ul
Underline
-(italicize in
+(in
+.I nroff
+mode)
+or italicize
+(in
.I troff
mode)
the output of the next productive input line.
@@ -5430,7 +5434,11 @@ the output of the next productive input line.
.TPx
.REQ .ul npl
Underline
-(italicize in
+(in
+.I nroff
+mode)
+or italicize
+(in
.I troff
mode)
the output of the next
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
