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

index 3dc1a46..7ddb274 100644 (file)
@@ -1496,6 +1496,7 @@ AC_CONFIG_FILES([
        src/pki/man/ipsec-pki.8
        src/pki/man/pki---gen.8
        src/pki/man/pki---issue.8
+       src/pki/man/pki---pkcs7.8
        src/pki/man/pki---req.8
        src/pki/man/pki---self.8
        src/pki/man/pki---signcrl.8
index 790656c..6c75693 100644 (file)
@@ -445,8 +445,8 @@ static void __attribute__ ((constructor))reg()
 {
        command_register((command_t) {
                pkcs7, '7', "pkcs7", "PKCS#7 wrap/unwrap functions",
-               {"--sign | --verify | --encrypt | --decrypt",
-                "--certificate+ [--key]"},
+               {"--sign|--verify|--encrypt|--decrypt|--show",
+                "[--in file] [--cert file]+ [--key file]"},
                {
                        {"help",        'h', 0, "show usage information"},
                        {"sign",        's', 0, "create PKCS#7 signed-data"},
@@ -455,8 +455,8 @@ static void __attribute__ ((constructor))reg()
                        {"decrypt",     'd', 0, "decrypt PKCS#7 enveloped-data"},
                        {"show",        'p', 0, "show info about PKCS#7, print certificates"},
                        {"in",          'i', 1, "input file, default: stdin"},
-                       {"key",         'k', 1, "path to private key for sign/decryp"},
-                       {"cert",        'c', 1, "path to certificate for sign/verify/encryp"},
+                       {"key",         'k', 1, "path to private key for sign/decrypt"},
+                       {"cert",        'c', 1, "path to certificate for sign/verify/encrypt"},
                }
        });
 }
index 1a7f621..e88230a 100644 (file)
@@ -4,6 +4,7 @@ man8_MANS = \
        pki---self.8 \
        pki---issue.8 \
        pki---signcrl.8 \
-       pki---req.8
+       pki---req.8 \
+       pki---pkcs7.8
 
 CLEANFILES = $(man8_MANS)
index 8f664bb..c41ea0b 100644 (file)
@@ -74,4 +74,5 @@ Verify a certificate using a CA certificate.
 .BR pki\ \-\-self (8),
 .BR pki\ \-\-issue (8),
 .BR pki\ \-\-signcrl (8),
-.BR pki\ \-\-req (8)
+.BR pki\ \-\-req (8),
+.BR pki\ \-\-pkcs7 (8)
diff --git a/src/pki/man/pki---pkcs7.8.in b/src/pki/man/pki---pkcs7.8.in
new file mode 100644 (file)
index 0000000..c500ca2
--- /dev/null
@@ -0,0 +1,79 @@
+.TH "PKI \-\-PKCS7" 8 "2013-07-31" "@PACKAGE_VERSION@" "strongSwan"
+.
+.SH "NAME"
+.
+pki \-\-pkcs7 \- Provides PKCS#7 wrap/unwrap functions
+.
+.SH "SYNOPSIS"
+.
+.SY pki\ \-\-pkcs7
+.BR \-\-sign | \-\-verify | \-\-encrypt | \-\-decrypt | \-\-show
+.OP \-\-in file
+.OP \-\-cert file
+.OP \-\-key file
+.OP \-\-debug level
+.YS
+.
+.SY pki\ \-\-pkcs7
+.BI \-\-options\~ file
+.YS
+.
+.SY "pki \-\-pkcs7"
+.B \-h
+|
+.B \-\-help
+.YS
+.
+.SH "DESCRIPTION"
+.
+This sub-command of
+.BR ipsec\-pki (8)
+provides functions to wrap/unwrap PKCS#7 containers.
+.
+.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 "\-s, \-\-sign"
+Create PKCS#7 signed-data.
+.TP
+.BI "\-u, \-\-verify"
+Verify PKCS#7 signed-data.
+.TP
+.BI "\-e, \-\-encrypt"
+Create PKCS#7 enveloped-data.
+.TP
+.BI "\-e, \-\-decrypt"
+Decrypt PKCS#7 enveloped-data.
+.TP
+.BI "\-p, \-\-show"
+Show information about PKCS#7 container, list certificates.
+.TP
+.BI "\-i, \-\-in " file
+PKCS#7 input file. If not given the input is read from \fISTDIN\fR.
+.TP
+.BI "\-k, \-\-key " file
+Private key used for
+.B \-\-sign
+and
+.BR \-\-decrypt.
+.TP
+.BI "\-c, \-\-cert " file
+Certificate for
+.BR \-\-sign ,
+.B \-\-verify
+and
+.BR \-\-encrypt.
+Can be used multiple times.
+.
+.SH "SEE ALSO"
+.
+.BR ipsec\-pki (8)
\ No newline at end of file