]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-new.rst
doc: unify definition list usage across man pages
[notmuch] / doc / man1 / notmuch-new.rst
index 7f0b2237acad24e66afd6b0843312723c3dbfdc6..16af5492ba2f6f3c6223ebd3de24c764f4cf97cd 100644 (file)
@@ -37,11 +37,27 @@ details on hooks.
 
 Supported options for **new** include
 
-    ``--no-hooks``
-        Prevents hooks from being run.
+``--no-hooks``
+    Prevents hooks from being run.
 
-    ``--quiet``
-        Do not print progress or results.
+``--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
 ===========
@@ -49,12 +65,20 @@ EXIT STATUS
 This command supports the following special exit status code
 
 ``75 (EX_TEMPFAIL)``
-    A temporary failure occured; the user is invited to retry.
+    A temporary failure occurred; the user is invited to retry.
 
 SEE ALSO
 ========
 
-**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
-**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
-**notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
-**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**
+**notmuch(1)**,
+**notmuch-config(1)**,
+**notmuch-count(1)**,
+**notmuch-dump(1)**,
+**notmuch-hooks(5)**,
+**notmuch-insert(1)**,
+**notmuch-reply(1)**,
+**notmuch-restore(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**