X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-config-1.mdwn;h=4efc3cff026c122e6d2fc1e79912bcf6a9ec296e;hb=bf4ac2a31d4b8220d28b36de018a4ad516d60baf;hp=24d4a63c5dc26f842f1f17b954c5e991dc43f431;hpb=b6a11cc4ea38abff9f0a324d273f7cd4b4088e2e;p=notmuch-wiki diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 24d4a63..4efc3cf 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -19,105 +19,116 @@ The config command can be used to get or set settings in the notmuch configuration file. - get + 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. - 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. + 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 + If no values are provided, the specified configuration item + will be removed from the configuration file. - 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. + list Every configuration item is printed to stdout, each on a sep‐ + arate line of the form: - If no values are provided, the specified configuration item - will be removed from the configuration file. + section.item=value - list - - Every configuration item is printed to stdout, each on a - separate line of the form: - - section.item=value - - No additional whitespace surrounds the dot or equals sign - characters. In a multiple-value item (a list), the values - are separated by semicolon characters. + No additional whitespace surrounds the dot or equals sign + characters. In a multiple-value item (a list), the values are + separated by semicolon characters. 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 .notmuch. - - user.name - - Your full name. - - user.primary_email - - Your primary email address. - - user.other_email - - A list of other email addresses at which you receive email. - - new.tags - - A list of tags that will be added to all messages incorpo- - rated by notmuch new. - - 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. - - 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. - - maildir.synchronize_flags - - If true, then the following maildir flags (in message file- - names) 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 command will notice flag changes in file- - names and update tags, while the notmuch tag and notmuch - restore 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. + 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 + .notmuch. + + Default: $MAILDIR variable if set, otherwise $HOME/mail. + + 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 incorpo‐ + rated by notmuch new. + + Default: unread;inbox. + + 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: 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. + + Default: empty list. Note that notmuch-setup(1) puts + deleted;spam here when creating new configuration file. + + maildir.synchronize_flags + If true, then the following maildir flags (in message file‐ + names) 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 command will notice flag changes in filenames + and update tags, while the notmuch tag and notmuch restore + commands will notice tag changes and update flags in file‐ + names. + + 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. + + Default: true. + + crypto.gpg_path + Name (or full path) of gpg binary to use in verification and + decryption of PGP/MIME messages. + + Default: gpg.

ENVIRONMENT

@@ -126,18 +137,17 @@ of notmuch. NOTMUCH_CONFIG - - Specifies the location of the notmuch configuration file. Not- - much will use ${HOME}/.notmuch-config if this variable is not + Specifies the location of the notmuch configuration file. Not‐ + much will use ${HOME}/.notmuch-config if this variable is not set.

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-show(1),
-       notmuch-tag(1)
+       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-show(1),   not‐
+       much-tag(1)

AUTHOR

@@ -147,7 +157,7 @@

COPYRIGHT

-       2014, Carl Worth and many others
+       2009-2015, Carl Worth and many others
-

0.18

+

0.21