summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTim Culverhouse <tim@timculverhouse.com>2022-04-25 08:30:44 -0500
committerRobin Jarry <robin@jarry.cc>2022-04-27 09:46:25 +0200
commit57699b1fa6367a42d5877afcfdb1504e52835ed9 (patch)
treeb5000bfad3d62f01127f5831d64d27aac07872e1 /doc
parentd09636ee0b9957ed60fc01224ddfbb03c4f4b7fa (diff)
downloadaerc-57699b1fa6367a42d5877afcfdb1504e52835ed9.zip
feat: add gpg integration
This commit adds gpg system integration. This is done through two new packages: gpgbin, which handles the system calls and parsing; and gpg which is mostly a copy of emersion/go-pgpmail with modifications to interface with package gpgbin. gpg includes tests for many cases, and by it's nature also tests package gpgbin. I separated these in case an external dependency is ever used for the gpg sys-calls/parsing (IE we mirror how go-pgpmail+openpgp currently are dependencies) Two new config options are introduced: * pgp-provider. If it is not explicitly set to "gpg", aerc will default to it's internal pgp provider * pgp-key-id: (Optionally) specify a key by short or long keyId Signed-off-by: Tim Culverhouse <tim@timculverhouse.com> Acked-by: Koni Marti <koni.marti@gmail.com> Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-config.5.scd11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 7143cb6..6f5c50a 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -30,6 +30,13 @@ These options are configured in the *[general]* section of aerc.conf.
*default-save-path*
Used as a default path for save operations if no other path is specified.
+*pgp-provider*
+ If set to "gpg", aerc will use system gpg binary and keystore for all
+ crypto operations. Otherwise, the internal openpgp implemenation will be
+ used.
+
+ Default: internal
+
*unsafe-accounts-conf*
By default, the file permissions of accounts.conf must be restrictive
and only allow reading by the file owner (_0600_). Set this option to
@@ -579,6 +586,10 @@ Note that many of these configuration options are written for you, such as
Default: none
+*pgp-key-id*
+ Specify the key id to use when signing a message. Can be either short or
+ long key id. If unset, aerc will look up the key by email
+
*postpone*
Specifies the folder to save postponed messages to.