man: update SEE ALSO references in man pages
[notmuch] / man / man1 / notmuch-config.1
1 .TH NOTMUCH-CONFIG 1 2012-02-29 "Notmuch 0.12~rc1"
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 maildir.synchronize_flags
89 If true, then the following maildir flags (in message filenames) will
90 be synchronized with the corresponding notmuch tags:
91
92   Flag    Tag
93   ----    -------
94   D       draft
95   F       flagged
96   P       passed
97   R       replied
98   S       unread (added when 'S' flag is not present)
99
100 The
101 .B notmuch new
102 command will notice flag changes in filenames and update tags, while
103 the
104 .B notmuch tag
105 and
106 .B notmuch restore
107 commands will notice tag changes and update flags in filenames.
108
109 If there have been any changes in the maildir (new messages added, old
110 ones removed or renamed, maildir flags changed, etc.), it is advisable
111 to run
112 .B notmuch new
113 before
114 .B notmuch tag
115 or
116 .B notmuch restore
117 commands to ensure the tag changes are properly synchronized to the
118 maildir flags, as the commands expect the database and maildir to be
119 in sync.
120 .RE
121
122 .RE
123 .SH ENVIRONMENT
124 The following environment variables can be used to control the
125 behavior of notmuch.
126 .TP
127 .B NOTMUCH_CONFIG
128 Specifies the location of the notmuch configuration file. Notmuch will
129 use ${HOME}/.notmuch\-config if this variable is not set.
130 .SH SEE ALSO
131
132 \fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
133 \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
134 \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
135 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
136 \fBnotmuch-tag\fR(1)