git.notmuchmail.org Git - notmuch/blob - 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|nostash|auto|false)``
  25
  26         If ``true``, when encountering an encrypted message, try to
  27         decrypt it while reindexing, stashing any session keys
  28         discovered.  If ``auto``, and notmuch already knows about a
  29         session key for the message, it will try decrypting using that
  30         session key but will not try to access the user's secret keys.
  31         If decryption is successful, index the cleartext itself.
  32
  33         ``nostash`` is the same as ``true`` except that it will not
  34         stash newly-discovered session keys in the database.
  35
  36         If ``false``, notmuch reindex will also delete any stashed
  37         session keys for all messages matching the search terms.
  38
  39         Be aware that the index is likely sufficient (and a stashed
  40         session key is certainly sufficient) to reconstruct the
  41         cleartext of the message itself, so please ensure that the
  42         notmuch message index is adequately protected. DO NOT USE
  43         ``--decrypt=true`` or ``--decrypt=nostash`` without
  44         considering the security of your index.
  45
  46         See also ``index.decrypt`` in **notmuch-config(1)**.
  47
  48 SEE ALSO
  49 ========
  50
  51 **notmuch(1)**,
  52 **notmuch-config(1)**,
  53 **notmuch-count(1)**,
  54 **notmuch-dump(1)**,
  55 **notmuch-hooks(5)**,
  56 **notmuch-insert(1)**,
  57 **notmuch-new(1)**,
  58 **notmuch-reply(1)**,
  59 **notmuch-restore(1)**,
  60 **notmuch-search(1)**,
  61 **notmuch-search-terms(7)**,
  62 **notmuch-show(1)**,
  63 **notmuch-tag(1)**