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