X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-reindex.rst;h=477908713e89885f509c6ece7ec0ae15d5438cd5;hp=e39cc4eebf1c420b9dc52a00692b6ce5e98d39c8;hb=29648a137c5807135ab168917b4a51d5e19e51c2;hpb=aa2abd2958f941caba6ffc8052dd00550f7e7e39 diff --git a/doc/man1/notmuch-reindex.rst b/doc/man1/notmuch-reindex.rst index e39cc4ee..47790871 100644 --- a/doc/man1/notmuch-reindex.rst +++ b/doc/man1/notmuch-reindex.rst @@ -19,11 +19,41 @@ 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 ======== -**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**, -**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**, +**notmuch(1)**, +**notmuch-config(1)**, +**notmuch-count(1)**, +**notmuch-dump(1)**, +**notmuch-hooks(5)**, +**notmuch-insert(1)**, **notmuch-new(1)**, -**notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**, -**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)** +**notmuch-reply(1)**, +**notmuch-restore(1)**, +**notmuch-search(1)**, +**notmuch-search-terms(7)**, +**notmuch-show(1)**, +**notmuch-tag(1)**