gbranden pushed a commit to branch master
in repository groff.
commit 4e878580aee4fd9b4e58849d8ac888e8074062b3
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun May 24 21:12:59 2026 -0500
[doc,man]: Revise/sync `tr` request description.
---
doc/groff.texi.in | 41 +++++++++++++++++++++++++++++++----------
man/groff.7.man | 16 +++++++++++++++-
2 files changed, 46 insertions(+), 11 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 94fd6bb1b..b5ee85f91 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -11797,19 +11797,40 @@ environment (@pxref{Environments}).
@cindex character translations
@cindex translations of characters
-A @dfn{translation} is a mapping of an input character to an output
-glyph. The mapping occurs at output time, i.e., the input character
-gets assigned the metric information of the mapped output character
-right before tokens are converted to nodes
-(@pxref{GNU @command{troff} Internals},
-for more on this process).
+A
+@dfn{character translation}
+remaps input characters,
+usually to make input more convenient.
+GNU
+@command{troff} @c GNU
+performs the translation just before formatting the glyph;
+that is,
+right before it converts the character's token
+to a node.@footnote{@xref{GNU @command{troff} Internals},
+for more on this process.}
@DefreqList {tr, @Var{a}@Var{b}@Var{c}@Var{d}@dots{}}
@DefreqListEndx {trin, @Var{a}@Var{b}@Var{c}@Var{d}@dots{}}
-Translate character @var{a} to glyph@tie{}@var{b}, character @var{c} to
-glyph@tie{}@var{d}, and so on. If there is an odd number of characters
-in the argument, the last one is translated to a fixed-width space (the
-same one obtained by the @code{\@key{SPC}} escape sequence).
+Translate character
+@var{a}
+to
+@var{b},
+@var{c}
+to
+@var{d},
+and so on prior to output.
+Unusually,
+spaces are not permitted between the arguments.
+@c TODO: Change that after we tighten up this request's semantics; see
+@c Savannah #68133.
+If number of arguments is odd,
+the formatter translates the last
+to a fixed-width space
+(the same one obtained by the
+@code{\@key{SPC}}
+escape sequence).
+@c TODO: Change that too.
+@c "Explicit is better than implicit." -- The Tao of Python
The
@code{trin}
diff --git a/man/groff.7.man b/man/groff.7.man
index 083329484..ac949341e 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -5595,7 +5595,7 @@ but does not append a newline.
.
.TPx
.REQ .tr abcd\fR\&.\|.\|.\&\fP
-Translate ordinary or special characters
+Translate characters
.I a
to
.IR b ,
@@ -5604,6 +5604,20 @@ to
.IR d ,
and so on prior to output.
.
+Unusually,
+spaces are not permitted between the arguments.
+.\" TODO: Change that after we tighten up this request's semantics; see
+.\" Savannah #68133.
+.
+If number of arguments is odd,
+the formatter translates the last
+to a fixed-width space
+(the same one obtained by the
+.BI \[rs] space
+escape sequence).
+.\" TODO: Change that too.
+.\" "Explicit is better than implicit." -- The Tao of Python
+.
.TPx
.REQ .trf file
Break and copy contents of
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
