[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 08/09: groff_man_style(7): Improve explanations.
From: |
G. Branden Robinson |
Subject: |
[groff] 08/09: groff_man_style(7): Improve explanations. |
Date: |
Thu, 20 Aug 2020 09:59:03 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 76b2801fcbca9b769f43453a43f978c5f2d0d0ef
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Aug 19 21:12:15 2020 +1000
groff_man_style(7): Improve explanations.
* tmac/groff_man.7.man.in (Description/Portability) [style] <.>: Use
more prescriptive language.
* (Description/Portability) [style] <\c>: Attempt greater clarity. Add
example for non-filling use case (within .EX/.EE).
---
tmac/groff_man.7.man.in | 36 +++++++++++++++++++++++++++---------
1 file changed, 27 insertions(+), 9 deletions(-)
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index 4e59933..6c281b9 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -2122,8 +2122,7 @@ Comment.
Everything after the double-quote to the end of the input line is
ignored.
.
-Whole-line comments are frequently placed immediately after the empty
-request
+Whole-line comments should be placed immediately after the empty request
.RB \(lq . \(rq).
.
.
@@ -2340,27 +2339,32 @@ the end of an input line is treated like a space;
an output line
.I may
be broken there\" in fill mode
+(if not,
+an adjustable space is inserted)
and
.I will
-be in
+be broken there in
.B .EX/.EE
-examples;\" i.e., no-fill mode
-if the line is not broken,
-an adjustable space is inserted.
+examples.\" i.e., no-fill mode
+.
+This escape ends an input line without inserting space or attempting a
+break.
.
Anything after
.B \ec
on the input line
.\" ...except for \R escapes, which shouldn't appear in man pages...
-is discarded.
+is ignored.
.
The next line is interpreted as usual and can `include' a macro call
(contrast with
.BI \e newline\/\c
).
.
-This is occasionally useful when three different fonts are needed in a
-single word.
+This escape is useful when three different font styles are needed in a
+single word or on a single line in
+.B .EX/.EE
+examples.
.
.
.RS
@@ -2375,6 +2379,20 @@ the final output file should be named
.RE
.
.
+.RS
+.IP
+.\" from src/devices/grotty/grotty.1.man
+.EX
+\&.EX
+$ \ec
+\&.B groff \e\-T utf8 \e\-Z \ec
+\&.I file \ec
+\&.B | grotty \e\-i
+\&.EE
+.EE
+.RE
+.
+.
.IP
Note that when using this trick with the
.B .BI
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 08/09: groff_man_style(7): Improve explanations.,
G. Branden Robinson <=