git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-config-1.mdwn

   1 <h1>NOTMUCH-CONFIG(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-config - access notmuch configuration file
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>config</b> <b>get</b> &lt;<u>section</u>&gt;.&lt;<u>item</u>&gt;
  11
  12        <b>notmuch</b> <b>config</b> <b>set</b> &lt;<u>section</u>&gt;.&lt;<u>item</u>&gt; [<u>value</u> ...]
  13
  14        <b>notmuch</b> <b>config</b> <b>list</b>
  15 </pre>
  16
  17 <h2>DESCRIPTION</h2>
  18 <pre>
  19        The  <b>config</b>  command  can be used to get or set settings in the notmuch
  20        configuration file.
  21
  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.
  25
  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.
  29
  30                  If no values are provided, the specified  configuration  item
  31                  will be removed from the configuration file.
  32
  33           <b>list</b>   Every configuration item is printed to stdout, each on a sep‐
  34                  arate line of the form:
  35
  36                  <u>section</u>.<u>item</u>=<u>value</u>
  37
  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.
  41
  42        The available configuration items are described below.
  43
  44           <b>database.path</b>
  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
  49                  <b>.notmuch</b>.
  50
  51                  Default: <b>$MAILDIR</b> variable if set, otherwise <b>$HOME/mail</b>.
  52
  53           <b>user.name</b>
  54                  Your full name.
  55
  56                  Default:  <b>$NAME</b>  variable  if  set,   otherwise   read   from
  57                  <b>/etc/passwd</b>.
  58
  59           <b>user.primary</b>_<b>email</b>
  60                  Your primary email address.
  61
  62                  Default:  <b>$EMAIL</b>  variable if set, otherwise constructed from
  63                  the username and hostname of the current machine.
  64
  65           <b>user.other</b>_<b>email</b>
  66                  A list of other email addresses at which you receive email.
  67
  68                  Default: not set.
  69
  70           <b>new.tags</b>
  71                  A list of tags that will be added to  all  messages  incorpo‐
  72                  rated by <b>notmuch</b> <b>new</b>.
  73
  74                  Default: <b>unread;inbox</b>.
  75
  76           <b>new.ignore</b>
  77                  A  list  of file and directory names, without path, that will
  78                  not be searched for messages by <b>notmuch</b> <b>new</b>.  All  the  files
  79                  and directories matching any of the names specified here will
  80                  be ignored, regardless of the  location  in  the  mail  store
  81                  directory hierarchy.
  82
  83                  Default: empty list.
  84
  85           <b>search.exclude</b>_<b>tags</b>
  86                  A  list  of tags that will be excluded from search results by
  87                  default. Using an excluded tag in a query will override  that
  88                  exclusion.
  89
  90                  Default:   empty   list.   Note  that  <b>notmuch-setup</b>(1)  puts
  91                  <b>deleted;spam</b> here when creating new configuration file.
  92
  93           <b>maildir.synchronize</b>_<b>flags</b>
  94                  If true, then the following maildir flags (in  message  file‐
  95                  names)  will  be  synchronized with the corresponding notmuch
  96                  tags:
  97
  98                               ┌─────┬────────────────────────────┐
  99                               │Flag │ Tag                        │
 100                               ├─────┼────────────────────────────┤
 101                               │D    │ draft                      │
 102                               ├─────┼────────────────────────────┤
 103                               │F    │ flagged                    │
 104                               ├─────┼────────────────────────────┤
 105                               │P    │ passed                     │
 106                               ├─────┼────────────────────────────┤
 107                               │R    │ replied                    │
 108                               ├─────┼────────────────────────────┤
 109                               │S    │ unread  (added  when   &apos;S&apos; │
 110                               │     │ flag is not present)       │
 111                               └─────┴────────────────────────────┘
 112
 113                  The <b>notmuch</b> <b>new</b> command will notice flag changes in filenames
 114                  and update tags, while the <b>notmuch</b> <b>tag</b>  and  <b>notmuch</b>  <b>restore</b>
 115                  commands  will  notice  tag changes and update flags in file‐
 116                  names.
 117
 118                  If there have been any changes in the maildir  (new  messages
 119                  added,  old  ones  removed or renamed, maildir flags changed,
 120                  etc.), it is advisable to run <b>notmuch</b> <b>new</b> before <b>notmuch</b>  <b>tag</b>
 121                  or  <b>notmuch</b>  <b>restore</b>  commands  to ensure the tag changes are
 122                  properly synchronized to the maildir flags, as  the  commands
 123                  expect the database and maildir to be in sync.
 124
 125                  Default: <b>true</b>.
 126
 127           <b>crypto.gpg</b>_<b>path</b>
 128               Name  (or  full  path)  of gpg binary to use in verification and
 129               decryption of PGP/MIME messages.
 130
 131               Default: <b>gpg</b>.
 132 </pre>
 133
 134 <h2>ENVIRONMENT</h2>
 135 <pre>
 136        The following environment variables can be used to control the behavior
 137        of notmuch.
 138
 139        <b>NOTMUCH</b>_<b>CONFIG</b>
 140               Specifies  the  location of the notmuch configuration file. Not‐
 141               much will use ${HOME}/.notmuch-config if this  variable  is  not
 142               set.
 143 </pre>
 144
 145 <h2>SEE ALSO</h2>
 146 <pre>
 147        <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>
 148        <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),
 149        <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>
 150        <a href='../notmuch-tag-1/'>much-tag</a>(1)
 151 </pre>
 152
 153 <h2>AUTHOR</h2>
 154 <pre>
 155        Carl Worth and many others
 156 </pre>
 157
 158 <h2>COPYRIGHT</h2>
 159 <pre>
 160        2014, Carl Worth and many others
 161 </pre>
 162
 163 <h2>0.20.1</h2>