X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-config-1.mdwn;h=a8c8ccde10dbab7d5dfbefe3804e50285238b3a0;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=6fb6325d24d52181813d06395f500608fb083723;hpb=01b1bc7553d0b0ebf35ac3016c83240b4151ad59;p=notmuch-wiki
diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn
index 6fb6325..a8c8ccd 100644
--- a/manpages/notmuch-config-1.mdwn
+++ b/manpages/notmuch-config-1.mdwn
@@ -1,167 +1,332 @@
NOTMUCH-CONFIG(1)
NAME
-
- notmuch-config - Access notmuch configuration file.
+ notmuch-config - access notmuch configuration file
SYNOPSIS
-
- notmuch config get <section>.<item>
-
+ notmuch config get <section>.<item>
-
- notmuch config set <section>.<item> [value ...]
-
+ notmuch config set [--database] <section>.<item> [value ...]
-
notmuch config list
DESCRIPTION
-
The config command can be used to get or set settings in the notmuch
- configuration file.
-
+ configuration file and corresponding database.
-
- get The value of the specified configuration item is printed to
- stdout. If the item has multiple values (it is a list), each
- value is separated by a newline character.
-
+ 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.
-
- set The specified configuration item is set to the given value. To
- specify a multiple-value item (a list), provide each value as a
- separate command-line argument.
-
+ set The specified configuration item is set to the given value. To
+ specify a multiple-value item (a list), provide each value as a
+ separate command-line argument.
-
- If no values are provided, the specified configuration item
- will be removed from the configuration file.
-
+ If no values are provided, the specified configuration item will
+ be removed from the configuration file.
-
- list
- Every configuration item is printed to stdout, each on a sepa-
- rate line of the form:
-
+ With the --database option, updates configuration metadata
+ stored in the database, rather than the default (text) configuâ
+ ration file.
-
- section.item=value
-
+ list Every configuration item is printed to stdout, each on a sepaâ
+ rate line of the form:
-
- No additional whitespace surrounds the dot or equals sign char-
- acters. In a multiple-value item (a list), the values are sepa-
- rated by semicolon characters.
-
+ section.item=value
-
- The available configuration items are described below.
-
+ No additional whitespace surrounds the dot or equals sign charâ
+ acters. In a multiple-value item (a list), the values are sepaâ
+ rated by semicolon characters.
-
- 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.
-
+ The available configuration items are described below. Non-absolute
+ paths are presumed relative to $HOME for items in section database.
-
- user.name
- Your full name.
-
+ database.path
+ Notmuch will store its database here, (in sub-directory named
+ .notmuch if database.mail_root is unset).
-
- user.primary_email
- Your primary email address.
-
+ Default: see DATABASE LOCATION
-
- user.other_email
- A list of other email addresses at which you receive email.
-
+ 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.
-
- new.tags
- A list of tags that will be added to all messages incorporated
- by notmuch new.
-
+ History: this configuration value was introduced in notmuch
+ 0.32.
-
- new.ignore
- A list of file and directory names, without path, that will not
- be searched for messages by notmuch new. All the files and
- directories matching any of the names specified here will be
- ignored, regardless of the location in the mail store directory
- hierarchy.
-
+ Default: For compatibility with older configurations, the value
+ of database.path is used if database.mail_root is unset.
-
- 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.
-
+ database.backup_dir
+ Directory to store tag dumps when upgrading database.
-
- maildir.synchronize_flags
- If true, then the following maildir flags (in message file-
- names) will be synchronized with the corresponding notmuch
- tags:
+ 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).
+
+ 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.
+
+ Default: $NAME variable if set, otherwise read from /etc/passwd.
+
+ user.primary_email
+ Your primary email address.
+
+ Default: $EMAIL variable if set, otherwise constructed from the
+ username and hostname of the current machine.
+
+ user.other_email
+ A list of other email addresses at which you receive email.
+
+ Default: not set.
+
+ new.tags
+ A list of tags that will be added to all messages incorporated
+ by notmuch new.
+
+ Default: unread;inbox.
+
+ new.ignore
+ A list to specify files and directories that will not be
+ 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â
+ chy.
+
+ Or:
+
+ 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 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 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.
+
+ show.extra_headers
+ By default notmuch-show(1) includes the following headers in strucâ
+ tured output if they are present in the message: Subject, From, To,
+ Cc, Bcc, Reply-To, Date. This option allows the specification of a
+ list of further headers to output.
+
+ History: This configuration value was introduced in notmuch 0.35.
+
+ Default: empty list.
+
+ maildir.synchronize_flags
+ If true, then the following maildir flags (in message filenames)
+ will be synchronized with the corresponding notmuch tags:
+
+ âââââââ¬âââââââââââââââââââââââââââââ
+ âFlag â Tag â
+ âââââââ¼âââââââââââââââââââââââââââââ¤
+ âD â draft â
+ âââââââ¼âââââââââââââââââââââââââââââ¤
+ âF â flagged â
+ âââââââ¼âââââââââââââââââââââââââââââ¤
+ âP â passed â
+ âââââââ¼âââââââââââââââââââââââââââââ¤
+ âR â replied â
+ âââââââ¼âââââââââââââââââââââââââââââ¤
+ âS â unread (added when 'S' â
+ â â flag is not present) â
+ âââââââ´âââââââââââââââââââââââââââââ
+
+ 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(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.
+
+ index.decrypt
+ 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
+ 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.
+
+ 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), 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
+ these policies:
+
+ ââââââââââââââââ¬ââââââââ¬âââââââ¬ââââââââââ¬âââââââ
+ â â false â auto â nostash â true â
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼ââââââââââ¼âââââââ¤
+ âIndex cleartâ â â X â X â X â
+ âext using â â â â â
+ âstashed sesâ â â â â â
+ âsion keys â â â â â
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼ââââââââââ¼âââââââ¤
+ âIndex cleartâ â â â X â X â
+ âext using seâ â â â â â
+ âcret keys â â â â â
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼ââââââââââ¼âââââââ¤
+ âStash session â â â â X â
+ âkeys
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼ââââââââââ¼âââââââ¤
+ âDelete
+ âstashed sesâ â â â â â
+ âsion keys on â â â â â
+ âreindex â â â â â
+ ââââââââââââââââ´ââââââââ´âââââââ´ââââââââââ´âââââââ
+
+ 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 in-
+ dex.decrypt=true or index.decrypt=nostash without considering
+ the security of your index.
+
+ Default: auto.
+
+ 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
+ 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 inâ
+ cluded.)
+
+ query.<name>
+ Expansion for named query called <name>. See notâ
+ much-search-terms(7) for more information about named queries.
+
+ squery.<name>
+ Expansion for named query called <name>, using s-expression synâ
+ tax. See notmuch-sexp-queries(7) for more information about
+ s-expression queries.
+FILES
+
+ CONFIGURATION
- Flag Tag
- ---- -------
- D draft
- F flagged
- P passed
- R replied
- S unread (added when 'S' flag is not present)
+ Notmuch configuration file search order:
+
+ 1. File specified by notmuch --config global option; see notmuch(1).
+
+ 2. File specified by NOTMUCH_CONFIG environment variable.
+
+ 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.
+
+ 4. $HOME/.notmuch-config.<profile> where <profile> is defined by NOT-
+ MUCH_PROFILE environment variable if set, $HOME/.notmuch-config othâ
+ erwise.
+ DATABASE LOCATION
- 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.
+ Notmuch database search order:
+
+ 1. Directory specified by NOTMUCH_DATABASE environment variable.
+
+ 2. Directory specified by config key database.path.
+
+ 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
- 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.
-
+ Notmuch hook directory search order:
-ENVIRONMENT
+ 1. Directory specified by database.hook_dir configuration option.
-
- The following environment variables can be used to control the behavior
- of notmuch.
+ 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.
+
+ 3. <database.path>/.notmuch/hooks
+SEE ALSO
- NOTMUCH_CONFIG
- Specifies the location of the notmuch configuration file. Not-
- much will use ${HOME}/.notmuch-config if this variable is not
- set.
+ notmuch(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), notâ
+ 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)
-SEE ALSO
+AUTHOR
+
+ Carl Worth and many others
+
+COPYRIGHT
- notmuch(1), notmuch-count(1), notmuch-dump(1), notmuch-hooks(5), not-
- much-new(1), notmuch-reply(1), notmuch-restore(1), notmuch-search(1),
- notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)
+ 2009-2022, Carl Worth and many others
-Notmuch 0.13.2
+0.35