diff options
author | Tom Ryder <tom@sanctum.geek.nz> | 2014-05-26 14:49:20 +1200 |
---|---|---|
committer | Tom Ryder <tom@sanctum.geek.nz> | 2014-05-26 14:49:20 +1200 |
commit | c6dfbb695d13a6bbb41370f2fde960ef3108bbf0 (patch) | |
tree | 84a98b4ed4a52420914893a8d1b8c3f29426df9b | |
parent | Add copy of Artistic License (diff) | |
download | Mail-Run-Crypt-c6dfbb695d13a6bbb41370f2fde960ef3108bbf0.tar.gz Mail-Run-Crypt-c6dfbb695d13a6bbb41370f2fde960ef3108bbf0.zip |
Add man page
-rw-r--r-- | share/man/man1/croncrypt.1 | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/share/man/man1/croncrypt.1 b/share/man/man1/croncrypt.1 new file mode 100644 index 0000000..41ea87a --- /dev/null +++ b/share/man/man1/croncrypt.1 @@ -0,0 +1,27 @@ +.TH CRONCRYPT 1 "May 2014" "Manual page for croncrypt" +.SH NAME +.B croncrypt +\- sign and encrypt cron(8) output with PGP/MIME +.SH SYNOPSIS + $ crontab -l + CRONCRYPT_KEYID=0x0A1B2C3D4E5F6G7H + CRONCRYPT_PASSPHRASE=hibbityboo + MAILTO=me@mynet + 0 1 * * * croncrypt rsync /home/tom/important-file /home/backups +.SH DESCRIPTION +.B croncrypt +signs and encrypts cron(8) output and errors with PGP/MIME before emailing it +to the MAILTO address. +.PP +The main design goal is simplicity; just whack it in front of all your +crontab(5) entries, provided they don't use pipes or stderr/stdout redirects, +in which case you should consider putting it all into a script file anyway. +.PP +Don't use your own GPG key for signing! I recommend you create a dedicated key +just for Croncrypt, and sign it locally with gpg --lsign so that your software +trusts it locally. +.SH SEE ALSO +gpg(1), gpg-agent(1), Mail::GnuPG(3pm), MIME::Entity(3pm) +.SH AUTHOR +Tom Ryder <tom@sanctum.geek.nz> + |