gbranden pushed a commit to branch master
in repository groff.
commit 07284323f75c4993325b0a35799c22ead863ae73
Author: G. Branden Robinson <g.branden.robin...@gmail.com>
AuthorDate: Fri Mar 7 06:43:40 2025 -0600
[doc,man]: Revise `so` request description.
Also sync wording between documents.
---
doc/groff.texi.in | 41 ++++++++++++++++++++++++++++++-----------
man/groff.7.man | 3 ++-
2 files changed, 32 insertions(+), 12 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 2099412b6..549615f86 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -16529,17 +16529,36 @@ request in @ref{Strings}.
@DefreqListEndx {soquiet, [@code{"}]@Var{file}}
@cindex including a file (@code{so})
@cindex file, inclusion (@code{so})
-Replace the @code{so} request's control line with the text of the
-file named by the argument, ``sourcing'' it. @var{file} is sought in
-the directories specified by @option{-I} command-line option. If
-@var{file} does not exist, a warning in category @samp{file} is produced
-and the request has no further effect. @xref{Warnings}, for
-information about the enablement and suppression of warnings.
-
-@code{so} can be useful for large documents; e.g., allowing each chapter
-of a book to be kept in a separate file. However, files interpolated
-with @code{so} are not preprocessed; to overcome this limitation, see
-the @cite{gsoelim@r{(1)}} man page.
+Replace the request's control line
+with the contents of
+@var{file},
+``sourcing'' it.
+GNU
+@command{troff} @c GNU
+searches for
+@var{file}
+in the directories specified by the @option{-I} command-line option.
+If
+@var{file}
+does not exist,
+GNU
+@command{troff} @c GNU
+emits a warning in category
+@samp{file}
+and the request has no further effect.
+@xref{Warnings}.
+
+@code{so} can be useful for large documents,
+allowing each chapter of a book,
+for example,
+to be maintained in a separate file.
+However,
+files interpolated with
+@code{so}
+are not preprocessed;
+to overcome this limitation,
+see
+@cite{gsoelim@r{(1)}}.
@strong{Caution:@:}
Since the formatter replaces the entire control line
diff --git a/man/groff.7.man b/man/groff.7.man
index 542d22dc4..3c5ccf34d 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -4487,7 +4487,8 @@ read in copy mode and continue to the end of the input
line.
.
.TPx
.REQ .so file
-Replace the request's control line with the text of
+Replace the request's control line
+with the contents of
.IR file ,
\[lq]sourcing\[rq] it.
.
_______________________________________________
groff-commit mailing list
groff-commit@gnu.org
https://lists.gnu.org/mailman/listinfo/groff-commit
