X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-config.rst;h=dabf269f141c38b996a4be424262d47ec0c17dc6;hp=712945546f3e5c6924fbdfb0ca0ae98c8126ba6c;hb=29648a137c5807135ab168917b4a51d5e19e51c2;hpb=6499fce3911df2646db67c0f1ff65672324904f0 diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 71294554..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 @@ -134,6 +138,26 @@ The available configuration items are described below. 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 @@ -142,6 +166,7 @@ The available configuration items are described below. **query.** + **[STORED IN DATABASE]** Expansion for named query called . See **notmuch-search-terms(7)** for more information about named queries.