1 <h1>NOTMUCH-CONFIG(1)</h1>
6 notmuch-config - Access notmuch configuration file.
12 <b>notmuch</b> <b>config</b> <b>get</b> <<u>section</u>>.<<u>item</u>>
16 <b>notmuch</b> <b>config</b> <b>set</b> <<u>section</u>>.<<u>item</u>> [<u>value</u> ...]
20 <b>notmuch</b> <b>config</b> <b>list</b>
26 The <b>config</b> command can be used to get or set settings in the notmuch
31 <b>get</b> The value of the specified configuration item is printed to
32 stdout. If the item has multiple values (it is a list), each
33 value is separated by a newline character.
37 <b>set</b> The specified configuration item is set to the given value. To
38 specify a multiple-value item (a list), provide each value as a
39 separate command-line argument.
43 If no values are provided, the specified configuration item
44 will be removed from the configuration file.
49 Every configuration item is printed to stdout, each on a sepa-
50 rate line of the form:
54 <u>section</u>.<u>item</u>=<u>value</u>
58 No additional whitespace surrounds the dot or equals sign char-
59 acters. In a multiple-value item (a list), the values are sepa-
60 rated by semicolon characters.
64 The available configuration items are described below.
69 The top-level directory where your mail currently exists and to
70 where mail will be delivered in the future. Files should be
71 individual email messages. Notmuch will store its database
72 within a sub-directory of the path configured here named <b>.not-</b>
82 <b>user.primary</b>_<b>email</b>
83 Your primary email address.
87 <b>user.other</b>_<b>email</b>
88 A list of other email addresses at which you receive email.
93 A list of tags that will be added to all messages incorporated
94 by <b>notmuch</b> <b>new</b>.
99 A list of file and directory names, without path, that will not
100 be searched for messages by <b>notmuch</b> <b>new</b>. All the files and
101 directories matching any of the names specified here will be
102 ignored, regardless of the location in the mail store directory
107 <b>search.exclude</b>_<b>tags</b>
108 A list of tags that will be excluded from search results by
109 default. Using an excluded tag in a query will override that
114 <b>maildir.synchronize</b>_<b>flags</b>
115 If true, then the following maildir flags (in message file-
116 names) will be synchronized with the corresponding notmuch
127 S unread (added when 'S' flag is not present)
131 The <b>notmuch</b> <b>new</b> command will notice flag changes in filenames
132 and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b> <b>restore</b> com-
133 mands will notice tag changes and update flags in filenames.
137 If there have been any changes in the maildir (new messages
138 added, old ones removed or renamed, maildir flags changed,
139 etc.), it is advisable to run <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b> or
140 <b>notmuch</b> <b>restore</b> commands to ensure the tag changes are properly
141 synchronized to the maildir flags, as the commands expect the
142 database and maildir to be in sync.
148 The following environment variables can be used to control the behavior
153 <b>NOTMUCH</b>_<b>CONFIG</b>
154 Specifies the location of the notmuch configuration file. Not-
155 much will use ${HOME}/.notmuch-config if this variable is not
162 <b>notmuch</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>notmuch-hooks</b>(5), <b>not-</b>
163 <b>much-new</b>(1), <b>notmuch-reply</b>(1), <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1),
164 <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1)
167 <h2>Notmuch 0.13.2</h2>