diff options
author | Patrick Totzke <patricktotzke@gmail.com> | 2013-06-02 20:48:40 +0100 |
---|---|---|
committer | Patrick Totzke <patricktotzke@gmail.com> | 2013-06-02 20:48:40 +0100 |
commit | d7d481aaab924db20112cd58f984bba6cd13298a (patch) | |
tree | 30a5c6ec73dcba844f51d6335688ff38b332a82e /docs/source/usage | |
parent | f84e34f5989313a715256327aa048f025b6a42be (diff) |
doc: move crypto docs to usage section
Diffstat (limited to 'docs/source/usage')
-rw-r--r-- | docs/source/usage/commands.rst | 3 | ||||
-rw-r--r-- | docs/source/usage/crypto.rst | 38 | ||||
-rw-r--r-- | docs/source/usage/index.rst | 12 |
3 files changed, 50 insertions, 3 deletions
diff --git a/docs/source/usage/commands.rst b/docs/source/usage/commands.rst index 6fa99b58..a3855b21 100644 --- a/docs/source/usage/commands.rst +++ b/docs/source/usage/commands.rst @@ -1,6 +1,3 @@ -Commands -======== - Alot interprets user input as command line strings given via its prompt or :ref:`bound to keys <config.key_bindings>` in the config. Command lines are semi-colon separated command strings, each of which diff --git a/docs/source/usage/crypto.rst b/docs/source/usage/crypto.rst new file mode 100644 index 00000000..b656078d --- /dev/null +++ b/docs/source/usage/crypto.rst @@ -0,0 +1,38 @@ +Alot has built in support for constructing signed and/or encrypted mails +according to PGP/MIME (:rfc:`3156`, :rfc:`3156`) via gnupg. +It does however rely on a running `gpg-agent` to handle password entries. + +.. note:: You need to have `gpg-agent` running to use GPG with alot! + + `gpg-agent` will handle passphrase entry in a secure and configurable way, and it will cache your + passphrase for some time so you don’t have to enter it over and over again. For details on how to + set this up we refer to `gnupg's manual <http://www.gnupg.org/documentation/manuals/gnupg/>`_. + +.. rubric:: Signing outgoing emails + +You can use the commands :ref:`sign <cmd.envelope.sign>`, +:ref:`unsign <cmd.envelope.unsign>` and +:ref:`togglesign <cmd.envelope.togglesign>` in envelope mode +to determine if you want this mail signed and if so, which key to use. +To specify the key to use you may pass a hint string as argument to +the `sign` or `togglesign` command. This hint would typically +be a fingerprint or an email address associated (by gnupg) with a key. + +Signing (and hence passwd entry) will be done at most once shortly before +a mail is sent. + +In case no key is specified, alot will leave the selection of a suitable key to gnupg +so you can influence that by setting the `default-key` option in :file:`~/.gnupg/gpg.conf` +accordingly. + +You can set the default to-sign bit and the key to use for each :ref:`account <config.accounts>` +individually using the options :ref:`sign_by_default <sign-by-default>` and :ref:`gpg_key <gpg-key>`. + +.. rubric:: Encrypt outgoing emails + +You can use the commands :ref:`encrypt <cmd.envelope.encrypt>`, +:ref:`unencrypt <cmd.envelope.unencrypt>` and +and :ref:`toggleencrypt <cmd.envelope.toggleencrypt>` and +in envelope mode to ask alot to encrypt the mail before sending. +The :ref:`encrypt <cmd.envelope.encrypt>` command accepts an optional +hint string as argument to determine the key of the recipient. diff --git a/docs/source/usage/index.rst b/docs/source/usage/index.rst index 224f831a..6520fb05 100644 --- a/docs/source/usage/index.rst +++ b/docs/source/usage/index.rst @@ -12,13 +12,25 @@ First Steps .. _usage.first_steps: .. include:: first_steps.rst + +Commands +======== + .. _usage.commands: .. include:: commands.rst + +Cryptography +============ + +.. _usage.crypto: +.. include:: crypto.rst + .. toctree:: :hidden: commands first_steps synopsis + crypto |