[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 07/07: pdfmom(1): Make minor style fixes.
From: |
G. Branden Robinson |
Subject: |
[groff] 07/07: pdfmom(1): Make minor style fixes. |
Date: |
Tue, 26 Jun 2018 08:25:08 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 07fed5897899f8acfd3f33b3d3ae62ce4eff4c78
Author: G. Branden Robinson <address@hidden>
Date: Sat Jun 23 11:12:52 2018 -0400
pdfmom(1): Make minor style fixes.
* Don't capitalize the summary like a sentence.
* Tweak summary to refer to groff and to mom as a macro "package"
instead of a "set".
* Make the synopsis agree with DESCRIPTION. -Tpdf is the default mode,
so list it first. It also does not accept pdfroff options.
* Document existence and purpose of -v option.
* Recast "stdout" to "the standard output".
* Consistently put 2 empty requests between paragraphs.
Signed-off-by: G. Branden Robinson <address@hidden>
---
src/devices/gropdf/pdfmom.1.man | 37 ++++++++++++++++++++++++++++---------
1 file changed, 28 insertions(+), 9 deletions(-)
diff --git a/src/devices/gropdf/pdfmom.1.man b/src/devices/gropdf/pdfmom.1.man
index 9df4ca8..16818f8 100644
--- a/src/devices/gropdf/pdfmom.1.man
+++ b/src/devices/gropdf/pdfmom.1.man
@@ -1,6 +1,6 @@
.TH PDFMOM @MAN1EXT@ "@MDATE@" "groff @VERSION@"
.SH NAME
-pdfmom \- Produce PDF documents using the mom macro set
+pdfmom \- produce PDF documents using the mom macro package for groff
.
.
.\" ====================================================================
@@ -30,15 +30,22 @@ pdfmom \- Produce PDF documents using the mom macro set
.\" ====================================================================
.
.SY pdfmom
-.OP \-Tps "\fR[pdfroff options]"
-[groff options]
-.I files .\|.\|.
+.OP \-Tpdf
+.RI [ groff-options ]
+.I file
+\&.\|.\|.\&
.YS
.
.SY pdfmom
-.OP \-Tpdf
-[groff options]
-.I files .\|.\|.
+.B \-Tps
+.RI [ pdfroff-options ]
+.RI [ groff-options ]
+.I file
+\&.\|.\|.\&
+.YS
+.
+.SY pdfmom
+.B \-v
.YS
.
.
@@ -55,8 +62,9 @@ formatted with the mom macros.
.
.P
.B pdfmom
-prints to stdout, so output must be redirected to a destination
-file. The size of the final PDF can be reduced by piping the output
+prints to the standard output,
+so output must usually be redirected to a destination file.
+The size of the final PDF can be reduced by piping the output
through
.BR ps2pdf .
.
@@ -97,6 +105,7 @@ calls
.BR pdfroff ,
the
.
+.
.P
.RS
.B \-mpdfmark \-mom \-\-no-toc
@@ -123,6 +132,14 @@ macros is discussed in full in the PDF manual,
.IR "Producing PDFs with groff and mom" .
.
.
+.P
+If called with the
+.B \-v
+option,
+.B pdfmom
+simply prints its version information and exits.
+.
+.
.\" ====================================================================
.SH BUGS
.\" ====================================================================
@@ -130,12 +147,14 @@ macros is discussed in full in the PDF manual,
.B pdfmom
sometimes issues warnings of the type
.
+.
.P
.RS 2
\&.\|.\|.:
.B can't transparently output node at top level
.RE
.
+.
.P
This is more of an annoyance than a bug, and may safely be ignored.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 07/07: pdfmom(1): Make minor style fixes.,
G. Branden Robinson <=