[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 04/05: chem(1): Standardize options documentation.
From: |
G. Branden Robinson |
Subject: |
[groff] 04/05: chem(1): Standardize options documentation. |
Date: |
Sun, 11 Nov 2018 11:15:06 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 92e41e2be5f9594a21b5472e22ba6d8df6245cd0
Author: G. Branden Robinson <address@hidden>
Date: Sun Nov 11 10:07:41 2018 -0500
chem(1): Standardize options documentation.
Dave <barx> via Savannah noted some bad grammar in the option
documentation of chem(1).
* contrib/chem/chem.1.man: Rewrite options documentation to
conform with old conventions (like actually having an Options
section) and newer ones (like standardized descriptions of
help and version options, the only ones chem supports).
Fixes rest of <https://savannah.gnu.org/bugs/index.php?54959>.
Signed-off-by: G. Branden Robinson <address@hidden>
---
contrib/chem/chem.1.man | 56 ++++++++++++++++++++++++++-----------------------
1 file changed, 30 insertions(+), 26 deletions(-)
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index 4f10f28..4102a70 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -105,32 +105,6 @@
.
.
.\" ====================================================================
-.SH OPTION USAGE
-.\" ====================================================================
-.
-There are no other options than
-.BR \-h ,
-.BR \-\-help ,
-.BR \-v ,
-and
-.BR \%\-\-version ;
-these options provoke the printing of a version or usage information,
-respectively, and all
-.I filespec
-arguments are ignored.
-.
-A
-.I filespec
-argument is either a file name of an existing file or a minus
-character
-.BR \- ,
-meaning standard input.
-.
-If no argument is specified then standard input is taken
-automatically.
-.
-.
-.\" ====================================================================
.SH DESCRIPTION
.\" ====================================================================
.
@@ -159,6 +133,18 @@ language.
.
.
.P
+A
+.I filespec
+argument is either a file name of an existing file or a minus
+character
+.BR \- ,
+meaning standard input.
+.
+If no argument is specified then standard input is taken
+automatically.
+.
+.
+.P
The program
.B @address@hidden
originates from the Perl source file
@@ -883,6 +869,24 @@ A squiggle bond is needed.
.
.
.\" ====================================================================
+.SH OPTIONS
+.\" ====================================================================
+.
+.TP
+.B \-h
+.TQ
+.B \-\-help
+Display a usage message and exit.
+.
+.
+.TP
+.B \-v
+.TQ
+.B \-\-version
+Display version information and exit.
+.
+.
+.\" ====================================================================
.SH "FILES"
.\" ====================================================================
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 04/05: chem(1): Standardize options documentation.,
G. Branden Robinson <=