notmuch/doc/man1/notmuch-reindex.rst
Daniel Kahn Gillmor 181d4091c4 cli/new, insert, reindex: update documentation for --decrypt=auto
we also include --decrypt=auto in the tab completion.
2017-12-08 08:08:46 -04:00

56 lines
1.5 KiB
ReStructuredText

===============
notmuch-reindex
===============
SYNOPSIS
========
**notmuch** **reindex** [*option* ...] <*search-term*> ...
DESCRIPTION
===========
Re-index all messages matching the search terms.
See **notmuch-search-terms(7)** for details of the supported syntax for
<*search-term*\ >.
The **reindex** command searches for all messages matching the
supplied search terms, and re-creates the full-text index on these
messages using the supplied options.
Supported options for **reindex** include
``--decrypt=(true|auto|false)``
If ``true``, when encountering an encrypted message, try to
decrypt it while reindexing. If ``auto``, and notmuch already
knows about a session key for the message, it will try
decrypting using that session key but will not try to access
the user's secret keys. If decryption is successful, index
the cleartext itself.
Be aware that the index is likely sufficient to reconstruct
the cleartext of the message itself, so please ensure that the
notmuch message index is adequately protected. DO NOT USE
``--decrypt=true`` without considering the security of your
index.
See also ``index.decrypt`` in **notmuch-config(1)**.
SEE ALSO
========
**notmuch(1)**,
**notmuch-config(1)**,
**notmuch-count(1)**,
**notmuch-dump(1)**,
**notmuch-hooks(5)**,
**notmuch-insert(1)**,
**notmuch-new(1)**,
**notmuch-reply(1)**,
**notmuch-restore(1)**,
**notmuch-search(1)**,
**notmuch-search-terms(7)**,
**notmuch-show(1)**,
**notmuch-tag(1)**