gbranden pushed a commit to branch master
in repository groff.
commit 68edbd19e526b850f4a338e33af873cc3eb66639
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Apr 12 07:06:32 2025 -0500
[doc,man]: Update `{,r,rfs}char` descriptions.
Reinforce the three character types: ordinary, special, indexed.
Parallelize wording and input line breaks between Texinfo and man pages.
In groff_diff(7), drop material that's already covered in the
subsection's introductory paragraph.
---
doc/groff.texi.in | 54 +++++++++++++++++++++++++++++++++++++++-------------
man/groff.7.man | 42 ++++++++++++++++++++++++++++------------
man/groff_diff.7.man | 42 +++++++++++++++++++++-------------------
3 files changed, 93 insertions(+), 45 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 2b4178ea2..f974ad382 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -11557,12 +11557,23 @@ on the right doesn't get examined.
@cindex @code{\&}, and glyph definitions
@cindex @code{\e}, and glyph definitions
@cindex @code{hcode} request, and glyph definitions
-Define an ordinary or special character@tie{}@var{c} as @var{contents}.
-If
+Define an
+ordinary,
+special,
+or
+indexed
+character
+@var{c}
+as
+@var{contents}.
+
+Omitting
@var{contents}
-is absent,
-the character is defined with empty contents.
+gives
+@var{c}
+an empty definition.
+@c Omit this paragraph from man pages.
GNU
@command{troff} @c GNU
removes a leading neutral double quote
@@ -11646,21 +11657,38 @@ request in @ref{Strings}.
@DefreqList {rchar, c @dots{}}
@DefreqListEndx {rfschar, f c @dots{}}
-@cindex removing glyph definition (@code{rchar}, @code{rfschar})
+@cindex removing character definition (@code{rchar}, @code{rfschar})
+@cindex character, removing definition (@code{rchar}, @code{rfschar})
+@cindex fallback character, removing definition of (@code{rchar},
@code{rfschar})
+@c obsolete terminology follows
@cindex glyph, removing definition (@code{rchar}, @code{rfschar})
-@cindex fallback glyph, removing definition (@code{rchar}, @code{rfschar})
-Remove definition of each ordinary or special character @var{c},
-undoing the effect of a @code{char}, @code{fchar}, or @code{schar}
+Remove definition of each
+ordinary,
+special,
+or
+indexed
+character
+@var{c},
+undoing the effect of a
+@code{char},
+@code{fchar},
+or
+@code{schar}
request.
The character definition removed
(if any)
-is the first encountered in the glyph resolution process documented
-above.
-Those supplied by font description files cannot be removed.
+is the first encountered in the resolution process documented above.
+Glyphs,
+which are defined by font description files,
+cannot be removed.
Spaces need not separate the arguments.
-The request @code{rfschar} removes glyph definitions defined with
-@code{fschar} for font@tie{}@var{f}.
+The request
+@code{rfschar}
+removes character definitions created by
+@code{fschar}
+for
+font@tie{}@var{f}.
@endDefreq
@c ---------------------------------------------------------------------
diff --git a/man/groff.7.man b/man/groff.7.man
index e53c3cc75..74f96ea1d 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -2893,13 +2893,23 @@ by moving its location to
.
.TPx
.REQ .char c
-Define ordinary or special character
+Define an
+ordinary,
+special,
+or
+indexed
+character
.I c
as empty.
.
.TPx
.REQ .char "c contents"
-Define ordinary or special character
+Define an
+ordinary,
+special,
+or
+indexed
+character
.I c
as
.I contents.
@@ -4333,21 +4343,26 @@ Change post-vertical line spacing according to
.
.TPx
.REQ .rchar "c1 c2 \fR.\|.\|.\&\fP"
-Remove definition of each ordinary or special character
-.IR c1 ,
-.IR c2 ,
-\&.\|.\|.\& defined by a
-.request .char ,
-.request .fchar ,
+Remove definition of each
+ordinary,
+special,
+or
+indexed
+character
+.IR c ,
+undoing the effect of a
+.BR char ,
+.BR \%fchar ,
or
-.request .schar
+.B \%schar
request.
.
The character definition removed
(if any)
-is the first encountered in the glyph resolution process;
-see section \[lq]Using Symbols\[rq] of
+is the first encountered in the resolution process documented
+in section \[lq]Using Symbols\[rq] of
.IR "Groff: The GNU Implementation of troff" .
+.\" TODO: Get that information into this man page!
.
Glyphs,
which are defined by font description files,
@@ -4381,10 +4396,13 @@ and once in an enclosing macro.
.
.TPx
.REQ .rfschar "f c1 c2 \fR\&.\|.\|.\&\fP"
-Remove the font-specific definitions of glyphs
+Remove font-specific character definitions
.IR c1 ,
.IR c2 ,
\&.\|.\|.\& for
+created by
+.B \%fschar
+for
.RI font\~ f .
.
.TPx
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 6232e7e3c..6a59f042f 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -2073,24 +2073,21 @@ character on the right doesn't get examined.
.BI .char\~ c\~\c
.RB [[ \[dq] ]\c
.IR contents ]
-Define an ordinary or special
-.RI character\~ c
+Define an
+ordinary,
+special,
+or
+indexed
+character
+.I c
as
.I contents.
.
-If
+Omitting
.I contents
-is absent,
-the character is defined with empty contents.
-.
-GNU
-.I troff \" GNU
-removes a leading neutral double quote
-.RB \[oq] \[dq] \[cq]
-from
-.IR contents ,
-permitting initial embedded spaces in it,
-and reads it to the end of the input line in copy mode.
+gives
+.I c
+an empty definition.
.
.
.IP
@@ -3563,20 +3560,25 @@ and the post-vertical line spacing set by this request.
.TP
.BI .rchar\~ c\~\c
\&.\|.\|.
-Remove definition of each ordinary or special character
+Remove definition of each
+ordinary,
+special,
+or
+indexed
+character
.IR c ,
undoing the effect of a
.BR char ,
-.BR fchar ,
+.BR \%fchar ,
or
-.B schar
+.B \%schar
request.
-.
The character definition removed
(if any)
-is the first encountered in the glyph resolution process;
-see section \[lq]Using Symbols\[rq] of
+is the first encountered in the resolution process documented
+in section \[lq]Using Symbols\[rq] of
.IR "Groff: The GNU Implementation of troff" .
+.\" TODO: Get that information into this man page!
.
Glyphs,
which are defined by font description files,
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
