1 <h1>NOTMUCH-CONFIG(1)</h1>
5 notmuch-config - access notmuch configuration file
10 <b>notmuch</b> <b>config</b> <b>get</b> <<u>section</u>>.<<u>item</u>>
12 <b>notmuch</b> <b>config</b> <b>set</b> <<u>section</u>>.<<u>item</u>> [<u>value</u> ...]
14 <b>notmuch</b> <b>config</b> <b>list</b>
19 The <b>config</b> command can be used to get or set settings in the notmuch
24 The value of the specified configuration item is printed to
25 stdout. If the item has multiple values (it is a list), each
26 value is separated by a newline character.
30 The specified configuration item is set to the given value.
31 To specify a multiple-value item (a list), provide each
32 value as a separate command-line argument.
34 If no values are provided, the specified configuration item
35 will be removed from the configuration file.
39 Every configuration item is printed to stdout, each on a
40 separate line of the form:
42 <u>section</u>.<u>item</u>=<u>value</u>
44 No additional whitespace surrounds the dot or equals sign
45 characters. In a multiple-value item (a list), the values
46 are separated by semicolon characters.
48 The available configuration items are described below.
52 The top-level directory where your mail currently exists and
53 to where mail will be delivered in the future. Files should
54 be individual email messages. Notmuch will store its
55 database within a sub-directory of the path configured here
62 <b>user.primary</b>_<b>email</b>
64 Your primary email address.
66 <b>user.other</b>_<b>email</b>
68 A list of other email addresses at which you receive email.
72 A list of tags that will be added to all messages incorpo-
73 rated by <b>notmuch</b> <b>new</b>.
77 A list of file and directory names, without path, that will
78 not be searched for messages by <b>notmuch</b> <b>new</b>. All the files
79 and directories matching any of the names specified here
80 will be ignored, regardless of the location in the mail
81 store directory hierarchy.
83 <b>search.exclude</b>_<b>tags</b>
85 A list of tags that will be excluded from search results by
86 default. Using an excluded tag in a query will override that
89 <b>maildir.synchronize</b>_<b>flags</b>
91 If true, then the following maildir flags (in message file-
92 names) will be synchronized with the corresponding notmuch
95 +-----+----------------------------+
97 +-----+----------------------------+
99 +-----+----------------------------+
101 +-----+----------------------------+
103 +-----+----------------------------+
105 +-----+----------------------------+
106 |S | unread (added when 'S' |
107 | | flag is not present) |
108 +-----+----------------------------+
110 The <b>notmuch</b> <b>new</b> command will notice flag changes in file-
111 names and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b>
112 <b>restore</b> commands will notice tag changes and update flags in
115 If there have been any changes in the maildir (new messages
116 added, old ones removed or renamed, maildir flags changed,
117 etc.), it is advisable to run <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b>
118 or <b>notmuch</b> <b>restore</b> commands to ensure the tag changes are
119 properly synchronized to the maildir flags, as the commands
120 expect the database and maildir to be in sync.
125 The following environment variables can be used to control the behavior
128 <b>NOTMUCH</b>_<b>CONFIG</b>
130 Specifies the location of the notmuch configuration file. Not-
131 much will use ${HOME}/.notmuch-config if this variable is not
137 <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
138 <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
139 <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1),
140 <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
145 Carl Worth and many others
150 2014, Carl Worth and many others