[groff] 04/09: man pages: Regularize {-h,-v,--version} coverage.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 3e980bf836307857541cf58451fc5d0149f30441
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Aug 19 18:58:56 2020 +1000

    man pages: Regularize {-h,-v,--version} coverage.
    
    * src/devices/grodvi/grodvi.1.man:
    * src/devices/grolj4/grolj4.1.man:
    * src/devices/gropdf/gropdf.1.man:
    * src/devices/grops/grops.1.man:
    * src/devices/grotty/grotty.1.man:
    * src/preproc/eqn/eqn.1.man:
    * src/preproc/grn/grn.1.man:
    * src/preproc/pic/pic.1.man:
    * src/preproc/refer/refer.1.man:
    * src/preproc/soelim/soelim.1.man:
    * src/preproc/tbl/tbl.1.man:
    * src/roff/groff/groff.1.man:
    * src/roff/troff/troff.1.man:
    * src/utils/afmtodit/afmtodit.1.man:
    * src/utils/indxbib/indxbib.1.man:
    * src/utils/lkbib/lkbib.1.man:
    * src/utils/lookbib/lookbib.1.man:
    * src/utils/xtotroff/xtotroff.1.man: Replace sentence about optional
      whitespace (an implied, common practice in Unix command parsers) with
      a brief notice about the early-exiting options (--help, -v,
      --version).  Where tagged paragraphs for these options exist, drop
      them in favor of the foregoing summary.
    
      See edc510870925625e367d81af9ee6e2347013862f (March 2020).
    
    * src/preproc/pic/pic.1.man:
    * src/roff/groff/groff.1.man: Also drop langage explaining common Unix
      option conventions ('--' ends options parsing, '-' means standard
      input (or output, sometimes)).  These pages are not the place;
      intro(1) or intro(7) or similar are.
---
 src/devices/grodvi/grodvi.1.man   | 13 ++++++++-----
 src/devices/grolj4/grolj4.1.man   | 16 ++++++++--------
 src/devices/gropdf/gropdf.1.man   | 13 +++++--------
 src/devices/grops/grops.1.man     | 13 ++++++++-----
 src/devices/grotty/grotty.1.man   | 21 ++++++++-------------
 src/preproc/eqn/eqn.1.man         | 13 ++++++++-----
 src/preproc/grn/grn.1.man         | 15 ++++++++++-----
 src/preproc/pic/pic.1.man         | 21 ++++++++-------------
 src/preproc/refer/refer.1.man     | 14 ++++++++------
 src/preproc/soelim/soelim.1.man   | 13 ++++++++-----
 src/preproc/tbl/tbl.1.man         | 14 ++++++++++----
 src/roff/groff/groff.1.man        | 19 ++-----------------
 src/roff/troff/troff.1.man        |  6 ------
 src/utils/afmtodit/afmtodit.1.man |  3 ---
 src/utils/indxbib/indxbib.1.man   | 13 ++++++++-----
 src/utils/lkbib/lkbib.1.man       | 19 +++++++------------
 src/utils/lookbib/lookbib.1.man   | 19 +++++++------------
 src/utils/xtotroff/xtotroff.1.man | 19 +++++++------------
 18 files changed, 120 insertions(+), 144 deletions(-)

diff --git a/src/devices/grodvi/grodvi.1.man b/src/devices/grodvi/grodvi.1.man
index e43b775..5e04087 100644
--- a/src/devices/grodvi/grodvi.1.man
+++ b/src/devices/grodvi/grodvi.1.man
@@ -204,7 +204,14 @@ is output.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -246,10 +253,6 @@ command (see
 for details).
 .
 .TP
-.B \-v
-Print the version number.
-.
-.TP
 .BI \-w n
 Set the default line thickness to
 .I n
diff --git a/src/devices/grolj4/grolj4.1.man b/src/devices/grolj4/grolj4.1.man
index 2e2c260..fcb3f03 100644
--- a/src/devices/grolj4/grolj4.1.man
+++ b/src/devices/grolj4/grolj4.1.man
@@ -92,7 +92,14 @@ commands.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -125,13 +132,6 @@ letter, legal, executive, a4, com10, monarch, c5, b5, dl.
 .
 .
 .TP
-.B \-v
-.TQ
-.B \-\-version
-Print the version number.
-.
-.
-.TP
 .BI \-w " line-width"
 Set the default line thickness to
 .I line-width
diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man
index 65b3d86..f64234e 100644
--- a/src/devices/gropdf/gropdf.1.man
+++ b/src/devices/gropdf/gropdf.1.man
@@ -115,7 +115,11 @@ fonts for
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-v
+and
+.B \-\-version
+show version information;
+both exit afterward.
 .
 .
 .TP
@@ -206,13 +210,6 @@ You can include your own CMap by specifying a
 or have no CMap at all by omitting the argument.
 .
 .
