[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 05/20: man pages: Make style fixes.
From: |
G. Branden Robinson |
Subject: |
[groff] 05/20: man pages: Make style fixes. |
Date: |
Fri, 9 Nov 2018 18:39:40 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 481e9ff0158c183fa4c1ad704e8376aefe03e69b
Author: G. Branden Robinson <address@hidden>
Date: Thu Nov 8 11:26:14 2018 -0500
man pages: Make style fixes.
* contrib/eqn2graph/eqn2graph.1.man:
* contrib/grap2graph/grap2graph.1.man:
* contrib/pic2graph/pic2graph.1.man:
+ Set command names in italics.
+ Set names of programming languages in roman.
+ Standardize description of --help and --version.
+ Set environment variable names in italics.
+ Unsuppress hyphenation when not needed.
+ Suppress hyphenation of "convert" when used as a command
name in See Also section (it already was on every other
mention).
+ Sort option descriptions in Options section in alphabetical
order.
* contrib/pic2graph/pic2graph.1.man:
+ Correct spelling of "delimiters".
+ In "See Also" section, move non-man page cross reference
before man page cross references.
Signed-off-by: G. Branden Robinson <address@hidden>
---
contrib/eqn2graph/eqn2graph.1.man | 40 +++++++-------
contrib/grap2graph/grap2graph.1.man | 66 +++++++++++------------
contrib/pic2graph/pic2graph.1.man | 102 +++++++++++++++++-------------------
3 files changed, 96 insertions(+), 112 deletions(-)
diff --git a/contrib/eqn2graph/eqn2graph.1.man
b/contrib/eqn2graph/eqn2graph.1.man
index 40b335c..8113227 100644
--- a/contrib/eqn2graph/eqn2graph.1.man
+++ b/contrib/eqn2graph/eqn2graph.1.man
@@ -36,21 +36,19 @@ eqn2graph \- convert an EQN equation into a cropped image
.
.I eqn2graph
reads a one-line
-.BR @address@hidden (@MAN1EXT@)
+.IR @address@hidden (@MAN1EXT@)
equation from the standard input and writes an image file,
by default in Portable Network Graphics (PNG) format,
to the standard output.
.
.
.PP
-The input
-.I EQN
-code should
+The input EQN code should
.I not
be preceded by the
.B \&.EQ
macro that normally precedes it within
-.BR groff (@MAN1EXT@)
+.IR groff (@MAN1EXT@)
macros;
nor do you need to have dollar-sign or other delimiters around the
equation.
@@ -66,7 +64,7 @@ equation.
Arguments not recognized by
.I eqn2graph
are passed to the ImageMagick or GraphicsMagick program
-.BR \%convert (1).
+.IR \%convert (1).
.
.
By specifying these, you can give your image a border,
@@ -78,7 +76,7 @@ or perform other useful transformations.
.
.PP
The output image is clipped using
-.IR convert 's
+.IR \%convert 's
.B \-trim
option to the smallest possible bounding box that contains all the black
pixels.
@@ -93,22 +91,20 @@ pixels.
Write the image in
.IR output-format ,
which must be understood by
-.IR convert ;
+.IR \%convert ;
the default is PNG.
.
.
.TP
.B \-\-help
-Display a brief usage message and exit.
+Display a usage message and exit.
.
.
.TP
.B \-v
.TQ
.B \-\-version
-Display
-.IR pic2graph 's
-version string and exit.
+Display version information and exit.
.
.
.\" ====================================================================
@@ -116,13 +112,13 @@ version string and exit.
.\" ====================================================================
.
.TP
-.B \%GROFF_TMPDIR
+.I \%GROFF_TMPDIR
.TQ
-.B \%TMPDIR
+.I \%TMPDIR
.TQ
-.B \%TMP
+.I TMP
.TQ
-.B \%TEMP
+.I TEMP
These environment variables are searched in the given order to determine
the directory where temporary files will be created.
.
@@ -141,7 +137,7 @@ was written by
Eric S.\& Raymond
.ME ,
based on a recipe for
-.BR pic2graph (@MAN1EXT@),
+.IR pic2graph (@MAN1EXT@),
by W.\& Richard Stevens.
.
.
@@ -149,11 +145,11 @@ by W.\& Richard Stevens.
.SH "SEE ALSO"
.\" ====================================================================
.
-.BR pic2graph (@MAN1EXT@),
-.BR grap2graph (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@),
-.BR groff (@MAN1EXT@),
-.BR convert (1)
+.IR pic2graph (@MAN1EXT@),
+.IR grap2graph (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@),
+.IR groff (@MAN1EXT@),
+.IR \%convert (1)
.
.
.\" Local Variables:
diff --git a/contrib/grap2graph/grap2graph.1.man
b/contrib/grap2graph/grap2graph.1.man
index 02ac9e1..f0a0c7f 100644
--- a/contrib/grap2graph/grap2graph.1.man
+++ b/contrib/grap2graph/grap2graph.1.man
@@ -37,23 +37,21 @@ grap2graph \- convert a GRAP diagram into a cropped image
.
.I grap2graph
reads a
-.BR grap (1)
+.IR grap (1)
program from the standard input and writes an image file,
by default in Portable Network Graphics (PNG) format,
to the standard output.
.
.
.PP
-The input
-.I GRAP
-code should
+The input GRAP code should
.I not
be wrapped with the
.B \&.G1
and
.B \&.G2
macros that normally guard it within
-.BR groff (@MAN1EXT@)
+.IR groff (@MAN1EXT@)
documents.
.
.
@@ -67,7 +65,7 @@ documents.
Arguments not recognized by
.I grap2graph
are passed to the ImageMagick or GraphicsMagick program
-.BR \%convert (1).
+.IR \%convert (1).
.
.
By specifying these, you can give your image a border,
@@ -79,7 +77,7 @@ or perform other useful transformations.
.
.PP
The output image is clipped using
-.IR convert 's
+.IR \%convert 's
.B \-trim
option to the smallest possible bounding box that contains all the black
pixels.
@@ -90,14 +88,26 @@ pixels.
.\" ====================================================================
.
.TP
+.BI "\-format " output-format
+Write the image in
+.IR output-format ,
+which must be understood by
+.IR \%convert ;
+the default is PNG.
+.
+.
+.TP
+.B \-\-help
+Display a usage message and exit.
+.
+.
+.TP
.B \-unsafe
Run
.I groff
in
.I unsafe
-mode, enabling the
-.I PIC
-command
+mode, enabling the PIC command
.B sh
to execute arbitrary Unix shell commands.
.
@@ -107,26 +117,10 @@ default is to forbid this.
.
.
.TP
-.BI "\-format " output-format
-Write the image in
-.IR output-format ,
-which must be understood by
-.IR convert ;
-the default is PNG.
-.
-.
-.TP
-.B \-\-help
-Display a brief usage message and exit.
-.
-.
-.TP
.B \-v
.TQ
.B \-\-version
-Display
-.IR grap2graph 's
-version string and exit.
+Display version information and exit.
.
.
.\" ====================================================================
@@ -138,9 +132,9 @@ version string and exit.
.TQ
.B \%TMPDIR
.TQ
-.B \%TMP
+.B TMP
.TQ
-.B \%TEMP
+.B TEMP
These environment variables are searched in the given order to determine
the directory where temporary files will be created.
.
@@ -159,7 +153,7 @@ was written by
Eric S.\& Raymond
.ME ,
based on a recipe for
-.BR pic2graph (@MAN1EXT@),
+.IR pic2graph (@MAN1EXT@),
by W.\& Richard Stevens.
.
.
@@ -167,12 +161,12 @@ by W.\& Richard Stevens.
.SH "SEE ALSO"
.\" ====================================================================
.
-.BR pic2graph (@MAN1EXT@),
-.BR eqn2graph (@MAN1EXT@),
-.BR grap (1),
-.BR @address@hidden (@MAN1EXT@),
-.BR groff (@MAN1EXT@),
-.BR convert (1)
+.IR pic2graph (@MAN1EXT@),
+.IR eqn2graph (@MAN1EXT@),
+.IR grap (1),
+.IR @address@hidden (@MAN1EXT@),
+.IR groff (@MAN1EXT@),
+.IR \%convert (1)
.
.
.\" Local Variables:
diff --git a/contrib/pic2graph/pic2graph.1.man
b/contrib/pic2graph/pic2graph.1.man
index a2e8635..a190627 100644
--- a/contrib/pic2graph/pic2graph.1.man
+++ b/contrib/pic2graph/pic2graph.1.man
@@ -38,28 +38,26 @@ pic2graph \- convert a PIC diagram into a cropped image
.
.I pic2graph
reads a
-.BR @address@hidden (@MAN1EXT@)
+.IR @address@hidden (@MAN1EXT@)
program from the standard input and writes an image file,
by default in Portable Network Graphics (PNG) format,
to the standard output.
.
It furthermore translates
-.BR @address@hidden (@MAN1EXT@)
+.IR @address@hidden (@MAN1EXT@)
constructs, so it can be used for generating images of mathematical
formulae.
.
.
.PP
-The input
-.I PIC
-code should
+The input PIC code should
.I not
be wrapped with the
.B \&.PS
and
.B \&.PE
macros that normally guard it within
-.BR groff (@MAN1EXT@)
+.IR groff (@MAN1EXT@)
documents.
.
.
@@ -73,7 +71,7 @@ documents.
Arguments not recognized by
.I pic2graph
are passed to the ImageMagick or GraphicsMagick program
-.BR \%convert (1).
+.IR \%convert (1).
.
.
By specifying these, you can give your image a border,
@@ -85,7 +83,7 @@ or perform other useful transformations.
.
.PP
The output image is clipped using
-.IR convert 's
+.IR \%convert 's
.B \-trim
option to the smallest possible bounding box that contains all the black
pixels.
@@ -96,35 +94,9 @@ pixels.
.\" ====================================================================
.
.TP
-.B \-unsafe
-Run
-.I groff
-in
-.I unsafe
-mode, enabling the
-.I PIC
-command
-.B sh
-to execute arbitrary Unix shell commands.
-.
-The
-.I groff
-default is to forbid this.
-.
-.
-.TP
-.BI "\-format " output-format
-Write the image in
-.IR output-format ,
-which must be understood by
-.IR convert ;
-the default is PNG.
-.
-.
-.TP
-.BI "\-eqn " delimeters
+.BI "\-eqn " delimiters
Use
-.I delimeters
+.I delimiters
as the opening and closing
characters that delimit
.I @address@hidden
@@ -132,7 +104,7 @@ directives;
the default is \(lq$$\(rq.
.
The option argument
-.I delimeters
+.I delimiters
should be a two-character string,
but an empty string (\(dq\(dq) is accepted as a directive to disable
.I @address@hidden
@@ -140,17 +112,39 @@ processing.
.
.
.TP
+.BI "\-format " output-format
+Write the image in
+.IR output-format ,
+which must be understood by
+.IR \%convert ;
+the default is PNG.
+.
+.
+.TP
.B \-\-help
-Display a brief usage message and exit.
+Display a usage message and exit.
+.
+.
+.TP
+.B \-unsafe
+Run
+.I groff
+in
+.I unsafe
+mode, enabling the PIC command
+.B sh
+to execute arbitrary Unix shell commands.
+.
+The
+.I groff
+default is to forbid this.
.
.
.TP
.B \-v
.TQ
.B \-\-version
-Display
-.IR pic2graph 's
-version string and exit.
+Display version information and exit.
.
.
.\" ====================================================================
@@ -158,13 +152,13 @@ version string and exit.
.\" ====================================================================
.
.TP
-.B \%GROFF_TMPDIR
+.I \%GROFF_TMPDIR
.TQ
-.B \%TMPDIR
+.I \%TMPDIR
.TQ
-.B \%TMP
+.I TMP
.TQ
-.B \%TEMP
+.I TEMP
These environment variables are searched in the given order to determine
the directory where temporary files will be created.
.
@@ -189,21 +183,21 @@ based on a recipe by W.\& Richard Stevens.
.SH "SEE ALSO"
.\" ====================================================================
.
-.BR eqn2graph (@MAN1EXT@),
-.BR grap2graph (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@),
-.BR @address@hidden (@MAN1EXT@),
-.BR groff (@MAN1EXT@),
-.BR \%convert (1)
-.
-.
-.PP
W.\& Richard Stevens,
.UR http://\:www.kohala.com/\:start/\:troff/\:pic2html.html
.I Turning PIC into HTML
.UE
.
.
+.PP
+.IR eqn2graph (@MAN1EXT@),
+.IR grap2graph (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@),
+.IR @address@hidden (@MAN1EXT@),
+.IR groff (@MAN1EXT@),
+.IR \%convert (1)
+.
+.
.\" Local Variables:
.\" mode: nroff
.\" End:
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 05/20: man pages: Make style fixes.,
G. Branden Robinson <=