Add -h option to keyanalyze, and update manpage. (Closes: #370570)

[pgp-tools.git] / keyanalyze / keyanalyze.1

diff --git a/keyanalyze/keyanalyze.1 b/keyanalyze/keyanalyze.1
index c162b2811fafe25d8fca70efa569114829bc4184..d2fdba208dfc7aaf9d31902636bc6d382bdeffb1 100644 (file)
--- a/keyanalyze/keyanalyze.1
+++ b/keyanalyze/keyanalyze.1
@@ -12,7 +12,7 @@
 keyanalyze \- Web of Trust analysis
 
 .SH SYNTAX
-\fBkeyanalyze\fP [ \fB\-i\fP \fIinfile\fP ] [ \fB\-o\fP \fIoutdir\fP ] [ \fB\-1\fP ]
+\fBkeyanalyze\fP [ \fB\-h1\fP ] [ \fB\-i\fP \fIinfile\fP ] [ \fB\-o\fP \fIoutdir\fP ]
 
 .SH DESCRIPTION
 \fIkeyanalyze\fP analyses the web of trust within a group of keys.  It
@@ -20,6 +20,10 @@ takes preprocessed keys as input (see
 .BR process_keys (1))
 and produces an output directory full of statistics about the keys.
 
+Usually called like
+ $ pgpring -S -k ./keyring.gpg | process_keys > preprocess.keys
+ $ keyanalyze
+
 .SH OPTIONS
 .TP
 .BI \-i " infile"
@@ -29,6 +33,9 @@ Read from \fIinfile\fP instead of \fBpreprocess.keys\fP.
 Put the results in \fIoutdir\fP instead of \fBoutput/\fP.  The directory
 will be created if it does not already exist.
 .TP
+.BI \-h
+Print help.
+.TP
 .BI \-1
 Per default, \fBkeyanalyze\fP writes the output into subdirectories named after
 the first two characters of the key ID. This options disables this; useful for