crypto: add --decrypt=nostash to avoid stashing session keys

[notmuch] / doc / man1 / notmuch-new.rst

diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst
index 14bc5da4a655b832a3a5bc97a1706f94476df5f2..3ddd4621a3806c87bc2d54f2391033a6aeb04c92 100644 (file)
--- a/doc/man1/notmuch-new.rst
+++ b/doc/man1/notmuch-new.rst
@@ -43,6 +43,24 @@ Supported options for **new** include
     ``--quiet``
         Do not print progress or results.
 
+    ``--decrypt=(true|nostash|auto|false)``
+
+        If ``true``, when encountering an encrypted message, try to
+        decrypt it while indexing, and stash any discovered session
+        keys.  If ``auto``, try to use any session key already known
+        to belong to this message, but do not attempt to use the
+        user's secret keys.  If decryption is successful, index the
+        cleartext of the message.
+
+        Be aware that the index is likely sufficient (and the session
+        key is certainly sufficient) to reconstruct the cleartext of
+        the message itself, so please ensure that the notmuch message
+        index is adequately protected.  DO NOT USE ``--decrypt=true``
+        or ``--decrypt=nostash`` without considering the security of
+        your index.
+
+        See also ``index.decrypt`` in **notmuch-config(1)**.
+
 EXIT STATUS
 ===========