gbranden pushed a commit to branch master
in repository groff.
commit 2af67af27462f956dacff57c3ae0ef366dc0a9f8
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri Jan 10 10:49:58 2025 -0600
[doc,man]: Distinguish contents/anything.
...and distinguish both from a "character sequence".
Bump copyright notices and date of our Texinfo manual.
---
doc/groff.texi.in | 10 ++++----
man/groff.7.man | 73 ++++++++++++++++++++++++++++++++++---------------------
2 files changed, 50 insertions(+), 33 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 95adfc67f..c886e6101 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -26,7 +26,7 @@
@copying
This manual documents GNU @command{troff} version @VERSION@.
-Copyright @copyright{} 1994--2024 Free Software Foundation, Inc.
+Copyright @copyright{} 1994--2025 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -464,7 +464,7 @@ Documentation License''.
@title groff
@subtitle The GNU implementation of @code{troff}
@subtitle version @VERSION@
-@subtitle December 2024
+@subtitle January 2025
@author Trent@tie{}A.@: Fisher
@author Werner Lemberg
@author G.@tie{}Branden Robinson
@@ -12842,13 +12842,13 @@ Strings can be queried (@code{length}) and modified
(@code{chop},
can be manipulated through renaming, removal, and aliasing (@code{rn},
@code{rm}, @code{als}).
-@Defreq {length, reg anything}
+@Defreq {length, reg contents}
@cindex length of a string (@code{length})
@cindex string, length of (@code{length})
@cindex @code{length} request, and copy mode
@cindex copy mode, and @code{length} request
@cindex mode, copy, and @code{length} request
-Compute the number of characters of @var{anything} and store the count
+Compute the number of characters in @var{contents} and store the count
in the register @var{reg}. If @var{reg} doesn't exist, it is created.
A leading neutral double quote in the argument is stripped from it,
@@ -16377,7 +16377,7 @@ inclusion of their output in the document.
@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 contents of the
+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
diff --git a/man/groff.7.man b/man/groff.7.man
index 7724486d0..5c50e4f7e 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -10,7 +10,7 @@ language reference
.\" Legal Terms
.\" ====================================================================
.\"
-.\" Copyright (C) 2000-2024 Free Software Foundation, Inc.
+.\" Copyright (C) 2000-2025 Free Software Foundation, Inc.
.\"
.\" This file is part of groff, the GNU roff type-setting system.
.\"
@@ -2281,6 +2281,16 @@ to be passed to the system as a command
A leading leading neutral double quote is stripped,
allowing embedded leading spaces.
.
+.TPx
+.I contents
+is a sequence of ordinary characters,
+spaces,
+tabs,
+or escape sequences
+.\" ...or, technically, backspace and delete characters, but let's not
+.\" dwell on that.
+(including special characters)
+populating a string or character definition.
.
.TPx
.I div
@@ -2369,7 +2379,7 @@ or escape sequences like
.esc D .
.
Macro calls are not themselves productive,
-but their interpolated contents can be.
+but their interpolations can be.
.
.TPx
.I reg
@@ -2426,6 +2436,7 @@ an increment or decrement is applied as if to\~0.
GNU
.I troff \" GNU
reads arguments named
+.I character-sequence,
.I command,
.I contents,
.I file,
@@ -2533,7 +2544,7 @@ or diversion
If
.I new-name
already exists,
-its contents are lost unless already aliased.
+its definition is lost unless already aliased.
.
.TPx
.REQ .am mac
@@ -2616,9 +2627,9 @@ no operation if
already exists.
.
.TPx
-.REQ .as "str anything"
+.REQ .as "str contents"
Append
-.I anything
+.I contents
to string
.IR str .
.
@@ -2630,7 +2641,7 @@ As
.IR ident \[rq].
.
.TPx
-.REQ .as1 "str anything"
+.REQ .as1 "str contents"
As
.request .as ,
with compatibility mode disabled when the appendment to string
@@ -3089,12 +3100,13 @@ As
with compatibility mode disabled when the macro is interpreted.
.
.TPx
-.REQ .device contents
+.REQ .device character-sequence
Write
-.I contents
+.IR character-sequence ,
+a sequence of ordinary or special characters and spaces,
to
.I @g@troff
-output as a device extension command.
+output as the argument to a device extension command.
.
.TPx
.REQ .devicem name
@@ -3102,7 +3114,7 @@ Write contents of macro or string
.I name
to
.I @g@troff
-output as a device extension command.
+output as the argument to a device extension command.
.
.TPx
.REQ .di
@@ -4003,9 +4015,10 @@ Output vertical distance that was saved by the
request.
.
.TPx
-.REQ .output contents
+.REQ .output character-sequence
Emit
-.I contents
+.IR character-sequence ,
+a sequence of ordinary characters and spaces,
\[lq]transparently\[rq]
(directly) to
.IR @g@troff 's
@@ -4143,7 +4156,7 @@ Set next page number.
.TPx
.REQ .pnr
Report the names,
-contents,
+values,
and
(as applicable)
assigned formats of all defined registers to the standard error stream.
@@ -4414,7 +4427,7 @@ 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 contents of
+Replace the request's control line with the text of
.IR file ,
\[lq]sourcing\[rq] it.
.
@@ -4891,9 +4904,14 @@ unless and until
evaluates false.
.
.TPx
-.REQ .write "stream contents"
+.REQ .write "stream character-sequence"
Write
-.I contents
+.IR character-sequence ,
+a sequence of ordinary characters,
+spaces,
+or tabs,
+.\" ...or, technically, backspace and delete characters, but let's not
+.\" dwell on that.
to
.IR stream ,
which must previously have been the subject of an
@@ -4908,11 +4926,10 @@ GNU
flushes the stream after writing to it.
.
.TPx
-.REQ .writec "stream contents"
+.REQ .writec "stream character-sequence"
As
.request .write ,
-but does not append a newline to
-.IR contents .
+but does not write a newline to the output.
.
.TPx
.REQ .writem "stream name"
@@ -5526,19 +5543,19 @@ Restore previous fill color.
.ne 4v \" XXX: why not 3v?
.TP
.ESC n r
-Interpolate contents of register with one-character
+Interpolate value of register with one-character
.RI name\~ r .
.
.
.TP
.ESC n( rg
-Interpolate contents of register with two-character
+Interpolate value of register with two-character
.RI name\~ rg .
.
.
.TP
.ESC[] n reg
-Interpolate contents of register with arbitrarily long
+Interpolate value of register with arbitrarily long
.RI name\~ reg .
.
.
@@ -5736,7 +5753,7 @@ Positive motion is downward.
.
.TP
.ESC V e
-Interpolate contents of system environment variable with one-character
+Interpolate value of system environment variable with one-character
.RI name\~ e
as returned by
.MR getenv 3 .
@@ -5744,7 +5761,7 @@ as returned by
.
.TP
.ESC V( ev
-Interpolate contents of system environment variable with two-character
+Interpolate value of system environment variable with two-character
.RI name\~ ev
as returned by
.MR getenv 3 .
@@ -5752,7 +5769,7 @@ as returned by
.
.TP
.ESC[] V env
-Interpolate contents of system environment variable with arbitrarily
+Interpolate value of system environment variable with arbitrarily
long
.RI name\~ env
as returned by
@@ -5775,9 +5792,9 @@ negative before,
positive after).
.
.TP
-.ESCq X contents
+.ESCq X character-sequence
Write
-.I contents
+.I character-sequence
to
.I @g@troff
output as a device extension command.
@@ -8319,7 +8336,7 @@ The
request pushes to and pops from the environment stack,
while
.B evc
-copies a named environment's contents to the current one.
+copies a named environment's parameters to the current one.
.\" END Keep (roughly) parallel with groff.texi node "Environments".
.
.
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
