pki: Add ipsec-pki(8) man page
authorTobias Brunner <tobias@strongswan.org>
Wed, 31 Jul 2013 16:05:10 +0000 (18:05 +0200)
committerTobias Brunner <tobias@strongswan.org>
Fri, 13 Sep 2013 12:32:51 +0000 (14:32 +0200)
Can be opened either with "man ipsec pki" or "man ipsec-pki".

Since man(1) only supports one level of subpages, the forthcoming man
pages for each command will have to be opened with "man pki --<command>".

configure.ac
src/pki/Makefile.am
src/pki/man/.gitignore [new file with mode: 0644]
src/pki/man/Makefile.am [new file with mode: 0644]
src/pki/man/ipsec-pki.8.in [new file with mode: 0644]

index 768cb87..196137a 100644 (file)
@@ -1471,6 +1471,7 @@ AC_CONFIG_FILES([
        src/openac/Makefile
        src/scepclient/Makefile
        src/pki/Makefile
+       src/pki/man/Makefile
        src/dumm/Makefile
        src/dumm/ext/extconf.rb
        src/libfast/Makefile
@@ -1492,6 +1493,7 @@ AC_CONFIG_FILES([
        man/ipsec.secrets.5
        man/strongswan.conf.5
        src/charon-cmd/charon-cmd.8
+       src/pki/man/ipsec-pki.8
 ])
 
 AC_OUTPUT
index e079382..7835152 100644 (file)
@@ -1,3 +1,5 @@
+SUBDIRS = man
+
 ipsec_PROGRAMS = pki
 
 pki_SOURCES = pki.c pki.h command.c command.h \
diff --git a/src/pki/man/.gitignore b/src/pki/man/.gitignore
new file mode 100644 (file)
index 0000000..44b27a6
--- /dev/null
@@ -0,0 +1 @@
+*.8
\ No newline at end of file
diff --git a/src/pki/man/Makefile.am b/src/pki/man/Makefile.am
new file mode 100644 (file)
index 0000000..ba4aac8
--- /dev/null
@@ -0,0 +1,4 @@
+man8_MANS = \
+       ipsec-pki.8
+
+CLEANFILES = $(man8_MANS)
diff --git a/src/pki/man/ipsec-pki.8.in b/src/pki/man/ipsec-pki.8.in
new file mode 100644 (file)
index 0000000..1f81f68
--- /dev/null
@@ -0,0 +1,72 @@
+.TH IPSEC\-PKI 8 "2013-07-30" "@PACKAGE_VERSION@" "strongSwan"
+.
+.SH "NAME"
+.
+ipsec pki \- Simple public key infrastructure (PKI) management tool
+.
+.SH "SYNOPSIS"
+.
+.SY "ipsec pki"
+.I command
+.RI [ option\~ .\|.\|.]
+.YS
+.
+.SY "ipsec pki"
+.B \-h
+|
+.B \-\-help
+.YS
+.
+.SH "DESCRIPTION"
+.
+.B ipsec pki
+is a suite of commands that allow you to manage a simple public key
+infrastructure (PKI).
+.P
+Generate RSA and ECDSA key pairs, create PKCS#10 certificate requests
+containing subjectAltNames, create X.509 self-signed end-entity and root CA
+certificates, issue end-entity and intermediate CA certificates signed by the
+private key of a CA and containing subjectAltNames, CRL distribution points
+and URIs of OCSP servers. You can also extract raw public keys from private
+keys, certificate requests and certificates and compute two kinds of SHA-1-based
+key IDs.
+.
+.SH "COMMANDS"
+.
+.TP
+.B "\-h, \-\-help"
+Prints usage information and a short summary of the available commands.
+.TP
+.B "\-g, \-\-gen"
+Generate a new private key.
+.TP
+.B "\-s, \-\-self"
+Create a self-signed certificate.
+.TP
+.B "\-i, \-\-issue"
+Issue a certificate using a CA certificate and key.
+.TP
+.B "\-c, \-\-signcrl"
+Issue a CRL using a CA certificate and key.
+.TP
+.B "\-r, \-\-req"
+Create a PKCS#10 certificate request.
+.TP
+.B "\-7, \-\-pkcs7"
+Provides PKCS#7 wrap/unwrap functions.
+.TP
+.B "\-k, \-\-keyid"
+Calculate key identifiers of a key or certificate.
+.TP
+.B "\-a, \-\-print"
+Print a credential (key, certificate etc.) in human readable form.
+.TP
+.B "\-p, \-\-pub"
+Extract a public key from a private key or certificate.
+.TP
+.B "\-v, \-\-verify"
+Verify a certificate using a CA certificate.
+.
+.SH "SEE ALSO"
+.
+.BR ipsec (8)