git.notmuchmail.org Git - notmuch/blob - man/man1/notmuch-config.1

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