[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 09/20: mmroff(1): Make style fixes.
From: |
G. Branden Robinson |
Subject: |
[groff] 09/20: mmroff(1): Make style fixes. |
Date: |
Fri, 9 Nov 2018 18:39:40 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit f0c09cca101155e8093d085be5a12a0d4dcbe38a
Author: G. Branden Robinson <address@hidden>
Date: Thu Nov 8 15:29:08 2018 -0500
mmroff(1): Make style fixes.
* contrib/mm/mmroff.1.man:
+ Set command names in italics (as works of software), not
bold.
+ Tighten wording slightly.
+ A "cross reference" is a noun phrase; in "cross-reference
file" it is an adjective phrase, and should be hyphenated.
+ Add Options section heading immediately before the
discussion of command-line options.
+ Remove empty Bugs section.
+ Remove Files section; mmroff itself opens none of the listed
files. groff_mm(7) contains identical material.
+ Fix consistency nit: put one empty request after section
heading comments, for consistency with the rest of the page.
+ Stop turning off adjustment (with .na) before the See Also
section.
Signed-off-by: G. Branden Robinson <address@hidden>
---
contrib/mm/mmroff.1.man | 59 ++++++++++++++++++-------------------------------
1 file changed, 22 insertions(+), 37 deletions(-)
diff --git a/contrib/mm/mmroff.1.man b/contrib/mm/mmroff.1.man
index 3532d40..1c9d010 100644
--- a/contrib/mm/mmroff.1.man
+++ b/contrib/mm/mmroff.1.man
@@ -44,56 +44,42 @@ mmroff \- cross-reference preprocessor for GNU roff mm
macro package
.SH DESCRIPTION
.\" ====================================================================
.
-.B mmroff
+.I mmroff
is a simple preprocessor for
-.BR groff ;
-it is used for expanding cross references in
-.BR address@hidden@m ,
+.IR groff ,
+used for expanding cross references in
+.IR address@hidden@m ;
see
-.BR groff_mm (@MAN7EXT@).
+.IR groff_mm (@MAN7EXT@).
.
-.B groff
+.I groff
is executed twice, first with
.B \-z
and
.B \-rRef=1
to collect all cross references and then to do the real processing
-when the cross reference file is up to date.
+when the cross-reference file is up to date.
.
.
+.\" ====================================================================
+.SH OPTIONS
+.\" ====================================================================
+.
.TP
.B \-x
-Just create the cross reference file.
+Just create the cross-reference file.
.
-This can be used to refresh the cross reference file; it isn't
+This can be used to refresh the cross-reference file; it isn't
always needed to have accurate cross references and by using this
option
-.B groff
+.I groff
will only be run once.
.
.
.\" ====================================================================
-.\".SH BUGS
-.\" ====================================================================
-.
-.
-.\" ====================================================================
-.SH FILES
-.\" ====================================================================
-.
-.TP
-.B @MACRODIR@/@address@hidden
-.TP
-.B @TMAC_MDIR@/*.cov
-.TP
-.B @TMAC_MDIR@/*.MT
-.TP
-.B @TMAC_MDIR@/locale
-.
-.
-.\" ====================================================================
.SH AUTHORS
.\" ====================================================================
+.
.B mmroff
was written by
.MT address@hidden:axis.se
@@ -102,18 +88,17 @@ J
of Lund, Sweden.
.
.
-.na
.\" ====================================================================
.SH "SEE ALSO"
.\" ====================================================================
.
-.BR groff_mm (@MAN7EXT@),
-.BR groff_mmse (@MAN7EXT@),
-.BR groff (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@)
+.IR groff_mm (@MAN7EXT@),
+.IR groff_mmse (@MAN7EXT@),
+.IR groff (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@)
.
.
.\" Restore compatibility mode (for, e.g., Solaris 10/11).
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 09/20: mmroff(1): Make style fixes.,
G. Branden Robinson <=