cli/reindex: destroy stashed session keys when --decrypt=false
[notmuch] / doc / man1 / notmuch-reindex.rst
1 ===============
2 notmuch-reindex
3 ===============
4
5 SYNOPSIS
6 ========
7
8 **notmuch** **reindex** [*option* ...] <*search-term*> ...
9
10 DESCRIPTION
11 ===========
12
13 Re-index all messages matching the search terms.
14
15 See **notmuch-search-terms(7)** for details of the supported syntax for
16 <*search-term*\ >.
17
18 The **reindex** command searches for all messages matching the
19 supplied search terms, and re-creates the full-text index on these
20 messages using the supplied options.
21
22 Supported options for **reindex** include
23
24     ``--decrypt=(true|auto|false)``
25
26         If ``true``, when encountering an encrypted message, try to
27         decrypt it while reindexing.  If ``auto``, and notmuch already
28         knows about a session key for the message, it will try
29         decrypting using that session key but will not try to access
30         the user's secret keys.  If decryption is successful, index
31         the cleartext itself.
32
33         If ``false``, notmuch reindex will also delete any stashed
34         session keys for all messages matching the search terms.
35
36         Be aware that the index is likely sufficient to reconstruct
37         the cleartext of the message itself, so please ensure that the
38         notmuch message index is adequately protected. DO NOT USE
39         ``--decrypt=true`` without considering the security of your
40         index.
41
42         See also ``index.decrypt`` in **notmuch-config(1)**.
43
44 SEE ALSO
45 ========
46
47 **notmuch(1)**,
48 **notmuch-config(1)**,
49 **notmuch-count(1)**,
50 **notmuch-dump(1)**,
51 **notmuch-hooks(5)**,
52 **notmuch-insert(1)**,
53 **notmuch-new(1)**,
54 **notmuch-reply(1)**,
55 **notmuch-restore(1)**,
56 **notmuch-search(1)**,
57 **notmuch-search-terms(7)**,
58 **notmuch-show(1)**,
59 **notmuch-tag(1)**