gbranden pushed a commit to branch master
in repository groff.
commit 7d652af3f65e9d81779b36f7690594e131c005ee
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sun Jan 25 21:02:29 2026 -0600
doc/groff.texi.in: Revise grout example material.
* Recast.
* Speak in terms of Unix file streams, not "feeding". Besides being
more precise, few users these days have experience with punched card
or paper tape readers as input devices with orifices such that this
casual analogy is helpful. (Maybe the term is more idiomatic in the
native German of the original author.)
* Replace yet another coinage for the legacy compressed encoding,
"jump-and-write command" with the single term now in use.
* Reform terminogy: "prologue" -> "header".
* Speak of "X11", not "X", since "X" means lots of things and prospects
for an X Window System Version 12 are as dim as ever.
* Use Texinfo @command command to mark executable command names, not
@code.
* Break input lines in a *roff-friendly way.
I feel it necessary to reiterate a remark I made in a commit message a
little over a month ago: Bernd needed much closer supervision, or more
active mentoring, than he got. His technical writing demands heavy
revision in every place I've encountered it.
---
doc/groff.texi.in | 58 +++++++++++++++++++++++++++++++++++++------------------
1 file changed, 39 insertions(+), 19 deletions(-)
diff --git a/doc/groff.texi.in b/doc/groff.texi.in
index 72dfc9038..55c9ba989 100644
--- a/doc/groff.texi.in
+++ b/doc/groff.texi.in
@@ -23976,15 +23976,27 @@ produce more readable output.
@node Intermediate Output Examples
@subsection Intermediate Output Examples
-This section presents the intermediate output generated from the same
-input for three different devices. The input is the sentence @samp{hell
-world} fed into @command{@g@troff} on the command line.
+This section presents the output
+GNU
+@command{troff} @c GNU
+generates from the same input formatted for three different devices.
+The input is the phrase
+@samp{hell world}
+piped to
+GNU
+@command{troff} @c GNU
+on the command line.
@table @asis
@item High-resolution device @code{ps}
-This is the standard output of @command{@g@troff} if no @option{-T} option
-is given.
+We depict the standard output stream of
+GNU
+@command{troff} @c GNU
+in its default build configuration
+and in the absence of an explicit
+@option{-T}
+option.
@example
@group
@@ -24014,8 +24026,9 @@ x stop
@end example
@noindent
-This output can be fed into @code{grops} to get its representation as a
-PostScript file.
+This output can be placed onto the standard input stream of
+@command{grops}
+to produce its representation as a PostScript file.
@item Low-resolution device @code{latin1}
@@ -24028,7 +24041,7 @@ the formatter.
@group
shell> echo "hell world" | groff -Z -T latin1
-# prologue
+# header
x T latin1
x res 240 24 40
x init
@@ -24059,13 +24072,15 @@ x stop
@end example
@noindent
-This output can be fed into @code{grotty} to get a formatted text
-document.
+This output can be placed onto the standard input stream of
+@command{grotty}
+to produce its representation as text file.
-@item @acronym{AT&T} @code{troff} output
-Since a computer monitor has a much lower resolution than modern
-printers, the intermediate output for X11 devices can use the
-jump-and-write command with its 2-digit displacements.
+@item @acronym{AT&T} @command{troff} output
+Since a video display has lower resolution than modern printers,
+GNU
+@command{troff}'s @c GNU
+output for X11 devices can use the legacy compressed encoding.
@example
@group
@@ -24081,7 +24096,7 @@ f5
s10
V16
H100
-# write text with jump-and-write commands
+# write text in legacy compressed encoding
ch07e07l03lw06w11o07r05l03dh7
n16 0
@group
@@ -24092,11 +24107,16 @@ x stop
@end example
@noindent
-This output can be fed into @code{xditview} or @code{gxditview} for
-displaying in@tie{}X.
+Place the foregoing into the standard input stream of
+@command{xditview}
+or
+@command{gxditview}
+to display it in an X11 window.
-Due to the obsolete jump-and-write command, the text clusters in the
-@acronym{AT&T} @code{troff} output are almost unreadable.
+The legacy compressed encoding makes the content of formatted text
+in @acronym{AT&T}
+@command{troff} @c AT&T
+output almost incomprehenible.
@end table
@c ---------------------------------------------------------------------
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
