gbranden pushed a commit to branch master
in repository groff.
commit 07e2f211f185d5948764798fb57c24e061a70a87
Author: G. Branden Robinson <g.branden.robin...@gmail.com>
AuthorDate: Fri Mar 7 06:27:01 2025 -0600
[doc,man]: Revise `open` and `opena` descriptions.
Also sync their wording between documents.
---
doc/groff.texi.in | 22 +++++++++++++++++-----
man/groff.7.man | 8 +++++---
man/groff_diff.7.man | 27 ++++++++++++++++-----------
3 files changed, 38 insertions(+), 19 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 138610c73..2099412b6 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -464,7 +464,7 @@ Documentation License''.
@title groff
@subtitle The GNU implementation of @code{troff}
@subtitle version @VERSION@
-@subtitle February 2025
+@subtitle March 2025
@author Trent@tie{}A.@: Fisher
@author Werner Lemberg
@author G.@tie{}Branden Robinson
@@ -16844,11 +16844,23 @@ output.
@cindex file, opening (@code{open})
@cindex appending to a file (@code{opena})
@cindex file, appending to (@code{opena})
-Open the specified @var{file} for writing and associates the specified
-@var{stream} with it.
+Open
+@var{file}
+for writing and associate a stream named
+@var{ident}
+with it,
+making it available for
+@code{write}
+requests.
-The @code{opena} request is like @code{open}, but if the file exists,
-append to it instead of truncating it.
+The
+@code{opena}
+request is like
+@code{open},
+but if
+@var{file}
+already exists,
+appends to it instead of overwriting it.
@cindex safer mode
@cindex mode, safer
diff --git a/man/groff.7.man b/man/groff.7.man
index 79a557190..542d22dc4 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -4044,9 +4044,11 @@ disabled by default.
.TPx
.REQ .opena "ident file"
As
-.RB \[lq] open \[rq] ,
-but append to
-.I file.
+.RB \[lq] open \[rq],
+but if
+.I file
+already exists,
+appends to it instead of overwriting it.
.
Unsafe request;
disabled by default.
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 419d3c6ea..11444fede 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -3290,31 +3290,36 @@ See
.
.
.TP
-.BI .open\~ "stream\~\c
+.BI .open\~ "ident\~\c
.RB [ \[dq] ]\c
.I file
Open
.I file
-for writing and associate
-.I stream
-with it.
+for writing and associate a stream named
+.I ident
+with it,
+making it available for
+.RB \[lq] write \[rq]
+requests.
.
-See
-.B write
-and
-.BR close .
+Unsafe request;
+disabled by default.
.
+Also see
+.B writec
+and
+.RB \[lq] close \[rq].
.
.TP
-.BI .opena\~ "stream\~\c
+.BI .opena\~ "ident\~\c
.RB [ \[dq] ]\c
.I file
As
.RB \[lq] open \[rq],
but if
.I file
-exists,
-append to it instead of truncating it.
+already exists,
+appends to it instead of overwriting it.
.
.
.TP
_______________________________________________
groff-commit mailing list
groff-commit@gnu.org
https://lists.gnu.org/mailman/listinfo/groff-commit
