[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 02/02: man pages: Set filespecs in italics, not bold.
From: |
G. Branden Robinson |
Subject: |
[groff] 02/02: man pages: Set filespecs in italics, not bold. |
Date: |
Wed, 28 Nov 2018 18:31:27 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 1eb479103854518db2cc4254c1f2601c30be7380
Author: G. Branden Robinson <address@hidden>
Date: Wed Nov 28 18:13:03 2018 -0500
man pages: Set filespecs in italics, not bold.
contrib/chem/chem.1.man:
contrib/mm/groff_mm.7.man:
contrib/mm/groff_mmse.7.man:
contrib/mom/groff_mom.7.man:
+ Variable parts of filespecs are set in roman in that context but
italicized when mentioned in isolation in running prose; see
groff_man(7).
contrib/chem/chem.1.man:
contrib/mm/groff_mm.7.man:
contrib/mm/groff_mmse.7.man:
+ Shell globs within filespecs are also set in roman.
contrib/mm/groff_mm.7.man:
* Don't quote filespecs on top of or instead of italicizing them.
contrib/mom/groff_mom.7.man:
* Use @MACRODIR@ to provide full installation path to macro package
files.
* Don't suppress hyphenation in paragraph tags:
+ As tags, they'll be set pretty far left anyway;
+ You'd need a pretty long configure --prefix to blow the 78n budget
on a traditional terminal; and
+ Since commit ea32b7d0462813fc3e7c423efb6d805273df9edd, we get free
discretionary breaks after slashes in macro-expanded filespec
components anyway. So with any luck, even in the unlikely case a
filespec paragraph tag has to be broken, it won't be done in an
eye-watering place using a hyphen.
This is a checkpoint commit; there are about 29 more pages to do but
it's time for a release freeze.
Signed-off-by: G. Branden Robinson <address@hidden>
---
contrib/chem/chem.1.man | 14 +++++++-------
contrib/mm/groff_mm.7.man | 25 ++++++++++++++-----------
contrib/mm/groff_mmse.7.man | 4 ++--
contrib/mom/groff_mom.7.man | 14 +++++++-------
4 files changed, 30 insertions(+), 27 deletions(-)
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index f6397c4..d6574ce 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -122,17 +122,17 @@ all exit.
The program
.B @address@hidden
originates from the Perl source file
-.BR chem.pl .
+.IR chem.pl .
.
It tells
.B @address@hidden
to include a copy of the macro file
-.BR chem.pic .
+.IR chem.pic .
.
Moreover the
.I groff
source file
-.B pic.tmac
+.I pic.tmac
is loaded.
.
.
@@ -847,14 +847,14 @@ A squiggle bond is needed.
.\" ====================================================================
.
.TP
-.B @DATASUBDIR@/pic/chem.pic
+.I @DATASUBDIR@/pic/chem.pic
A collection of
.I pic
macros needed by
.BR @address@hidden .
.
.TP
-.B @MACRODIR@/pic.tmac
+.I @MACRODIR@/pic.tmac
A macro file which redefines
.B .PS
and
@@ -864,12 +864,12 @@ to center
diagrams.
.
.TP
-.B @DOCDIR@/examples/chem/*.chem
+.IR @DOCDIR@/examples/chem/ * .chem
Example files for
.IR chem .
.
.TP
-.B @DOCDIR@/examples/chem/122/*.chem
+.IR @DOCDIR@/examples/chem/122/ * .chem
Example files from the classical
.I chem
article
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index fc9a6aa..3ecf8f0 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -77,7 +77,7 @@ Use
as an example how to adapt the output format to a national standard.
.
Localized strings are collected in the file
-.RI address@hidden@/ xx .tmac\[cq],
+.IR @MACRODIR@/ xx .tmac ,
where
.I xx
denotes the two-letter code for the
@@ -93,9 +93,9 @@ is the ISO 3166 two-letter code for the
.\"########################################################################
.LP
A file called
-.B locale
+.I locale
or
-.IB country _locale
+.RI country _locale
is read after the initialization of the global variables.
.
It is therefore possible to localize the macros with a different company
@@ -543,11 +543,12 @@ appears before any normal text.
This macro uses
.I arg
to build the filename
address@hidden@/\fIarg\fP.cov\[cq].
+.IR @TMAC_MDIR@/ arg .cov .
.
Therefore it is possible to create unlimited types of cover sheets.
.
-\[oq]ms.cov\[cq] is supposed to look like the ms cover sheet.
+.I ms.cov
+is supposed to look like the ms cover sheet.
.
.B .COVER
requires a
@@ -1686,7 +1687,8 @@ T}
Initialize the cross reference macros.
.
Cross references are written to stderr and are supposed to be
-redirected into file \[oq]\fIfilename\fR.qrf\[cq].
+redirected into file
+.RI filename .qrf .
.
Requires two passes with groff;
this is handled by a separate program called
@@ -2123,7 +2125,8 @@ Memorandum type.
.
The argument
.I arg
-is part of a filename in address@hidden@/*.MT\[cq].
+is part of a filename in
+.IR @TMAC_MDIR@/ * .MT .
.
Memorandum types 0 to\~5 are supported, including type
\[oq]string\[cq] (which gets internally mapped to type\~6).
@@ -3948,13 +3951,13 @@ then assigns the argument to the string variable
.\" ====================================================================
.
.TP
-.B @MACRODIR@/@address@hidden
+.I @MACRODIR@/@address@hidden
.TP
-.B @TMAC_MDIR@/*.cov
+.IR @TMAC_MDIR@/ * .cov
.TP
-.B @TMAC_MDIR@/*.MT
+.IR @TMAC_MDIR@/ * .MT
.TP
-.B @TMAC_MDIR@/locale
+.I @TMAC_MDIR@/locale
.
.
.\" ====================================================================
diff --git a/contrib/mm/groff_mmse.7.man b/contrib/mm/groff_mmse.7.man
index 7c8d8fc..814d54f 100644
--- a/contrib/mm/groff_mmse.7.man
+++ b/contrib/mm/groff_mmse.7.man
@@ -148,9 +148,9 @@ J
.\" ====================================================================
.
.TP
-.B @MACRODIR@/@address@hidden
+.I @MACRODIR@/@address@hidden
.TP
-.B @TMAC_MDIR@/se_*.cov
+.IR @TMAC_MDIR@/se_ * .cov
.
.
.na
diff --git a/contrib/mom/groff_mom.7.man b/contrib/mom/groff_mom.7.man
index 6e2c27f..aa3f451 100644
--- a/contrib/mom/groff_mom.7.man
+++ b/contrib/mom/groff_mom.7.man
@@ -199,23 +199,23 @@ usage.
.\" ====================================================================
.
.TP
-.B om.tmac
+.I @MACRODIR@/\:om.tmac
\[en] the main macro file
.TQ
-.B mom.tmac
+.I @MACRODIR@/\:mom.tmac
\[en] a wrapper file that calls om.tmac directly.
.
.TP
-.B address@hidden@/\:mom/\:toc.html
+.I @HTMLDOCDIR@/\:mom/\:toc.html
\[en] entry point to the HTML documentation
.
.TP
-.B address@hidden@/\:mom\-pdf.pdf
+.I @PDFDOCDIR@/\:mom\-pdf.pdf
\[en] the PDF manual,
.I Producing PDFs with groff and mom
.
.TP
-.B @EXAMPLEDIR@/mom/*.mom
+.IR @EXAMPLEDIR@/\:mom/\: * .mom
\[en] example files using mom
.
.
@@ -239,7 +239,7 @@ and
is very well documented in
.
.TP
-.B address@hidden@/\:mom/\:toc.html
+.I @HTMLDOCDIR@/\:mom/\:toc.html
\[en] entry point to the HTML documentation
.
.
@@ -3377,7 +3377,7 @@ team.
.BR groff_mom (@MAN7EXT@),
.
.TP
-.B address@hidden@/\:mom/\:toc.html
+.I address@hidden@/\:mom/\:toc.html
\[en] entry point to the HTML documentation
.
.TP
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 02/02: man pages: Set filespecs in italics, not bold.,
G. Branden Robinson <=