From: markus schnalke <meillo@marmaro.de>
Date: Fri, 29 Jul 2016 09:42:59 +0000 (+0200)
Subject: mhsign/mhpgp: Clarify the manpages and usage lines
X-Git-Tag: mmh-0.3~23
X-Git-Url: http://git.marmaro.de/?p=mmh;a=commitdiff_plain;h=370cd86e50f3348d7ee0cc4a265764d002b15cdc

mhsign/mhpgp: Clarify the manpages and usage lines

These tools are shell scripts and thus have a different option
processing mechanism than the other mmh tools. Unfortunately, it
is limited: Options must come first.

Also note that mhpgp accepts a +folder argument, and what the
defaults are.
---

diff --git a/man/mhpgp.man1 b/man/mhpgp.man1
index 7d5af3b..afc0c10 100644
--- a/man/mhpgp.man1
+++ b/man/mhpgp.man1
@@ -9,9 +9,10 @@ mhpgp \- check PGP signatures and decrypt PGP messages using gnupg
 .na
 .B mhpgp
 .RB [ \-write ]
-.RI [ msg ]
 .RB [ \-Version ]
 .RB [ \-help ]
+.RI [ +folder ]
+.RI [ msg ]
 .ad
 .SH DESCRIPTION
 .B mhpgp
@@ -54,10 +55,14 @@ None
 mhsign(1), gpg(1)
 
 .SH DEFAULTS
-None
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msg "' defaults to the current message"
+.fi
 
 .SH CONTEXT
 None
 
 .SH BUGS
-None
+The order of the command line arguments is relevant: The options
+must come first, the message specification last.
diff --git a/man/mhsign.man1 b/man/mhsign.man1
index 585dcfd..85c80b1 100644
--- a/man/mhsign.man1
+++ b/man/mhsign.man1
@@ -10,9 +10,9 @@ mhsign \- sign or encrypt a message with gnupg
 .B mhsign
 .RB [ \-encrypt ]
 .RB [ \-mime ]
-.I file
 .RB [ \-Version ]
 .RB [ \-help ]
+.I file
 .ad
 .SH DESCRIPTION
 .B mhsign
@@ -101,4 +101,5 @@ None
 None
 
 .SH BUGS
-None
+The order of the command line arguments is relevant: Options must
+come first, the file must be last.
diff --git a/uip/mhpgp.sh b/uip/mhpgp.sh
index 4929358..ce4d2c8 100755
--- a/uip/mhpgp.sh
+++ b/uip/mhpgp.sh
@@ -6,7 +6,7 @@
 # mhpgp:
 #   -write:  Save the decrypted message to the current folder
 
-usage="Usage: mhpgp [-write] msg"
+usage="Usage: mhpgp [-write] [-Version] [-help] [+folder] [msg]"
 
 # prepend the default options from the profile
 set -- `mhparam -nocomp ${0##*/}` "$@"
diff --git a/uip/mhsign.sh b/uip/mhsign.sh
index 94c19f9..f28c0fe 100755
--- a/uip/mhsign.sh
+++ b/uip/mhsign.sh
@@ -9,7 +9,7 @@
 #              will be removed and any "From " line will be indented for
 #              best compatibility. Enforced for multipart messages.
 
-usage="Usage: mhsign [-encrypt] [-mime] file"
+usage="Usage: mhsign [-encrypt] [-mime] [-Version] [-help] file"
 
 # defaults
 usemime=n