gbranden pushed a commit to branch master
in repository groff.
commit 92133e4b0b9816fb715a831858ff1989287ec063
Author: G. Branden Robinson <[email protected]>
AuthorDate: Tue Sep 3 04:42:18 2024 -0500
[doc,man]: Clarify and sync `.{f,g}color` meaning.
Abbreviate fairly obvious metasyntactic variable name.
---
doc/groff.texi.in | 18 +++++++++---------
man/groff.7.man | 12 +++++++-----
man/groff_diff.7.man | 8 ++++----
3 files changed, 20 insertions(+), 18 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 193d5271e..8ba574a82 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -12424,12 +12424,14 @@ the eight standard @w{ISO 6429}/ECMA-48 color
names.@footnote{These
are known vulgarly as ``ANSI'' colors, after its X3.64 standard, now
withdrawn.}
-@DefreqList {gcolor, [@Var{color}]}
+@DefreqList {gcolor, [@Var{col}]}
@DefescItemx {\\m, , c, }
@DefescItem {\\m, (, co, }
-@DefescItem {\\m, [, color, ]}
+@DefescItem {\\m, [, col, ]}
@DefregListEndx {.m}
-Set the stroke color to @var{color}.
+Set the stroke color. The escape sequence @code{\m[]} restores the
+previous stroke color, or the default if there is none, as does a
+@code{gcolor} request without an argument.
@Example
.gcolor red
@@ -12439,9 +12441,6 @@ The next words
and these words are in the previous color.
@endExample
-The escape sequence @code{\m[]} restores the previous stroke color, as
-does a @code{gcolor} request without an argument.
-
@cindex stroke color name register (@code{.m})
@cindex name, stroke color, register (@code{.m})
@cindex color name, stroke, register (@code{.m})
@@ -12462,14 +12461,15 @@ when writing a margin character as follows
(@pxref{Miscellaneous}).
@endExample
@endDefesc
-@DefreqList {fcolor, [@Var{color}]}
+@DefreqList {fcolor, [@Var{col}]}
@DefescItemx {\\M, , c, }
@DefescItem {\\M, (, co, }
-@DefescItem {\\M, [, color, ]}
+@DefescItem {\\M, [, col, ]}
@DefregListEndx {.M}
Set the fill color for objects drawn with @code{\D'@dots{}'} escape
sequences. The escape sequence @code{\M[]} restores the previous fill
-color, as does an @code{fcolor} request without an argument.
+color, or the default if there is none, as does an @code{fcolor} request
+without an argument.
@cindex @code{\M} escape sequence, untokenized on input
@cindex untokenized escape sequence, @code{\M}
diff --git a/man/groff.7.man b/man/groff.7.man
index 56765cff6..4ebe18694 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -3199,12 +3199,13 @@ lacks a glyph for
.
.TPx
.REQ .fcolor
-Restore previous fill color.
+Restore previous fill color,
+or the default if there is none.
.
.TPx
.REQ .fcolor color
Select
-.I color
+.I col
as the fill color.
.
.TPx
@@ -3333,12 +3334,13 @@ a multiplier of the current type size in thousandths
.
.TPx
.REQ .gcolor
-Restore previous stroke color.
+Restore previous stroke color,
+or the default if there is none.
.
.TPx
-.REQ .gcolor color
+.REQ .gcolor col
Select
-.I color
+.I col
as the stroke color.
.
.TPx
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 2c5a60b1d..71b3ed6dd 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -2527,9 +2527,9 @@ This test happens before special fonts are searched.
.
.TP
.BR .fcolor\~ [\c
-.IR color ]
+.IR col ]
Set the fill color to
-.IR color ,
+.IR col ,
or,
without an argument,
restore the previous stroke color,
@@ -2649,9 +2649,9 @@ not an abstract style or mounting position.
.
.TP
.BR .gcolor\~ [\c
-.IR color ]
+.IR col ]
Set the stroke color to
-.IR color ,
+.IR col ,
or,
without an argument,
restore the previous stroke color,
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
