[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 10/12: groff(1): Rewrite "Examples" section.
From: |
G. Branden Robinson |
Subject: |
[groff] 10/12: groff(1): Rewrite "Examples" section. |
Date: |
Mon, 24 Aug 2020 08:15:40 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit d84b993b7dc2dd4c9e32914e005dea00e6c99b9c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Aug 23 20:03:05 2020 +1000
groff(1): Rewrite "Examples" section.
Renamed from "Example" after Linux man-pages 5.07.
Modernize example to use UTF-8 terminal encoding.
Stop suggesting that the traditional example is a literal one. ("What's
'grotty'?" said the Research Unix user.)
Use modern POSIX command substitution syntax.
---
src/roff/groff/groff.1.man | 37 ++++++++++++++++++++-----------------
1 file changed, 20 insertions(+), 17 deletions(-)
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index adf5f8d..3974409 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -1582,54 +1582,57 @@ This device name is overwritten by the option
.
.
.\" ====================================================================
-.SH Example
+.SH Examples
.\" ====================================================================
.
The following example illustrates the power of the
-.B groff
+.I groff
program as a wrapper around
-.BR @g@troff .
+.IR @g@troff .
.
.
.P
To process a
.I roff
-file using the preprocessors
-.B tbl
+input file using the preprocessors
+.I tbl \" AT&T
and
-.B pic
+.I pic \" AT&T
and the
-.B me
-macro set, classical
+.I me
+macro package in the way to which AT&T
.I troff
-had to be called by
+users were accustomed,
+one would type
+(or script)
+a pipeline.
.
.IP
.EX
-pic foo.me | tbl | troff \-me \-Tlatin1 | grotty
+pic foo.me | tbl | troff \-me \-Tutf8 | grotty
.EE
.
.
.P
Using
-.BR groff ,
+.IR groff ,
this pipe can be shortened to the equivalent command
.
.IP
.EX
-groff \-p \-t \-me \-T latin1 foo.me
+groff \-p \-t \-me \-T utf8 foo.me
.EE
.
.
.P
-An even easier way to call this is to use
-.BR grog (@MAN1EXT@)
-to guess the preprocessor and macro options and execute the generated
-command (by using backquotes to specify shell command substitution)
+An even easier way to do this is to use
+.IR grog (@MAN1EXT@)
+to guess the preprocessor and macro options and execute the result by
+using the command substitution feature of the shell.
.
.IP
.EX
-\[ga]grog \-Tlatin1 foo.me\[ga]
+$(grog \-Tutf8 foo.me)
.EE
.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 10/12: groff(1): Rewrite "Examples" section.,
G. Branden Robinson <=