]> git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-reindex-1.mdwn
manpages updates for release 0.26
[notmuch-wiki] / manpages / notmuch-reindex-1.mdwn
1 <h1>NOTMUCH-REINDEX(1)</h1>
2
3 <h2>NAME</h2>
4 <pre>
5        notmuch-reindex - re-index matching messages
6 </pre>
7
8 <h2>SYNOPSIS</h2>
9 <pre>
10        <b>notmuch</b> <b>reindex</b> [<u>option</u> ...] &lt;<u>search-term</u>&gt; ...
11 </pre>
12
13 <h2>DESCRIPTION</h2>
14 <pre>
15        Re-index all messages matching the search terms.
16
17        See  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7)  for  details  of the supported syntax for
18        &lt;<u>search-term</u>&gt;.
19
20        The <b>reindex</b> command searches for all  messages  matching  the  supplied
21        search  terms,  and  re-creates  the  full-text index on these messages
22        using the supplied options.
23
24        Supported options for <b>reindex</b> include
25
26        <b>--decrypt=(true|nostash|auto|false)</b>
27               If <b>true</b>, when encountering an encrypted message, try to  decrypt
28               it  while  reindexing, stashing any session keys discovered.  If
29               <b>auto</b>, and notmuch already knows about a session key for the mes‐
30               sage, it will try decrypting using that session key but will not
31               try to access the user&apos;s secret keys.  If decryption is success‐
32               ful, index the cleartext itself.
33
34               <b>nostash</b>  is  the  same  as  <b>true</b>  except  that it will not stash
35               newly-discovered session keys in the database.
36
37               If <b>false</b>, notmuch reindex will also delete any  stashed  session
38               keys for all messages matching the search terms.
39
40               Be aware that the index is likely sufficient (and a stashed ses‐
41               sion key is certainly sufficient) to reconstruct  the  cleartext
42               of the message itself, so please ensure that the notmuch message
43               index is adequately protected.  DO  NOT  USE  <b>--decrypt=true</b>  or
44               <b>--decrypt=nostash</b>  without  considering  the  security  of  your
45               index.
46
47               See also <b>index.decrypt</b> in <a href='../notmuch-config-1/'>notmuch-config</a>(1).
48 </pre>
49
50 <h2>SEE ALSO</h2>
51 <pre>
52        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not‐</a>
53        <a href='../notmuch-hooks-5/'>much-hooks</a>(5),   <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
54        <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),  <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>not‐</a>
55        <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
56 </pre>
57
58 <h2>AUTHOR</h2>
59 <pre>
60        Carl Worth and many others
61 </pre>
62
63 <h2>COPYRIGHT</h2>
64 <pre>
65        2009-2018, Carl Worth and many others
66 </pre>
67
68 <h2>0.26</h2>