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
22 <b>get</b> The value of the specified configuration item is printed to
23 stdout. If the item has multiple values (it is a list), each
24 value is separated by a newline character.
26 <b>set</b> The specified configuration item is set to the given value.
27 To specify a multiple-value item (a list), provide each value
28 as a separate command-line argument.
30 If no values are provided, the specified configuration item
31 will be removed from the configuration file.
33 <b>list</b> Every configuration item is printed to stdout, each on a sep‐
34 arate line of the form:
36 <u>section</u>.<u>item</u>=<u>value</u>
38 No additional whitespace surrounds the dot or equals sign
39 characters. In a multiple-value item (a list), the values are
40 separated by semicolon characters.
42 The available configuration items are described below.
45 The top-level directory where your mail currently exists and
46 to where mail will be delivered in the future. Files should
47 be individual email messages. Notmuch will store its database
48 within a sub-directory of the path configured here named
54 <b>user.primary</b>_<b>email</b>
55 Your primary email address.
57 <b>user.other</b>_<b>email</b>
58 A list of other email addresses at which you receive email.
61 A list of tags that will be added to all messages incorpo‐
62 rated by <b>notmuch</b> <b>new</b>.
65 A list of file and directory names, without path, that will
66 not be searched for messages by <b>notmuch</b> <b>new</b>. All the files
67 and directories matching any of the names specified here will
68 be ignored, regardless of the location in the mail store
71 <b>search.exclude</b>_<b>tags</b>
72 A list of tags that will be excluded from search results by
73 default. Using an excluded tag in a query will override that
76 <b>maildir.synchronize</b>_<b>flags</b>
77 If true, then the following maildir flags (in message file‐
78 names) will be synchronized with the corresponding notmuch
81 ┌─────┬────────────────────────────┐
83 ├─────┼────────────────────────────┤
85 ├─────┼────────────────────────────┤
87 ├─────┼────────────────────────────┤
89 ├─────┼────────────────────────────┤
91 ├─────┼────────────────────────────┤
92 │S │ unread (added when 'S' │
93 │ │ flag is not present) │
94 └─────┴────────────────────────────┘
96 The <b>notmuch</b> <b>new</b> command will notice flag changes in filenames
97 and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b> <b>restore</b>
98 commands will notice tag changes and update flags in file‐
101 If there have been any changes in the maildir (new messages
102 added, old ones removed or renamed, maildir flags changed,
103 etc.), it is advisable to run <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b>
104 or <b>notmuch</b> <b>restore</b> commands to ensure the tag changes are
105 properly synchronized to the maildir flags, as the commands
106 expect the database and maildir to be in sync.
111 The following environment variables can be used to control the behavior
114 <b>NOTMUCH</b>_<b>CONFIG</b>
115 Specifies the location of the notmuch configuration file. Not‐
116 much will use ${HOME}/.notmuch-config if this variable is not
122 <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>
123 <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),
124 <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), <a href='../notmuch-tag-1/'>not‐</a>
125 <a href='../notmuch-tag-1/'>much-tag</a>(1)
130 Carl Worth and many others
135 2014, Carl Worth and many others