-.TP
-.B \-v
-.TQ
-.B \-\-version
-Print the version number and exit.
-.
-.
 .\" .TP
 .\" .BI \-w n
 .\" Lines should be drawn using a thickness of
diff --git a/src/devices/grops/grops.1.man b/src/devices/grops/grops.1.man
index ba2a9a9..86196a0 100644
--- a/src/devices/grops/grops.1.man
+++ b/src/devices/grops/grops.1.man
@@ -130,7 +130,14 @@ fonts for
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -318,10 +325,6 @@ thousandths of an em.
 .
 If this option is not given, the line thickness defaults to 0.04\~em.
 .
-.TP
-.B \-v
-Print the version number.
-.
 .
 .\" ====================================================================
 .SH Usage
diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man
index f9ab35e..02ebda5 100644
--- a/src/devices/grotty/grotty.1.man
+++ b/src/devices/grotty/grotty.1.man
@@ -318,7 +318,14 @@ then it is treated as a bold font.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -464,18 +471,6 @@ Ignored if
 isn't used.
 .
 .
-.TP
-.B \-v
-.TQ
-.B \-\-version
-Display version information and exit.
-.
-.
-.TP
-.B \-\-help
-Display a brief usage message and exit.
-.
-.
 .\" ====================================================================
 .SH Environment
 .\" ====================================================================
diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index 77ce788..f72ef88 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -134,7 +134,14 @@ it does not support low-resolution, typewriter-like devices
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -170,10 +177,6 @@ This option allows
 to recover better from missing closing delimiters.
 .
 .TP
-.B \-v
-Print the version number.
-.
-.TP
 .B \-r
 Only one size reduction.
 .
diff --git a/src/preproc/grn/grn.1.man b/src/preproc/grn/grn.1.man
index 8370094..1e741c5 100644
--- a/src/preproc/grn/grn.1.man
+++ b/src/preproc/grn/grn.1.man
@@ -125,7 +125,16 @@ and
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-?
+and
+.B \-\-help
+display a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -187,10 +196,6 @@ even when followed by a character other than space or 
newline.
 .\"(such as PostScript) can still have text and graphics on a shaded
 .\"background.
 .
-.TP
-.B \-v
-Print the version number.
-.
 .
 .\" ====================================================================
 .SH "grn Commands"
diff --git a/src/preproc/pic/pic.1.man b/src/preproc/pic/pic.1.man
index 438ec80..2a9e684 100644
--- a/src/preproc/pic/pic.1.man
+++ b/src/preproc/pic/pic.1.man
@@ -129,16 +129,15 @@ These will center each picture.
 .SH Options
 .\" ====================================================================
 .
-Options that do not take arguments may be grouped behind a single
-.BR \- .
-.
-The special option
-.B \-\^\-
-can be used to mark the end of the options.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
-A filename of
-.B \-
-refers to the standard input.
 .
 .TP
 .B \-C
@@ -216,10 +215,6 @@ attribute or by setting the
 variable.
 .
 .TP
-.B \-v
-Print the version number.
-.
-.TP
 .B \-z
 In \*(tx mode draw dots using zero-length lines.
 .
diff --git a/src/preproc/refer/refer.1.man b/src/preproc/refer/refer.1.man
index 9b7103d..5103156 100644
--- a/src/preproc/refer/refer.1.man
+++ b/src/preproc/refer/refer.1.man
@@ -192,7 +192,14 @@ preprocessed by a command such as
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .LP
@@ -339,11 +346,6 @@ The following options have no equivalent commands:
 .
 .
 .TP
-.B \-v
-Print the version number.
-.
-.
-.TP
 .B \-R
 Don't recognize lines beginning with
 .BR .R1 / .R2 .
diff --git a/src/preproc/soelim/soelim.1.man b/src/preproc/soelim/soelim.1.man
index 43f9c99..811fc34 100644
--- a/src/preproc/soelim/soelim.1.man
+++ b/src/preproc/soelim/soelim.1.man
@@ -113,7 +113,14 @@ ignores it).
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -155,10 +162,6 @@ Don't emit
 requests but TeX comment lines (starting with \[oq]%\[cq]) giving the
 current file and line number.
 .
-.TP
-.B \-v
-Print the version number.
-.
 .
 .\" ====================================================================
 .SH Usage
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index d9241fc..4694b9f 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -1002,6 +1002,16 @@ therefore can't recognize the decimal point.
 .SH Options
 .\" ====================================================================
 .
+.B \-\-help
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
+.
+.
 .TP
 .B \-C
 Enable compatibility mode to
@@ -1013,10 +1023,6 @@ even when followed by a character other than space or 
newline.
 .
 Leader characters (\[rs]a) are handled as interpreted.
 .
