X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-config.rst;h=dabf269f141c38b996a4be424262d47ec0c17dc6;hp=5a517ebda95ac290a06f11783f38df73f45a37b2;hb=29648a137c5807135ab168917b4a51d5e19e51c2;hpb=07dff496304d6dc2e8033a18691b095ed9cd212f diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 5a517ebd..dabf269f 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -15,7 +15,11 @@ DESCRIPTION =========== The **config** command can be used to get or set settings in the notmuch -configuration file. +configuration file and corresponding database. + +Items marked **[STORED IN DATABASE]** are only in the database. They +should not be placed in the configuration file, and should be accessed +programmatically as described in the SYNOPSIS above. **get** The value of the specified configuration item is printed to @@ -128,18 +132,41 @@ The available configuration items are described below. **crypto.gpg_path** Name (or full path) of gpg binary to use in verification and - decryption of PGP/MIME messages. - + decryption of PGP/MIME messages. NOTE: This configuration + item is deprecated, and will be ignored if notmuch is built + against GMime 3.0 or later. + Default: ``gpg``. + **index.decrypt** + + **[STORED IN DATABASE]** + When indexing an encrypted e-mail message, if this variable is + set to ``true``, notmuch will try to decrypt the message and + index the cleartext, stashing a copy of any discovered session + keys for the message. If ``auto``, it will try to index the + cleartext if a stashed session key is already known for the message + (e.g. from a previous copy), but will not try to access your + secret keys. Use ``false`` to avoid decrypting even when a + stashed session key is already present. + + Be aware that the notmuch 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 ``index.decrypt=true`` without considering the + security of your index. + + Default: ``auto``. + **built_with.** - Compile time feature . Current possibilities include - "compact" (see **notmuch-compact(1)**) - and "field_processor" (see **notmuch-search-terms(7)**). + Compile time feature . Current possibilities include + "compact" (see **notmuch-compact(1)**) + and "field_processor" (see **notmuch-search-terms(7)**). **query.** + **[STORED IN DATABASE]** Expansion for named query called . See **notmuch-search-terms(7)** for more information about named queries. @@ -157,7 +184,15 @@ of notmuch. SEE ALSO ======== -**notmuch(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)** +**notmuch(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)**