yadm-dev#7 Document gpg-recipient

jeffwindsor · Apr 19, 2016 · 33c8cd8 · 33c8cd8
1 parent 34ae748
commit 33c8cd8
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/yadm.1 b/yadm.1
@@ -248,6 +248,12 @@ This feature is enabled by default.
 Disable the permission changes to
 .IR $HOME/.gnupg/* .
 This feature is enabled by default.
+.TP
+.B yadm.gpg-recipient
+Asymmetrically encrypt files with a gpg public/private key pair.
+Provide a key ID to encrypt against that public key.
+If left blank or not provided, symmetric encryption is used instead.
+This feature is disabled by deafult.
 .SH ALTERNATES
 When managing a set of files across different systems, it can be useful to have
 an automated way of choosing an alternate version of a file for a different

diff --git a/yadm.md b/yadm.md
@@ -150,6 +150,12 @@
               Disable the permission changes to $HOME/.gnupg/*.  This  feature
               is enabled by default.
 
+       yadm.gpg-recipient
+              Asymmetrically encrypt files with a gpg public/private key pair.
+              Provice a key ID to encrypt against that public key.
+              If left blank or not provided, symmetric encryption is used
+              instead. This feature is disabled by deafult.
+
 ## ALTERNATES
        When managing a set of files across different systems, it can be useful
        to have an automated way of choosing an alternate version of a file for