X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-reindex.rst;h=477908713e89885f509c6ece7ec0ae15d5438cd5;hp=1ca10b6048f2d62fa1c77a1c8321e0bae305c203;hb=29648a137c5807135ab168917b4a51d5e19e51c2;hpb=6499fce3911df2646db67c0f1ff65672324904f0 diff --git a/doc/man1/notmuch-reindex.rst b/doc/man1/notmuch-reindex.rst index 1ca10b60..47790871 100644 --- a/doc/man1/notmuch-reindex.rst +++ b/doc/man1/notmuch-reindex.rst @@ -19,6 +19,28 @@ The **reindex** command searches for all messages matching the supplied search terms, and re-creates the full-text index on these messages using the supplied options. +Supported options for **reindex** include + + ``--decrypt=(true|auto|false)`` + + If ``true``, when encountering an encrypted message, try to + decrypt it while reindexing, storing any session keys + discovered. If ``auto``, and notmuch already knows about a + session key for the message, it will try decrypting using that + session key but will not try to access the user's secret keys. + If decryption is successful, index the cleartext itself. + + If ``false``, notmuch reindex will also delete any stashed + session keys for all messages matching the search terms. + + 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 + ``--decrypt=true`` without considering the security of your + index. + + See also ``index.decrypt`` in **notmuch-config(1)**. + SEE ALSO ========