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