.TH "NOTMUCH-CONFIG" "1" "September 14, 2014" "0.18.1" "notmuch"
.SH NAME
notmuch-config \- access notmuch configuration file
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
\fBnotmuch\fP \fBconfig\fP \fBget\fP <\fIsection\fP>.<\fIitem\fP>
.sp
\fBnotmuch\fP \fBconfig\fP \fBset\fP <\fIsection\fP>.<\fIitem\fP> [\fIvalue\fP ...]
.sp
\fBnotmuch\fP \fBconfig\fP \fBlist\fP
.SH DESCRIPTION
.sp
The \fBconfig\fP command can be used to get or set settings in the notmuch
configuration file.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBget\fP
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.
.TP
.B \fBset\fP
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.
.sp
If no values are provided, the specified configuration item will
be removed from the configuration file.
.TP
.B \fBlist\fP
Every configuration item is printed to stdout, each on a
separate line of the form:
.sp
\fIsection\fP.\fIitem\fP=\fIvalue\fP
.sp
No additional whitespace surrounds the dot or equals sign
characters. In a multiple\-value item (a list), the values are
separated by semicolon characters.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The available configuration items are described below.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBdatabase.path\fP
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
\fB.notmuch\fP.
.TP
.B \fBuser.name\fP
Your full name.
.TP
.B \fBuser.primary_email\fP
Your primary email address.
.TP
.B \fBuser.other_email\fP
A list of other email addresses at which you receive email.
.TP
.B \fBnew.tags\fP
A list of tags that will be added to all messages incorporated
by \fBnotmuch new\fP.
.TP
.B \fBnew.ignore\fP
A list of file and directory names, without path, that will not
be searched for messages by \fBnotmuch new\fP. 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.
.TP
.B \fBsearch.exclude_tags\fP
A list of tags that will be excluded from search results by
default. Using an excluded tag in a query will override that
exclusion.
.TP
.B \fBmaildir.synchronize_flags\fP
If true, then the following maildir flags (in message filenames)
will be synchronized with the corresponding notmuch tags:
.TS
center;
|l|l|.
_
T{
Flag
T}	T{
Tag
T}
_
T{
D
T}	T{
draft
T}
_
T{
F
T}	T{
flagged
T}
_
T{
P
T}	T{
passed
T}
_
T{
R
T}	T{
replied
T}
_
T{
S
T}	T{
unread (added when \(aqS\(aq flag is not present)
T}
_
.TE
.sp
The \fBnotmuch new\fP command will notice flag changes in
filenames and update tags, while the \fBnotmuch tag\fP and
\fBnotmuch restore\fP commands will notice tag changes and update
flags in filenames.
.sp
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 \fBnotmuch new\fP before \fBnotmuch
tag\fP or \fBnotmuch restore\fP 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.
.UNINDENT
.UNINDENT
.UNINDENT
.SH ENVIRONMENT
.sp
The following environment variables can be used to control the behavior
of notmuch.
.INDENT 0.0
.TP
.B \fBNOTMUCH_CONFIG\fP
Specifies the location of the notmuch configuration file. Notmuch
will use ${HOME}/.notmuch\-config if this variable is not set.
.UNINDENT
.SH SEE ALSO
.sp
\fBnotmuch(1)\fP, \fBnotmuch\-count(1)\fP, \fBnotmuch\-dump(1)\fP,
\fBnotmuch\-hooks(5)\fP, \fBnotmuch\-insert(1)\fP, \fBnotmuch\-new(1)\fP,
\fBnotmuch\-reply(1)\fP, \fBnotmuch\-restore(1)\fP, \fBnotmuch\-search(1)\fP,
\fBnotmuch\-search\-terms(7)\fP, \fBnotmuch\-show(1)\fP, \fBnotmuch\-tag(1)\fP
.SH AUTHOR
Carl Worth and many others
.SH COPYRIGHT
2014, Carl Worth and many others
.\" Generated by docutils manpage writer.
.\" 
.