git.notmuchmail.org Git - notmuch/blob - doc/man1/notmuch-config.rst

   1 ==============
   2 notmuch-config
   3 ==============
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **config** **get** <*section*>.<*item*>
   9
  10 **notmuch** **config** **set** <*section*>.<*item*> [*value* ...]
  11
  12 **notmuch** **config** **list**
  13
  14 DESCRIPTION
  15 ===========
  16
  17 The **config** command can be used to get or set settings in the notmuch
  18 configuration file.
  19
  20     **get**
  21         The value of the specified configuration item is printed to
  22         stdout. If the item has multiple values (it is a list), each
  23         value is separated by a newline character.
  24
  25     **set**
  26         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 will
  31         be removed from the configuration file.
  32
  33     **list**
  34         Every configuration item is printed to stdout, each on a
  35         separate line of the form:
  36
  37         *section*.\ *item*\ =\ *value*
  38
  39         No additional whitespace surrounds the dot or equals sign
  40         characters. In a multiple-value item (a list), the values are
  41         separated by semicolon characters.
  42
  43 The available configuration items are described below.
  44
  45     **database.path**
  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
  50         ``.notmuch``.
  51
  52         Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
  53
  54     **user.name**
  55         Your full name.
  56
  57         Default: ``$NAME`` variable if set, otherwise read from
  58         ``/etc/passwd``.
  59
  60     **user.primary\_email**
  61         Your primary email address.
  62
  63         Default: ``$EMAIL`` variable if set, otherwise constructed from the
  64         username and hostname of the current machine.
  65
  66     **user.other\_email**
  67         A list of other email addresses at which you receive email.
  68
  69         Default: not set.
  70
  71     **new.tags**
  72         A list of tags that will be added to all messages incorporated
  73         by **notmuch new**.
  74
  75         Default: ``unread;inbox``.
  76
  77     **new.ignore**
  78         A list of file and directory names, without path, that will not
  79         be searched for messages by **notmuch new**. All the files and
  80         directories matching any of the names specified here will be
  81         ignored, regardless of the location in the mail store directory
  82         hierarchy.
  83
  84         Default: empty list.
  85
  86     **search.exclude\_tags**
  87         A list of tags that will be excluded from search results by
  88         default. Using an excluded tag in a query will override that
  89         exclusion.
  90
  91         Default: empty list. Note that **notmuch-setup(1)** puts
  92         ``deleted;spam`` here when creating new configuration file.
  93
  94
  95
  96     **maildir.synchronize\_flags**
  97         If true, then the following maildir flags (in message filenames)
  98         will be synchronized with the corresponding notmuch tags:
  99
 100         +--------+-----------------------------------------------+
 101         | Flag   | Tag                                           |
 102         +========+===============================================+
 103         | D      | draft                                         |
 104         +--------+-----------------------------------------------+
 105         | F      | flagged                                       |
 106         +--------+-----------------------------------------------+
 107         | P      | passed                                        |
 108         +--------+-----------------------------------------------+
 109         | R      | replied                                       |
 110         +--------+-----------------------------------------------+
 111         | S      | unread (added when 'S' flag is not present)   |
 112         +--------+-----------------------------------------------+
 113
 114         The **notmuch new** command will notice flag changes in
 115         filenames and update tags, while the **notmuch tag** and
 116         **notmuch restore** commands will notice tag changes and update
 117         flags in filenames.
 118
 119         If there have been any changes in the maildir (new messages
 120         added, old ones removed or renamed, maildir flags changed,
 121         etc.), it is advisable to run **notmuch new** before **notmuch
 122         tag** or **notmuch restore** commands to ensure the tag changes
 123         are properly synchronized to the maildir flags, as the commands
 124         expect the database and maildir to be in sync.
 125
 126         Default: ``true``.
 127
 128 ENVIRONMENT
 129 ===========
 130
 131 The following environment variables can be used to control the behavior
 132 of notmuch.
 133
 134 **NOTMUCH\_CONFIG**
 135     Specifies the location of the notmuch configuration file. Notmuch
 136     will use ${HOME}/.notmuch-config if this variable is not set.
 137
 138 SEE ALSO
 139 ========
 140
 141 **notmuch(1)**, **notmuch-count(1)**, **notmuch-dump(1)**,
 142 **notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**,
 143 **notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
 144 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**