[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 02/02: groff_man(7): Update discussion of \c and \f.
From: |
G. Branden Robinson |
Subject: |
[groff] 02/02: groff_man(7): Update discussion of \c and \f. |
Date: |
Mon, 18 Jun 2018 03:20:50 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 39be7446fd2ccb3c32dc89ebbb35b037d259d3fa
Author: G. Branden Robinson <address@hidden>
Date: Mon Jun 18 03:14:15 2018 -0400
groff_man(7): Update discussion of \c and \f.
Share the lesson learned from Savannah #53795.
Document interaction of .BI and .RI macros with italic corrections and
use of \c escape in final (if even-numbered) macro arguments.
Slightly clarify which argument is meant when discussing .TP; it's not
the optional one on the same line, but the one on the next line.
Recast software package names in a more prosaic way, instead of
a tar-file-ish one.
Get rid of a stray .sp request.
Admit that anyone who wants italic corrections is going to have to give
up some portability (presumably).
Signed-off-by: G. Branden Robinson <address@hidden>
---
tmac/groff_man.7.man | 54 ++++++++++++++++++++++++++++++++++++++++++++++------
1 file changed, 48 insertions(+), 6 deletions(-)
diff --git a/tmac/groff_man.7.man b/tmac/groff_man.7.man
index de9db81..8329120 100644
--- a/tmac/groff_man.7.man
+++ b/tmac/groff_man.7.man
@@ -1385,16 +1385,46 @@ in a single word, for example:
.RE
.
.IP
+Note that when using this trick with the
+.B .BI
+or
+.B .RI
+macros, you will need to manually add an italic correction escape
+.B \e/
+before the
+.B \ec
+due to way macros expand their arguments.
+.
+.
+.RS
+.IP
+.EX
+Files processed with
+\&.B groff \e\-mom
+(or
+\&.BI "\e\-m " mom\e/\ec
+) produce PostScript output by default.
+.EE
+.RE
+.
+.
+.IP
Alternatively, and perhaps with better portability, the
.B \ef
font escape sequence can be used; see below.
-.sp
+.
Attempting to use
.B \ec
-to include the output from more than one macro line into the head of a
+to include the output from more than one macro line into the next-line
+argument of a
.B .TP
-macro will misrender with groff-1.22.3, mandoc-1.14.1, older versions of
-these programs, and perhaps with some other formatters.
+macro will misrender with
+.I groff
+1.22.3,
+.I mandoc
+1.14.1,
+older versions of these programs,
+and perhaps with some other formatters.
.
.TP
.B \ee
@@ -1429,9 +1459,21 @@ It can also be used if three different fonts are needed
in a
single word.
It may be more portable than
.BR \ec .
+.
+It is up to you to account for italic corrections with
+.B \e/
+and
+.BR \e, ,
+which are themselves
+.I groff
+extensions,
+if desired and if supported by your implementation.
+.
+.
.IP
-As long as only two fonts are needed, using font alternation
-macros like
+As long as at most two fonts are needed in any one whitespace-delimited
+word,
+using font alternation macros like
.B .BR
usually results in more readable source code.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 02/02: groff_man(7): Update discussion of \c and \f.,
G. Branden Robinson <=