aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
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.