pki: Add pki --verify man page
authorTobias Brunner <tobias@strongswan.org>
Mon, 12 Aug 2013 15:52:28 +0000 (17:52 +0200)
committerTobias Brunner <tobias@strongswan.org>
Fri, 13 Sep 2013 13:07:36 +0000 (15:07 +0200)
configure.ac
src/pki/commands/verify.c
src/pki/man/Makefile.am
src/pki/man/ipsec-pki.8.in
src/pki/man/pki---verify.8.in [new file with mode: 0644]

index beca13c..9b5a818 100644 (file)
@@ -1503,6 +1503,7 @@ AC_CONFIG_FILES([
        src/pki/man/pki---req.8
        src/pki/man/pki---self.8
        src/pki/man/pki---signcrl.8
+       src/pki/man/pki---verify.8
 ])
 
 AC_OUTPUT
index 3e983d3..11c596d 100644 (file)
@@ -125,7 +125,7 @@ static void __attribute__ ((constructor))reg()
        command_register((command_t) {
                verify, 'v', "verify",
                "verify a certificate using the CA certificate",
-               {"[--in file] [--ca file]"},
+               {"[--in file] [--cacert file]"},
                {
                        {"help",        'h', 0, "show usage information"},
                        {"in",          'i', 1, "X.509 certificate to verify, default: stdin"},
@@ -133,4 +133,3 @@ static void __attribute__ ((constructor))reg()
                }
        });
 }
-
index a4c092b..769f052 100644 (file)
@@ -8,6 +8,7 @@ man8_MANS = \
        pki---pkcs7.8 \
        pki---keyid.8 \
        pki---print.8 \
-       pki---pub.8
+       pki---pub.8 \
+       pki---verify.8
 
 CLEANFILES = $(man8_MANS)
index cea88a3..787a350 100644 (file)
@@ -78,4 +78,5 @@ Verify a certificate using a CA certificate.
 .BR pki\ \-\-pkcs7 (8),
 .BR pki\ \-\-keyid (8),
 .BR pki\ \-\-print (8),
-.BR pki\ \-\-pub (8)
+.BR pki\ \-\-pub (8),
+.BR pki\ \-\-verify (8)
diff --git a/src/pki/man/pki---verify.8.in b/src/pki/man/pki---verify.8.in
new file mode 100644 (file)
index 0000000..39c46e6
--- /dev/null
@@ -0,0 +1,56 @@
+.TH "PKI \-\-VERIFY" 8 "2013-07-31" "@PACKAGE_VERSION@" "strongSwan"
+.
+.SH "NAME"
+.
+pki \-\-verify \- Verify a certificate using a CA certificate
+.
+.SH "SYNOPSIS"
+.
+.SY pki\ \-\-verify
+.OP \-\-in file
+.OP \-\-cacert file
+.OP \-\-debug level
+.YS
+.
+.SY pki\ \-\-verify
+.BI \-\-options\~ file
+.YS
+.
+.SY "pki \-\-verify"
+.B \-h
+|
+.B \-\-help
+.YS
+.
+.SH "DESCRIPTION"
+.
+This sub-command of
+.BR ipsec\-pki (8)
+verifies a certificate using an optional CA certificate.
+.
+.SH "OPTIONS"
+.
+.TP
+.B "\-h, \-\-help"
+Print usage information with a summary of the available options.
+.TP
+.BI "\-v, \-\-debug " level
+Set debug level, default: 1.
+.TP
+.BI "\-+, \-\-options " file
+Read command line options from \fIfile\fR.
+.TP
+.BI "\-i, \-\-in " file
+X.509 certificate to verify. If not given it is read from \fISTDIN\fR.
+.TP
+.BI "\-c, \-\-cacert " file
+CA certificate to use. If not given the certificate is assumed to be
+self-signed.
+.
+.SH "EXIT STATUS"
+The exit status is 0 if the certificate was verified successfully, and 2 if
+the verification failed.
+.
+.SH "SEE ALSO"
+.
+.BR ipsec\-pki (8)
\ No newline at end of file