gbranden pushed a commit to branch master
in repository groff.
commit d4596eb270533a6000fb96716de1b0a449e61d41
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Mar 29 22:46:35 2025 -0500
[doc,man]: Revise discussion of indexed glyphs.
* Discuss it on its own terms in the font file description context
before pivoting to an aside about formatter input.
* Favor active voice over passive.
---
doc/groff.texi.in | 24 +++++++++++++-----------
man/groff_font.5.man | 29 +++++++++++++++--------------
2 files changed, 28 insertions(+), 25 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 5d14e4a13..215362416 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -20241,21 +20241,23 @@ parentheses in some fonts.
The
@var{index}
-field is an integer that uniquely identifies a glyph within the font.
-The glyph can be specified to
-@code{troff} @c generic
-using this index by means of the
-@code{\N}
-escape sequence.
-The index can be any integer.@footnote{that is, any integer parsable by
-the C standard library's
+field is an integer that uniquely identifies a glyph within the font;
+any integer is accepted as input,@footnote{that is,
+any integer parsable
+by the C standard library's
@cite{strtol@r{(3)}}
function}
+but no practical font employs all possible values.
An
@var{index}
-is limited to the range of the C language
-@code{int}
-type on the system.
+is limited to the range of the system's C language data type
+@code{int}.
+In a
+@command{troff} @c generic
+document,
+use the indexed character escape sequence
+@code{\N}
+to specify a glyph by index.
The @var{entity-name} field defines an identifier for the glyph that the
postprocessor uses to print the GNU @code{troff} glyph @var{name}. This
diff --git a/man/groff_font.5.man b/man/groff_font.5.man
index 8d2af6826..9374b7533 100644
--- a/man/groff_font.5.man
+++ b/man/groff_font.5.man
@@ -945,25 +945,26 @@ parentheses in some fonts.
.P
The
.I index
-field is an integer that uniquely identifies a glyph within the font.
-.
-The glyph can be specified to
-.I troff \" generic
-using this index by means of the
-.B \[rs]N
-escape sequence.
-.
-The index can be any integer
+field is an integer that uniquely identifies a glyph within the font;
+any integer is accepted as input,
(that is,
-any integer parsable by the C standard library's
+any integer parsable
+by the C standard library's
.MR strtol 3
-function).
+function)
+but no practical font employs all possible values.
.
An
.I index
-is limited to the range of the C language
-.I int
-type on the system.
+is limited to the range of the system's C language data type
+.IR int .
+.
+In a
+.I troff \" generic
+document,
+use the indexed character escape sequence
+.B \[rs]N
+to specify a glyph by index.
.
.
.P
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
