aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-10-14 01:34:05 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-10-14 01:35:15 +1300
commit4eb2531aab1abae8c34f41ca44ec1caf6469ea83 (patch)
tree020e6e3a5044ce457cf4c0ef2424e50cfd944780 /README.markdown
parentSpecify reason for Perl 5.10 (diff)
downloadMail-Run-Crypt-4eb2531aab1abae8c34f41ca44ec1caf6469ea83.tar.gz
Mail-Run-Crypt-4eb2531aab1abae8c34f41ca44ec1caf6469ea83.zip
Add sign/encrypt options
Default signing to off; step 1 to mitigating the terrible literal passphrase passing.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 926aa02..269b19a 100644
--- a/README.markdown
+++ b/README.markdown
@@ -40,6 +40,15 @@ via environment variables or command-line options.
Constructor accepts the following named parameters:
+- `sign`
+
+ Whether to sign the command output. This defaults to off. A key ID and
+ passphrase will be required for signing.
+
+- `encrypt`
+
+ Whether to encrypt the command output. This defaults to on.
+
- `keyid`
The GnuPG key ID that should be used to encrypt the messages.