git.cworth.org Git - obsolete/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.  To
  27                specify a multiple-value item (a list), provide each value as a
  28                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>
  34                Every  configuration item is printed to stdout, each on a sepa-
  35                rate line of the form:
  36
  37                <u>section</u>.<u>item</u>=<u>value</u>
  38
  39                No additional whitespace surrounds the dot or equals sign char-
  40                acters. In a multiple-value item (a list), the values are sepa-
  41                rated by semicolon characters.
  42
  43        The available configuration items are described below.
  44
  45            <b>database.path</b>
  46                The top-level directory where your mail currently exists and to
  47                where  mail  will  be  delivered in the future. Files should be
  48                individual email messages.  Notmuch  will  store  its  database
  49                within  a sub-directory of the path configured here named <b>.not-</b>
  50                <b>much</b>.
  51
  52            <b>user.name</b>
  53                Your full name.
  54
  55            <b>user.primary</b>_<b>email</b>
  56                Your primary email address.
  57
  58            <b>user.other</b>_<b>email</b>
  59                A list of other email addresses at which you receive email.
  60
  61            <b>new.tags</b>
  62                A list of tags that will be added to all messages  incorporated
  63                by <b>notmuch</b> <b>new</b>.
  64
  65            <b>new.ignore</b>
  66                A list of file and directory names, without path, that will not
  67                be searched for messages by <b>notmuch</b> <b>new</b>.   All  the  files  and
  68                directories  matching  any  of the names specified here will be
  69                ignored, regardless of the location in the mail store directory
  70                hierarchy.
  71
  72            <b>search.exclude</b>_<b>tags</b>
  73                A  list  of  tags  that will be excluded from search results by
  74                default. Using an excluded tag in a query  will  override  that
  75                exclusion.
  76
  77            <b>maildir.synchronize</b>_<b>flags</b>
  78                If  true,  then  the  following maildir flags (in message file-
  79                names) will be  synchronized  with  the  corresponding  notmuch
  80                tags:
  81
  82                  Flag    Tag
  83                  ----    -------
  84                  D       draft
  85                  F       flagged
  86                  P       passed
  87                  R       replied
  88                  S       unread (added when &apos;S&apos; flag is not present)
  89
  90                The  <b>notmuch</b>  <b>new</b> command will notice flag changes in filenames
  91                and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b> <b>restore</b> com-
  92                mands will notice tag changes and update flags in filenames.
  93
  94                If  there  have  been  any changes in the maildir (new messages
  95                added, old ones removed  or  renamed,  maildir  flags  changed,
  96                etc.), it is advisable to run <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b> or
  97                <b>notmuch</b> <b>restore</b> commands to ensure the tag changes are properly
  98                synchronized  to  the maildir flags, as the commands expect the
  99                database and maildir to be in sync.
 100 </pre>
 101
 102 <h2>ENVIRONMENT</h2>
 103 <pre>
 104        The following environment variables can be used to control the behavior
 105        of notmuch.
 106
 107        <b>NOTMUCH</b>_<b>CONFIG</b>
 108               Specifies  the  location of the notmuch configuration file. Not-
 109               much will use ${HOME}/.notmuch-config if this  variable  is  not
 110               set.
 111 </pre>
 112
 113 <h2>SEE ALSO</h2>
 114 <pre>
 115        <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>
 116        <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),
 117        <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/'>notmuch-</a>
 118        <a href='../notmuch-tag-1/'>tag</a>(1)
 119 </pre>
 120
 121 <h2>Notmuch 0.16</h2>