Merge tag '0.12_rc2'
[notmuch] / man / man1 / notmuch-config.1
1 .TH NOTMUCH-CONFIG 1 2012-03-18 "Notmuch 0.12~rc2"
2 .SH NAME
3 notmuch-config \- Access notmuch configuration file.
4 .SH SYNOPSIS
5
6 .B notmuch config get
7 .RI  "<" section ">.<" item ">"
8
9 .B notmuch config set
10 .RI  "<" section ">.<" item "> [" value " ...]"
11
12 .SH DESCRIPTION
13
14 The
15 .B config
16 command can be used to get or set settings in the notmuch
17 configuration file.
18
19 .RS 4
20 .TP 4
21 .B get
22 The value of the specified configuration item is printed to stdout. If
23 the item has multiple values (it is a list), each value is separated
24 by a newline character.
25 .RE
26
27 .RS 4
28 .TP 4
29 .B set
30 The specified configuration item is set to the given value. To specify
31 a multiple-value item (a list), provide each value as a separate
32 command-line argument.
33
34 If no values are provided, the specified configuration item will be
35 removed from the configuration file.
36 .RE
37
38 The available configuration items are described below.
39
40 .RS 4
41 .TP 4
42 .B database.path
43 The top-level directory where your mail currently exists and to where
44 mail will be delivered in the future. Files should be individual email
45 messages. Notmuch will store its database within a sub-directory of
46 the path configured here named
47 .BR ".notmuch".
48 .RE
49
50 .RS 4
51 .TP 4
52 .B user.name
53 Your full name.
54 .RE
55
56 .RS 4
57 .TP 4
58 .B user.primary_email
59 Your primary email address.
60 .RE
61
62 .RS 4
63 .TP 4
64 .B user.other_email
65 A list of other email addresses at which you receive email.
66 .RE
67
68 .RS 4
69 .TP 4
70 .B new.tags
71 A list of tags that will be added to all messages incorporated by
72 .BR "notmuch new".
73 .RE
74
75 .RS 4
76 .TP 4
77 .B new.ignore
78 A list of file and directory names, without path, that will not be
79 searched for messages by
80 .BR "notmuch new".
81 All the files and directories matching any of the names specified here
82 will be ignored, regardless of the location in the mail store
83 directory hierarchy.
84 .RE
85
86 .RS 4
87 .TP 4
88 .B search.exclude_tags
89 A list of tags that will be excluded from search results by
90 default. Using an excluded tag in a query will override that
91 exclusion.
92 .RE
93
94 .RS 4
95 .TP 4
96 .B maildir.synchronize_flags
97 If true, then the following maildir flags (in message filenames) will
98 be synchronized with the corresponding notmuch tags:
99
100   Flag    Tag
101   ----    -------
102   D       draft
103   F       flagged
104   P       passed
105   R       replied
106   S       unread (added when 'S' flag is not present)
107
108 The
109 .B notmuch new
110 command will notice flag changes in filenames and update tags, while
111 the
112 .B notmuch tag
113 and
114 .B notmuch restore
115 commands will notice tag changes and update flags in filenames.
116
117 If there have been any changes in the maildir (new messages added, old
118 ones removed or renamed, maildir flags changed, etc.), it is advisable
119 to run
120 .B notmuch new
121 before
122 .B notmuch tag
123 or
124 .B notmuch restore
125 commands to ensure the tag changes are properly synchronized to the
126 maildir flags, as the commands expect the database and maildir to be
127 in sync.
128 .RE
129
130 .RE
131 .SH ENVIRONMENT
132 The following environment variables can be used to control the
133 behavior of notmuch.
134 .TP
135 .B NOTMUCH_CONFIG
136 Specifies the location of the notmuch configuration file. Notmuch will
137 use ${HOME}/.notmuch\-config if this variable is not set.
138 .SH SEE ALSO
139
140 \fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
141 \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
142 \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
143 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
144 \fBnotmuch-tag\fR(1)