X-Git-Url: https://git.notmuchmail.org/git?p=notmuch-wiki;a=blobdiff_plain;f=manpages%2Fnotmuch-config-1.mdwn;h=c06a30795e6d9509e2e4decab0cb20cefcf52562;hp=037391026e52a433b9a1dd2e98a0adc657e67267;hb=7ab49d222b1bafd16ce17aa2a8f21648fb3ac8fd;hpb=2db88ae8b0f1f2cdfeb8cdd701de15c38a74c605 diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 0373910..c06a307 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -9,7 +9,7 @@ 
        notmuch config get <section>.<item>
 
-       notmuch config set <section>.<item> [value ...]
+       notmuch config set [--database] <section>.<item> [value ...]
 
        notmuch config list
@@ -19,10 +19,6 @@ The config command can be used to get or set settings in the notmuch 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 std‐ out. If the item has multiple values (it is a list), each value is separated by a newline character. @@ -34,6 +30,10 @@ If no values are provided, the specified configuration item will be removed from the configuration file. + With the --database option, updates configuration metadata + stored in the database, rather than the default (text) configu‐ + ration file. + list Every configuration item is printed to stdout, each on a sepa‐ rate line of the form: @@ -46,14 +46,26 @@ The available configuration items are described below. database.path - The top-level directory where your mail currently exists and to - where mail will be delivered in the future. Files should be - individual email messages. Notmuch will store its database - within a sub-directory of the path configured here named .not- - much. + Notmuch will store its database here, (in sub-directory named + .notmuch if database.mail_root is unset). Default: $MAILDIR variable if set, otherwise $HOME/mail. + database.mail_root + The top-level directory where your mail currently exists and to + where mail will be delivered in the future. Files should be in‐ + dividual email messages. + + History: this configuration value was introduced in notmuch + 0.32. + + Default: For compatibility with older configurations, the value + of database.path is used if database.mail_root is unset. + + database.hook_dir + Directory containing hooks run by notmuch commands. See not‐ + much-hooks(5). + user.name Your full name. @@ -90,16 +102,16 @@ A regular expression delimited with // that will be matched against the path of the file or directory relative to the data‐ base path. Matching files and directories will be ignored. The - beginning and end of string must be explicitly anchored. For - example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but + beginning and end of string must be explicitly anchored. For ex‐ + ample, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but not "foo" or "bar/foobar". Default: empty list. search.exclude_tags - A list of tags that will be excluded from search results by - default. Using an excluded tag in a query will override that - exclusion. + A list of tags that will be excluded from search results by de‐ + fault. Using an excluded tag in a query will override that ex‐ + clusion. Default: empty list. Note that notmuch-setup(1) puts deleted;spam here when creating new configuration file. @@ -136,7 +148,7 @@ Default: true. - index.decrypt [STORED IN DATABASE] + index.decrypt Policy for decrypting encrypted messages during indexing. Must be one of: false, auto, nostash, or true. @@ -152,12 +164,11 @@ 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= - option. + From the command line (i.e. during notmuch-new(1), notmuch-in‐ + sert(1), or notmuch-reindex(1)), the user can override the data‐ + base'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: ┌──────────────┬───────┬──────┬─────────┬──────┐ @@ -169,48 +180,48 @@ │sion keys │ │ │ │ │ ├──────────────┼───────┼──────┼─────────┼──────┤ │Index cleart‐ │ │ │ X │ X │ - │ext using │ │ │ │ │ - │secret keys │ │ │ │ │ + │ext using se‐ │ │ │ │ │ + │cret keys │ │ │ │ │ ├──────────────┼───────┼──────┼─────────┼──────┤ │Stash session │ │ │ │ X │ │keys ├──────────────┼───────┼──────┼─────────┼──────┤ │Delete │stashed ses‐ │ │ │ │ │ - │sion keys on │ │ │ │ │ + │sion keys on │ │ │ │ │ │reindex │ │ │ │ │ └──────────────┴───────┴──────┴─────────┴──────┘ - Stashed session keys are kept in the database as properties - associated with the message. See session-key in notmuch-proper‐ + Stashed session keys are kept in the database as properties as‐ + sociated 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 in- + dex.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‐ + index.header.<prefix> + 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 + 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 - "retry_lock" (configure option, included by default). (since - notmuch 0.30, "compact" and "field_processor" are always - included.) + "retry_lock" (configure option, included by default). (since + notmuch 0.30, "compact" and "field_processor" are always in‐ + cluded.) - query.<name> [STORED IN DATABASE] - Expansion for named query called <name>. See not‐ + query.<name> + Expansion for named query called <name>. See not‐ much-search-terms(7) for more information about named queries. @@ -220,9 +231,33 @@ of notmuch. NOTMUCH_CONFIG - Specifies the location of the notmuch configuration file. Not‐ - much will use ${HOME}/.notmuch-config if this variable is not - set. + Specifies the location of the notmuch configuration file. + + NOTMUCH_PROFILE + Selects among notmuch configurations. + + +

FILES

+ +

  CONFIGURATION

+
+       If NOTMUCH_CONFIG is unset, notmuch tries (in order)
+
+       • $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is  defined
+         by $NOTMUCH_PROFILE or "default"
+
+       • ${HOME}/.notmuch-config<profile> where <profile> is .$NOTMUCH_PROFILE
+         or ""
+
+ +

  Hooks

+
+       If database.hook_dir is unset, notmuch tries (in order)
+
+       • $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile>  is  defined
+         by $NOTMUCH_PROFILE or "default"
+
+       • <database.path>/.notmuch/hooks

SEE ALSO

@@ -240,7 +275,7 @@

COPYRIGHT

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

0.31

+

0.32