cli/reindex: add --try-decrypt=(true|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     ``--try-decrypt=(true|false)``
25
26         If true, when encountering an encrypted message, try to
27         decrypt it while reindexing.  If decryption is successful,
28         index the cleartext itself.  Be aware that the index is likely
29         sufficient to reconstruct the cleartext of the message itself,
30         so please ensure that the notmuch message index is adequately
31         protected. DO NOT USE ``--try-decrypt=true`` without
32         considering the security of your index.
33
34         See also ``index.try_decrypt`` in **notmuch-config(1)**.
35
36 SEE ALSO
37 ========
38
39 **notmuch(1)**,
40 **notmuch-config(1)**,
41 **notmuch-count(1)**,
42 **notmuch-dump(1)**,
43 **notmuch-hooks(5)**,
44 **notmuch-insert(1)**,
45 **notmuch-new(1)**,
46 **notmuch-reply(1)**,
47 **notmuch-restore(1)**,
48 **notmuch-search(1)**,
49 **notmuch-search-terms(7)**,
50 **notmuch-show(1)**,
51 **notmuch-tag(1)**