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     **user.name**
  53         Your full name.
  54
  55     **user.primary\_email**
  56         Your primary email address.
  57
  58     **user.other\_email**
  59         A list of other email addresses at which you receive email.
  60
  61     **new.tags**
  62         A list of tags that will be added to all messages incorporated
  63         by **notmuch new**.
  64
  65     **new.ignore**
  66         A list of file and directory names, without path, that will not
  67         be searched for messages by **notmuch new**. 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     **search.exclude\_tags**
  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     **maildir.synchronize\_flags**
  78         If true, then the following maildir flags (in message filenames)
  79         will be synchronized with the corresponding notmuch tags:
  80
  81         +--------+-----------------------------------------------+
  82         | Flag   | Tag                                           |
  83         +========+===============================================+
  84         | D      | draft                                         |
  85         +--------+-----------------------------------------------+
  86         | F      | flagged                                       |
  87         +--------+-----------------------------------------------+
  88         | P      | passed                                        |
  89         +--------+-----------------------------------------------+
  90         | R      | replied                                       |
  91         +--------+-----------------------------------------------+
  92         | S      | unread (added when 'S' flag is not present)   |
  93         +--------+-----------------------------------------------+
  94
  95         The **notmuch new** command will notice flag changes in
  96         filenames and update tags, while the **notmuch tag** and
  97         **notmuch restore** commands will notice tag changes and update
  98         flags in filenames.
  99
 100         If there have been any changes in the maildir (new messages
 101         added, old ones removed or renamed, maildir flags changed,
 102         etc.), it is advisable to run **notmuch new** before **notmuch
 103         tag** or **notmuch restore** commands to ensure the tag changes
 104         are properly synchronized to the maildir flags, as the commands
 105         expect the database and maildir to be in sync.
 106
 107 ENVIRONMENT
 108 ===========
 109
 110 The following environment variables can be used to control the behavior
 111 of notmuch.
 112
 113 **NOTMUCH\_CONFIG**
 114     Specifies the location of the notmuch configuration file. Notmuch
 115     will use ${HOME}/.notmuch-config if this variable is not set.
 116
 117 SEE ALSO
 118 ========
 119
 120 **notmuch(1)**, **notmuch-count(1)**, **notmuch-dump(1)**,
 121 **notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**,
 122 **notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
 123 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**