X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=doc%2Fman1%2Fnotmuch-reindex.rst;h=8b3083cf41e97535a4e397ba4677078b8e2c71ad;hb=fccebbaeef1e4b6489425afb13f419543d53d285;hp=e8174f3995f007025b71822a8a5b2307501edee7;hpb=6a9626a2fdddf6115bcf97982fd10053bf48e942;p=notmuch diff --git a/doc/man1/notmuch-reindex.rst b/doc/man1/notmuch-reindex.rst index e8174f39..8b3083cf 100644 --- a/doc/man1/notmuch-reindex.rst +++ b/doc/man1/notmuch-reindex.rst @@ -21,23 +21,27 @@ messages using the supplied options. Supported options for **reindex** include - ``--decrypt=(true|auto|false)`` + ``--decrypt=(true|nostash|auto|false)`` If ``true``, when encountering an encrypted message, try to - decrypt it while reindexing. 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. + decrypt it while reindexing, stashing 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. + + ``nostash`` is the same as ``true`` except that it will not + stash newly-discovered session keys in the database. 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 + Be aware that the index is likely sufficient (and a stashed + 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`` without considering the security of your - index. + ``--decrypt=true`` or ``--decrypt=nostash`` without + considering the security of your index. See also ``index.decrypt`` in **notmuch-config(1)**.