gbranden pushed a commit to branch master in repository groff. commit 0d88675983d73a011cd64c986d094cdee5aa2b64 Author: G. Branden Robinson <g.branden.robin...@gmail.com> AuthorDate: Fri Feb 21 04:19:03 2025 -0600
[doc,man]: Avoid documentary faceplant. Correct misstatements that crept into descriptions of character definition and removal requests post-1.23.0 (my fault). Make further clarifications and parallelize language between man pages and our Texinfo manual. --- doc/groff.texi.in | 15 +++++++++++---- man/groff.7.man | 32 ++++++++++++++++++++++++-------- man/groff_diff.7.man | 16 ++++++++++------ 3 files changed, 45 insertions(+), 18 deletions(-) diff --git a/doc/groff.texi.in b/doc/groff.texi.in index bd470649e..785d9dbed 100644 --- a/doc/groff.texi.in +++ b/doc/groff.texi.in @@ -11463,8 +11463,10 @@ on the right doesn't get examined. @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 @var{contents} is absent, an existing character definition made with -the same request is deleted. +If +@var{contents} +is absent, +the character is defined with empty contents. A leading neutral double quote in the second argument is stripped from it, allowing embedded leading spaces in @var{contents}, which is read to @@ -11546,8 +11548,13 @@ request in @ref{Strings}. @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} -request. Those supplied by font description files cannot be removed. -Spaces need not separate @var{c}@tie{}arguments. +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. +Spaces need not separate the arguments. The request @code{rfschar} removes glyph definitions defined with @code{fschar} for font@tie{}@var{f}. diff --git a/man/groff.7.man b/man/groff.7.man index 2ac7e67ca..9e25a44ac 100644 --- a/man/groff.7.man +++ b/man/groff.7.man @@ -2855,8 +2855,9 @@ by moving its location to . .TPx .REQ .char c -Remove definition of ordinary or special -.RI character\~ c. +Define ordinary or special character +.I c +as empty. . .TPx .REQ .char "c contents" @@ -3275,8 +3276,9 @@ and pad glyph to\~\c . .TPx .REQ .fchar c -Remove definition of fallback -.RI character\~ c. +Define fallback +.RI character\~ c +as empty. . .TPx .REQ .fchar "c contents" @@ -3335,10 +3337,11 @@ at non-negative position . .TPx .REQ .fschar "f c" -Remove definition of fallback +Define fallback .RI character\~ c specific to -.RI font\~ f. +.RI font\~ f +as empty. . .TPx .REQ .fschar "f c contents" @@ -4256,6 +4259,18 @@ or .request .schar request. . +The character definition removed +(if any) +is the first encountered in the glyph resolution process; +see section \[lq]Using Symbols\[rq] of +.IR "Groff: The GNU Implementation of troff" . +. +Glyphs, +which are defined by font description files, +cannot be removed. +. +Spaces need not separate the arguments. +. .TPx .REQ .rd Read insertion from standard input stream, @@ -4367,8 +4382,9 @@ unit\~\c . .TPx .REQ .schar c -Remove definition of global fallback -.RI character\~ c. +Define global fallback character +.I c +as empty. . .TPx .REQ .schar "c contents" diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man index fa9130565..5001cf4b3 100644 --- a/man/groff_diff.7.man +++ b/man/groff_diff.7.man @@ -2060,7 +2060,7 @@ as If .I contents is absent, -an existing character definition made with the same request is deleted. +the character is defined with empty contents. . . .IP @@ -2144,9 +2144,9 @@ requests take precedence if also applies .RI to\~ c . . -A character definition can be removed with the +The .B rchar -request. +request removes character definitions. . . .TP @@ -3512,13 +3512,17 @@ or .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 +.IR "Groff: The GNU Implementation of troff" . +. Glyphs, which are defined by font description files, cannot be removed. . -Spaces and tabs may separate -.I c -arguments. +Spaces need not separate the arguments. . . .TP _______________________________________________ groff-commit mailing list groff-commit@gnu.org https://lists.gnu.org/mailman/listinfo/groff-commit