X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-config-1.mdwn;h=9d502a3a3776d155ac41d0187a347adf2cfa1889;hb=0568dc66970180cbda48af10d27c49fb1a36805e;hp=3e8cca4bce479891b61942ee5acf6859a7d3efcf;hpb=ed52cd4055a160d4264b71aebe9e4276298da29e;p=notmuch-wiki diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 3e8cca4..9d502a3 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -37,7 +37,7 @@ list Every configuration item is printed to stdout, each on a sepa‐ rate line of the form: - *section*.\ *item*\ =\ *value* + section.item=value No additional whitespace surrounds the dot or equals sign char‐ acters. In a multiple-value item (a list), the values are sepa‐ @@ -136,36 +136,28 @@ Default: true. - crypto.gpg_path - Name (or full path) of gpg binary to use in verification and - 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] - Policy for decrypting encrypted messages during indexing. Must + Policy for decrypting encrypted messages during indexing. Must be one of: false, auto, nostash, or true. - 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 + 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 + 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. - nostash is the same as true except that it will not stash + nostash is the same as true except that it will not stash newly-discovered session keys in the database. - From the command line (i.e. during notmuch-new(1), not‐ - much-insert(1), or notmuch-reindex(1)), the user can override - the database's stored decryption policy with the --decrypt= + From the command line (i.e. during notmuch-new(1), not‐ + much-insert(1), or notmuch-reindex(1)), the user can override + the database's stored decryption policy with the --decrypt= option. - Here is a table that summarizes the functionality of each of + Here is a table that summarizes the functionality of each of these policies: ┌──────────────┬───────┬──────┬─────────┬──────┐ @@ -181,31 +173,41 @@ │secret keys │ │ │ │ │ ├──────────────┼───────┼──────┼─────────┼──────┤ │Stash session │ │ │ │ X │ - │keys │ │ │ │ │ + │keys ├──────────────┼───────┼──────┼─────────┼──────┤ - │Delete │ │ │ │ │ + │Delete │stashed ses‐ │ │ │ │ │ - │sion keys on │ │ │ │ │ + │sion keys on │ │ │ │ │ │reindex │ │ │ │ │ └──────────────┴───────┴──────┴─────────┴──────┘ - Stashed session keys are kept in the database as properties + Stashed session keys are kept in the database as properties associated with the message. See session-key in notmuch-proper‐ ties(7) for more details about how they can be useful. - Be aware that the notmuch index is likely sufficient (and a - stashed session key is certainly sufficient) to reconstruct the - cleartext of the message itself, so please ensure that the not‐ - much message index is adequately protected. DO NOT USE - index.decrypt=true or index.decrypt=nostash without considering + Be aware that the notmuch index is likely sufficient (and a + stashed session key is certainly sufficient) to reconstruct the + cleartext of the message itself, so please ensure that the not‐ + much message index is adequately protected. DO NOT USE + index.decrypt=true or index.decrypt=nostash without considering the security of your index. Default: auto. + index.header.<prefix> [STORED IN DATABASE] + Define the query prefix <prefix>, based on a mail header. For + example index.header.List=List-Id will add a probabilistic pre‐ + fix List: that searches the List-Id field. User defined pre‐ + fixes must not start with 'a'...'z'; in particular adding a pre‐ + fix with same name as a predefined prefix is not supported. See + notmuch-search-terms(7) for a list of existing prefixes, and an + explanation of probabilistic prefixes. + built_with.<name> - Compile time feature <name>. Current possibilities include "com‐ - pact" (see notmuch-compact(1)) and "field_processor" (see not‐ - much-search-terms(7)). + Compile time feature <name>. Current possibilities include + "retry_lock" (configure option, included by default). (since + notmuch 0.30, "compact" and "field_processor" are always + included.) query.<name> [STORED IN DATABASE] Expansion for named query called <name>. See not‐ @@ -238,7 +240,7 @@

COPYRIGHT

-       2009-2018, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.28

+

0.30