Add default configuration values to the man page

This commit is contained in:
Sergei Shilovsky 2014-10-14 18:30:56 +04:00 committed by David Bremner
parent c82a1745ac
commit 7b31f54ed9

View file

@ -49,19 +49,31 @@ The available configuration items are described below.
within a sub-directory of the path configured here named within a sub-directory of the path configured here named
``.notmuch``. ``.notmuch``.
Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
**user.name** **user.name**
Your full name. Your full name.
Default: ``$NAME`` variable if set, otherwise read from
``/etc/passwd``.
**user.primary\_email** **user.primary\_email**
Your primary email address. Your primary email address.
Default: ``$EMAIL`` variable if set, otherwise constructed from the
username and hostname of the current machine.
**user.other\_email** **user.other\_email**
A list of other email addresses at which you receive email. A list of other email addresses at which you receive email.
Default: not set.
**new.tags** **new.tags**
A list of tags that will be added to all messages incorporated A list of tags that will be added to all messages incorporated
by **notmuch new**. by **notmuch new**.
Default: ``unread;inbox``.
**new.ignore** **new.ignore**
A list of file and directory names, without path, that will not A list of file and directory names, without path, that will not
be searched for messages by **notmuch new**. All the files and be searched for messages by **notmuch new**. All the files and
@ -69,11 +81,18 @@ The available configuration items are described below.
ignored, regardless of the location in the mail store directory ignored, regardless of the location in the mail store directory
hierarchy. hierarchy.
Default: empty list.
**search.exclude\_tags** **search.exclude\_tags**
A list of tags that will be excluded from search results by A list of tags that will be excluded from search results by
default. Using an excluded tag in a query will override that default. Using an excluded tag in a query will override that
exclusion. exclusion.
Default: empty list. Note that **notmuch-setup(1)** puts
``deleted;spam`` here when creating new configuration file.
**maildir.synchronize\_flags** **maildir.synchronize\_flags**
If true, then the following maildir flags (in message filenames) If true, then the following maildir flags (in message filenames)
will be synchronized with the corresponding notmuch tags: will be synchronized with the corresponding notmuch tags:
@ -104,6 +123,8 @@ The available configuration items are described below.
are properly synchronized to the maildir flags, as the commands are properly synchronized to the maildir flags, as the commands
expect the database and maildir to be in sync. expect the database and maildir to be in sync.
Default: ``true``.
ENVIRONMENT ENVIRONMENT
=========== ===========