-.TP
-.B \-v
-Display version information and exit.
-.
 .
 .\" ====================================================================
 .SH Bugs
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index d13e7ff..a35857e 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -128,16 +128,8 @@ uses pipes only).
 .SH Options
 .\" ====================================================================
 .
-The command line is parsed according to the usual \f[CR]GNU\f[]
-convention.
-.
-Whitespace is permitted between a command-line option and its argument.
-.
-Options can be grouped behind a single \[oq]\-\[cq] (minus character).
-.
-A filename of
-.B \-
-(minus character) denotes the standard input.
+.B \-\-help
+displays a usage message and exits.
 .
 .
 .P
@@ -203,13 +195,6 @@ Implies
 .
 .
 .TP
-.B \-h
-.TQ
-.B \-\-help
-Print a help message.
-.
-.
-.TP
 .BI \-I\  dir
 This option may be used to specify a directory to search for
 files (both those on the command line and those named in
diff --git a/src/roff/troff/troff.1.man b/src/roff/troff/troff.1.man
index 3fd30a4..58f1ddf 100644
--- a/src/roff/troff/troff.1.man
+++ b/src/roff/troff/troff.1.man
@@ -86,8 +86,6 @@ appropriate order and with the appropriate options.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
-.
 .
 .TP
 .B \-a
@@ -312,10 +310,6 @@ disabled otherwise.
 It will also add the current directory to the macro search path.
 .
 .TP
-.B \-v
-Print the version number.
-.
-.TP
 .BI \-w name
 Enable warning
 .IR  name .
diff --git a/src/utils/afmtodit/afmtodit.1.man 
b/src/utils/afmtodit/afmtodit.1.man
index 054cfa8..40e84fd 100644
--- a/src/utils/afmtodit/afmtodit.1.man
+++ b/src/utils/afmtodit/afmtodit.1.man
@@ -217,9 +217,6 @@ These parameters are normally needed only for italic (or 
oblique) fonts.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
-.
-.
 .TP
 .BI \-a n
 Use
diff --git a/src/utils/indxbib/indxbib.1.man b/src/utils/indxbib/indxbib.1.man
index 08e16d2..7f763e2 100644
--- a/src/utils/indxbib/indxbib.1.man
+++ b/src/utils/indxbib/indxbib.1.man
@@ -131,12 +131,15 @@ and will be used in verifying records found using the 
index.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
-.
-.
-.TP
+.B \-\-help
+displays a usage message,
+while
 .B \-v
-Print the version number.
+and
+.B \-\-version
+show version information;
+all exit afterward.
+.
 .
 .TP
 .B \-w
diff --git a/src/utils/lkbib/lkbib.1.man b/src/utils/lkbib/lkbib.1.man
index 50ff73d..07d013e 100644
--- a/src/utils/lkbib/lkbib.1.man
+++ b/src/utils/lkbib/lkbib.1.man
@@ -92,12 +92,14 @@ each index can cover multiple databases.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
-.
-.
-.TP
 .B \-\-help
-Display a usage message and exit.
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -128,13 +130,6 @@ Initially
 is\~6.
 .
 .
-.TP
-.B \-v
-.TQ
-.B \-\-version
-Display version information and exit.
-.
-.
 .\" ====================================================================
 .SH Environment
 .\" ====================================================================
diff --git a/src/utils/lookbib/lookbib.1.man b/src/utils/lookbib/lookbib.1.man
index 45fd547..f0c1477 100644
--- a/src/utils/lookbib/lookbib.1.man
+++ b/src/utils/lookbib/lookbib.1.man
@@ -84,12 +84,14 @@ each index can cover multiple databases.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
-.
-.
-.TP
 .B \-\-help
-Display a usage message and exit.
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -109,13 +111,6 @@ Initially
 is\~6.
 .
 .
-.TP
-.B \-v
-.TQ
-.B \-\-version
-Display version information and exit.
-.
-.
 .\" ====================================================================
 .SH Files
 .\" ====================================================================
diff --git a/src/utils/xtotroff/xtotroff.1.man 
b/src/utils/xtotroff/xtotroff.1.man
index 9f3802c..6323e66 100644
--- a/src/utils/xtotroff/xtotroff.1.man
+++ b/src/utils/xtotroff/xtotroff.1.man
@@ -98,12 +98,14 @@ aborts.
 .SH Options
 .\" ====================================================================
 .
-Whitespace is permitted between a command-line option and its argument.
-.
-.
-.TP
 .B \-\-help
-Display a usage message and exit.
+displays a usage message,
+while
+.B \-v
+and
+.B \-\-version
+show version information;
+all exit afterward.
 .
 .
 .TP
@@ -124,13 +126,6 @@ Set the point size for all font patterns in
 If not specified, a size of 10pt is assumed.
 .
 .
-.TP
-.B \-v
-.TQ
-.B \-\-version
-Display version information and exit.
-.
-.
 .\" ====================================================================
 .SH Bugs
 .\" ====================================================================