aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-10-14 14:37:01 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-10-14 14:39:56 +1300
commit79dd92c2eefe13b064f81e9622e12228e586d616 (patch)
treea9a35bba08d548cb8ecfb710e97cb40985bbc1fc /README.markdown
parentBump version number (diff)
downloadMail-Run-Crypt-79dd92c2eefe13b064f81e9622e12228e586d616.tar.gz
Mail-Run-Crypt-79dd92c2eefe13b064f81e9622e12228e586d616.zip
Documentation corrections
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown23
1 files changed, 12 insertions, 11 deletions
diff --git a/README.markdown b/README.markdown
index 913196f..04deccc 100644
--- a/README.markdown
+++ b/README.markdown
@@ -53,29 +53,30 @@ Constructor method; accepts the following named parameters:
The recipient email address for the content. This is always required.
-- `sign`
-
- Whether to sign the command output. This defaults to 0. A `keyid` and
- `passphrase` will be required for signing.
-
- `encrypt`
Whether to encrypt the command output. This defaults to 1.
-- `keyid`
+- `sign`
- The GnuPG key ID that should be used to encrypt the messages. This is required
- for signing. It can be any means of identifying the key acceptable to GnuPG;
- the key's 16-byte ("long") hexadecimal ID prefixed with `0x` is probably the
- best way.
+ Whether to sign the command output. This defaults to 0. A `keyid` and
+ `passphrase` will be required for signing.
It is _strongly_ recommended that a dedicated key and passphrase be used for
signatures if this is needed. You should carefully consider the consequences of
a compromised key.
+- `keyid`
+
+ The GnuPG key ID that should be used to sign messages. This is required for
+ signing, and has no effect without `sign`. It can be any means of identifying
+ the key acceptable to GnuPG; the key's 16-byte ("long") hexadecimal ID prefixed
+ with `0x` is probably the best way.
+
- `passphrase`
- The passphrase used to decrypt the key. This is required for signing.
+ The passphrase used to decrypt the key. This is required for signing, and has
+ no effect without `sign`.
- `name`