summaryrefslogtreecommitdiff
path: root/crypt-expiry-check.1.in
diff options
context:
space:
mode:
authorErich Eckner <git@eckner.net>2016-05-24 09:02:08 +0200
committerErich Eckner <git@eckner.net>2016-05-24 09:02:08 +0200
commitcdf206e0b13dc4835c6efa943dd5f8651d94e06c (patch)
treea1fd6b30a516bf0db8c17127102a8a79c691ff06 /crypt-expiry-check.1.in
parent039b13835e8b571237dbd4611059a3d50fe0a0d7 (diff)
downloadcrypt-expiry-check-cdf206e0b13dc4835c6efa943dd5f8651d94e06c.tar.xz
manpage .1 -> .8
Diffstat (limited to 'crypt-expiry-check.1.in')
-rw-r--r--crypt-expiry-check.1.in73
1 files changed, 73 insertions, 0 deletions
diff --git a/crypt-expiry-check.1.in b/crypt-expiry-check.1.in
new file mode 100644
index 0000000..216f7ba
--- /dev/null
+++ b/crypt-expiry-check.1.in
@@ -0,0 +1,73 @@
+.TH crypt-expiry-check 8 "" "crypt-expiry-check #VERSION#" ""
+.SH NAME
+crypt-expiry-check \- check expiry of gpg-keys and X.509 certificates
+.SH SYNOPSIS
+\fBcrypt-expiry-check [options]\fP
+.SH DESCRIPTION
+\fBcrypt-expiry-check\fP checks expiration of gpg keys and X.509 certificates and sends emails if keys are about to expire.
+.SH OPTIONS
+.TP
+.B "\-a"
+send a warning message through e-mail
+.TP
+.B "\-b"
+will not print header
+.TP
+.B "\-c cert file"
+print the expiration date for the PEM or PKCS12 formatted certificate in cert file
+.TP
+.B "\-e e\-mail address"
+e-mail address to send expiration notices to
+.TP
+.B "\-f cert file"
+file with a list of (FQDN;port)s, gpg keys and certificate files to check
+.TP
+.B "\-g e\-mail address"
+e-mail address to check expiry of gpg-key of
+.TP
+.B "\-h"
+print this screen
+.TP
+.B "\-i"
+print the issuer of the certificate
+.TP
+.B "\-k password"
+PKCS12 file password
+.TP
+.B "\-n"
+run as a Nagios plugin
+.TP
+.B "\-s commmon_name:port"
+server and port to connect to (interactive mode)
+.TP
+.B "\-t type"
+specify the certificate type
+.TP
+.B "\-q"
+don't print anything on the console
+.TP
+.B "\-v"
+specify a specific protocol version to use (tls, ssl2, ssl3)
+.TP
+.B "\-V"
+only print validation data
+.TP
+.B "\-x days"
+certificate expiration interval (eg. if cert_date < days)
+.SH FILES
+.TP
+.B "#BINDIR#/crypt-expiry-check"
+program file
+.TP
+.B "#ETCDIR#/crypt-expiry.checks"
+contains keys to surveil
+.TP
+.B "#CRONDIR#/crypt-expiry-check.cron"
+cronfile to initiate daily checks
+.SH CONTRIBUTION
+Heavily based on \fBssl-cert-check\fP from \fBMatty < matty91 at gmail dot com >\fP.
+The original source can be found here: \fBhttp://prefetch.net/code/ssl-cert-check\fP
+.SH AUTHOR
+.nf
+Erich Eckner <opensource at eckner dot net>
+.fi