[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 17/29: groff_man_style(7): Fix content nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 17/29: groff_man_style(7): Fix content nits. |
Date: |
Tue, 26 Apr 2022 06:40:18 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 06a9d2da1df0816218778fc84751729bf8963b5b
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Apr 18 14:02:03 2022 +1000
groff_man_style(7): Fix content nits.
* Consistently refer to `\|` as a "thin space" escape sequence (not
"narrow").
* Revise discussion of ellipsis again. Use a more representative
example, and present it in the two-column format used elsewhere in
this section.
---
tmac/groff_man.7.man.in | 47 ++++++++++++++++++++++++++++++-----------------
1 file changed, 30 insertions(+), 17 deletions(-)
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index 70a94669..b35a55a6 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -412,8 +412,11 @@ The macro package may also abbreviate
.I title
and
.I footer-inside
-with an ellipsis if they overrun the space available in the header and
-footer,
+with ellipses
+_ifstyle()dnl
+.RB ( .\|.\|.\& )
+_endif()dnl
+if they overrun the space available in the header and footer,
respectively.
.
For HTML output,
@@ -2397,10 +2400,10 @@ recognized as such.
.
.TP
.B \e|
-Narrow
+Thin space
(one-sixth em on typesetters,
-zero-width on terminals)
-non-breaking space.
+zero-width on terminals);
+a non-breaking space.
.
Used primarily in ellipses
(\(lq.\e|.\e|.\(rq)
@@ -3822,7 +3825,7 @@ in subsection \[lq]Command synopsis macros\[rq].
The idiomatic
.I roff
ellipsis is three dots (periods)
-with a \[lq]thin space\[rq] escape sequence
+with thin space escape sequences
.B \[rs]|
internally separating them.
.
@@ -3850,18 +3853,28 @@ would then need to be suffixed with
.B \[rs]&
when not ending a sentence.
.
-.RS
-.RS
-.EX
-Arguments are foo bar \[rs]*[EL]\[rs]& except when debugging.
-Arguments are foo bar .\[rs]|.\[rs]|.\[rs]& except when debugging.
-.EE
-.RE
+.br
+.ne 4v
+.TS
+C C
+LfCB LfCB.
+Instead of.\|.\|. .\|.\|.do this.
+_
+\&.ds EL \[rs]&.\[rs]|.\[rs]|. Arguments are
+Arguments are .IR src-file\[rs]\[ti] .\[rs]|.\[rs]|.\[rs]&
+\&.IR src-file\[rs]\[ti] \[rs]*(EL\[rs]& .IR dest-dir .
+\&.IR dest-dir .
+_
+.TE
.
-Such a string saves one character of typing,
-at the cost of obscuring even the suggestion of an ellipsis to a casual
-reader of the source document.
-.RE
+.
+.IP
+The first column practices a false economy;
+the savings in typing is offset by the cost of obscuring even the
+suggestion of an ellipsis to a casual reader of the source document,
+and reduced portability to
+.RI non- roff
+man page formatters that cannot handle string definitions.
.
.
.IP
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 17/29: groff_man_style(7): Fix content nits.,
G. Branden Robinson <=