]> git.notmuchmail.org Git - notmuch/commitdiff
Add default configuration values to the man page
authorSergei Shilovsky <sshilovsky@gmail.com>
Tue, 14 Oct 2014 14:30:56 +0000 (18:30 +0400)
committerDavid Bremner <david@tethera.net>
Thu, 1 Jan 2015 15:48:18 +0000 (16:48 +0100)
doc/man1/notmuch-config.rst

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