cli/insert: add --try-decrypt=(true|false)

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

diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index 9847e674688ed1cb23b95ef87ccc2efb89599268..e2bf37d04c79e49f6a8127bf36949a84470d2f86 100644 (file)
--- a/doc/man1/notmuch-insert.rst
+++ b/doc/man1/notmuch-insert.rst
@@ -50,6 +50,20 @@ Supported options for **insert** include
     ``--no-hooks``
         Prevent hooks from being run.
 
+    ``--try-decrypt=(true|false)``
+
+        If true and the message is encrypted, try to decrypt the
+        message while indexing.  If decryption is successful, index
+        the cleartext itself.  Either way, the message is always
+        stored to disk in its original form (ciphertext).  Be aware
+        that the index is likely sufficient to reconstruct the
+        cleartext of the message itself, so please ensure that the
+        notmuch message index is adequately protected. DO NOT USE
+        ``--try-decrypt=true`` without considering the security of
+        your index.
+
+        See also ``index.try_decrypt`` in **notmuch-config(1)**.
+
 EXIT STATUS
 ===========
 
@@ -65,7 +79,7 @@ errors most likely to be temporary in nature, e.g. failure to get a
 database write lock.
 
 ``75 (EX_TEMPFAIL)``
-    A temporary failure occured; the user is invited to retry.
+    A temporary failure occurred; the user is invited to retry.
 
 The exit status of the **post-insert** hook does not affect the exit
 status of the **insert** command.
@@ -73,7 +87,14 @@ status of the **insert** command.
 SEE ALSO
 ========
 
-**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
-**notmuch-dump(1)**, **notmuch-hooks(5)**, **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-reply(1)**,
+**notmuch-restore(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**