X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=blobdiff_plain;f=manpages%2Fnotmuch-config-1.mdwn;h=6ffaba62603c51b4cd846b594db3d82dce846d06;hp=c06a30795e6d9509e2e4decab0cb20cefcf52562;hb=85fe2a1e7df8ccbb172ebf5f10e3cf574a08944a;hpb=82a6b98a10839f24d79526eb2fed8ddb1f87eb14 diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index c06a307..6ffaba6 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -43,28 +43,50 @@ acters. In a multiple-value item (a list), the values are sepa‐ rated by semicolon characters. - The available configuration items are described below. + The available configuration items are described below. Non-absolute + paths are presumed relative to $HOME for items in section database. database.path - Notmuch will store its database here, (in sub-directory named + 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. + Default: see DATABASE LOCATION 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‐ + 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 + History: this configuration value was introduced in notmuch 0.32. - Default: For compatibility with older configurations, the value + Default: For compatibility with older configurations, the value of database.path is used if database.mail_root is unset. + database.backup_dir + Directory to store tag dumps when upgrading database. + + History: this configuration value was introduced in notmuch + 0.32. + + Default: A sibling directory of the Xapian database called back‐ + ups. + database.hook_dir - Directory containing hooks run by notmuch commands. See not‐ - much-hooks(5). + Directory containing hooks run by notmuch commands. See not‐ + much-hooks(5). + + History: this configuration value was introduced in notmuch + 0.32. + + Default: See HOOKS, below. + + database.autocommit + How often to commit transactions to disk. 0 means wait until command + completes, otherwise an integer n specifies to commit to disk after + every n completed transactions. + + History: this configuration value was introduced in notmuch 0.33. user.name Your full name. @@ -90,8 +112,8 @@ new.ignore A list to specify files and directories that will not be - searched for messages by notmuch new. Each entry in the list is - either: + searched for messages by notmuch-new(1). Each entry in the list + is either: A file or a directory name, without path, that will be ignored, regardless of the location in the mail store directory hierar‐ @@ -135,16 +157,16 @@ │ │ flag is not present) │ └─────┴────────────────────────────┘ - The notmuch new command will notice flag changes in filenames - and update tags, while the notmuch tag and notmuch restore com‐ - mands will notice tag changes and update flags in filenames. + The notmuch-new(1) command will notice flag changes in filenames + and update tags, while the notmuch-tag(1) and notmuch-restore(1) + commands will notice tag changes and update flags in filenames. If there have been any changes in the maildir (new messages added, old ones removed or renamed, maildir flags changed, - etc.), it is advisable to run notmuch new before notmuch tag or - notmuch restore commands to ensure the tag changes are properly - synchronized to the maildir flags, as the commands expect the - database and maildir to be in sync. + etc.), it is advisable to run notmuch-new(1) before not‐ + much-tag(1) or notmuch-restore(1) commands to ensure the tag + changes are properly synchronized to the maildir flags, as the + commands expect the database and maildir to be in sync. Default: true. @@ -173,7 +195,8 @@ ┌──────────────┬───────┬──────┬─────────┬──────┐ │ │ false │ auto │ nostash │ true │ - ├──────────────┼───────┼──────┼─────────┼──────┤ + └──────────────┴───────┴──────┴─────────┴──────┘ + │Index cleart‐ │ │ X │ X │ X │ │ext using │ │ │ │ │ │stashed ses‐ │ │ │ │ │ @@ -225,47 +248,61 @@ much-search-terms(7) for more information about named queries. -

ENVIRONMENT

+

FILES

+ +

  CONFIGURATION

-       The following environment variables can be used to control the behavior
-       of notmuch.
+       Notmuch configuration file search order:
 
-       NOTMUCH_CONFIG
-              Specifies the location of the notmuch configuration file.
+       1. File specified by notmuch --config global option; see notmuch(1).
 
-       NOTMUCH_PROFILE
-              Selects among notmuch configurations.
-
+ 2. File specified by NOTMUCH_CONFIG environment variable. -

FILES

+ 3. $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is defined + by NOTMUCH_PROFILE environment variable if set, $XDG_CON- + FIG_HOME/notmuch/default/config otherwise. -

  CONFIGURATION

+ 4. $HOME/.notmuch-config.<profile> where <profile> is defined by NOT- + MUCH_PROFILE environment variable if set, $HOME/.notmuch-config oth‐ + erwise. + + +

  DATABASE LOCATION

-       If NOTMUCH_CONFIG is unset, notmuch tries (in order)
+       Notmuch database search order:
+
+       1. Directory specified by NOTMUCH_DATABASE environment variable.
 
-       • $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is  defined
-         by $NOTMUCH_PROFILE or "default"
+       2. Directory specified by config key database.path.
 
-       • ${HOME}/.notmuch-config<profile> where <profile> is .$NOTMUCH_PROFILE
-         or ""
+       3. $XDG_DATA_HOME/notmuch/<profile>  where <profile> is defined by NOT-
+          MUCH_PROFILE environment variable if set, $XDG_DATA_HOME/notmuch/de-
+          fault otherwise.
+
+       4. Directory specified by MAILDIR environment variable.
+
+       5. $HOME/mail
-

  Hooks

+

  HOOKS

-       If database.hook_dir is unset, notmuch tries (in order)
+       Notmuch hook directory search order:
+
+       1. Directory specified by database.hook_dir configuration option.
 
-       • $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile>  is  defined
-         by $NOTMUCH_PROFILE or "default"
+       2. $XDG_CONFIG_HOME/notmuch/<profile>/hooks  where <profile> is defined
+          by  NOTMUCH_PROFILE   environment   variable   if   set,   $XDG_CON-
+          FIG_HOME/notmuch/default/hooks otherwise.
 
-       • <database.path>/.notmuch/hooks
+       3. <database.path>/.notmuch/hooks

SEE ALSO

        notmuch(1),  notmuch-count(1),  notmuch-dump(1), notmuch-hooks(5), not‐
-       much-insert(1), notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
-       notmuch-search(1), notmuch-search-terms(7), notmuch-properties(7), not‐
-       much-show(1), notmuch-tag(1)
+       much-insert(1),  notmuch-new(1),   notmuch-properties(7),   notmuch-re‐
+       ply(1), notmuch-restore(1), notmuch-search(1), notmuch-search-terms(7),
+       notmuch-show(1), notmuch-tag(1)

AUTHOR

@@ -278,4 +315,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33