1 .TH NOTMUCH-CONFIG 1 2013-07-28 "Notmuch 0.16"
3 notmuch-config \- access notmuch configuration file
7 .RI "<" section ">.<" item ">"
10 .RI "<" section ">.<" item "> [" value " ...]"
12 .B notmuch config list
18 command can be used to get or set settings in the notmuch
24 The value of the specified configuration item is printed to stdout. If
25 the item has multiple values (it is a list), each value is separated
26 by a newline character.
32 The specified configuration item is set to the given value. To specify
33 a multiple-value item (a list), provide each value as a separate
34 command-line argument.
36 If no values are provided, the specified configuration item will be
37 removed from the configuration file.
43 Every configuration item is printed to stdout, each on a separate line
46 .RI "" section "." item "=" value
48 No additional whitespace surrounds the dot or equals sign characters. In a
49 multiple-value item (a list), the values are separated by semicolon characters.
52 The available configuration items are described below.
57 The top-level directory where your mail currently exists and to where
58 mail will be delivered in the future. Files should be individual email
59 messages. Notmuch will store its database within a sub-directory of
60 the path configured here named
73 Your primary email address.
79 A list of other email addresses at which you receive email.
85 A list of tags that will be added to all messages incorporated by
92 A list of file and directory names, without path, that will not be
93 searched for messages by
95 All the files and directories matching any of the names specified here
96 will be ignored, regardless of the location in the mail store
102 .B search.exclude_tags
103 A list of tags that will be excluded from search results by
104 default. Using an excluded tag in a query will override that
110 .B maildir.synchronize_flags
111 If true, then the following maildir flags (in message filenames) will
112 be synchronized with the corresponding notmuch tags:
120 S unread (added when 'S' flag is not present)
124 command will notice flag changes in filenames and update tags, while
129 commands will notice tag changes and update flags in filenames.
131 If there have been any changes in the maildir (new messages added, old
132 ones removed or renamed, maildir flags changed, etc.), it is advisable
139 commands to ensure the tag changes are properly synchronized to the
140 maildir flags, as the commands expect the database and maildir to be
146 The following environment variables can be used to control the
150 Specifies the location of the notmuch configuration file. Notmuch will
151 use ${HOME}/.notmuch\-config if this variable is not set.
154 \fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
155 \fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
156 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
157 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),