unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH] Add default configuration values to the man page
@ 2014-10-01 20:20 Sergei Shilovsky
  2014-10-04  5:40 ` David Bremner
  2014-10-05 12:28 ` Michal Sojka
  0 siblings, 2 replies; 3+ messages in thread
From: Sergei Shilovsky @ 2014-10-01 20:20 UTC (permalink / raw)
  To: notmuch

---
 doc/man1/notmuch-config.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 3c9a568..9de5534 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -49,19 +49,31 @@ The available configuration items are described below.
         within a sub-directory of the path configured here named
         ``.notmuch``.
 
+        Default: ``$MAILDIR``, otherwise ``$HOME/mail``.
+
     **user.name**
         Your full name.
 
+        Default: ``$NAME`` variable if set, otherwise read from
+        ``/etc/passwd``.
+
     **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.
 
+        Default: not set.
+
     **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
@@ -69,11 +81,15 @@ The available configuration items are described below.
         ignored, regardless of the location in the mail store directory
         hierarchy.
 
+        Default: no tags.
+
     **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: ``deleted;spam``.
+
     **maildir.synchronize\_flags**
         If true, then the following maildir flags (in message filenames)
         will be synchronized with the corresponding notmuch tags:
@@ -104,6 +120,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.
 
+        Default: ``true``.
+
 ENVIRONMENT
 ===========
 
-- 
2.1.0

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] Add default configuration values to the man page
  2014-10-01 20:20 [PATCH] Add default configuration values to the man page Sergei Shilovsky
@ 2014-10-04  5:40 ` David Bremner
  2014-10-05 12:28 ` Michal Sojka
  1 sibling, 0 replies; 3+ messages in thread
From: David Bremner @ 2014-10-04  5:40 UTC (permalink / raw)
  To: Sergei Shilovsky, notmuch

Sergei Shilovsky <sshilovsky@gmail.com> writes:

>      **new.tags**
>          A list of tags that will be added to all messages incorporated
>          by **notmuch new**.
>  
> +        Default: ``unread;inbox``.
> +

There is actually something a bit subtle about some of these defaults.
Some of them are applied only to newly created configuration files,
while others are applied if there is now config value in the file.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] Add default configuration values to the man page
  2014-10-01 20:20 [PATCH] Add default configuration values to the man page Sergei Shilovsky
  2014-10-04  5:40 ` David Bremner
@ 2014-10-05 12:28 ` Michal Sojka
  1 sibling, 0 replies; 3+ messages in thread
From: Michal Sojka @ 2014-10-05 12:28 UTC (permalink / raw)
  To: Sergei Shilovsky, notmuch

On Wed, Oct 01 2014, Sergei Shilovsky wrote:
> ---
>  doc/man1/notmuch-config.rst | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>
> diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
> index 3c9a568..9de5534 100644
> --- a/doc/man1/notmuch-config.rst
> +++ b/doc/man1/notmuch-config.rst
> @@ -49,19 +49,31 @@ The available configuration items are described below.
>          within a sub-directory of the path configured here named
>          ``.notmuch``.
>
> +        Default: ``$MAILDIR``, otherwise ``$HOME/mail``.

To be consistent with the rest, this should be "``$MAILDIR`` variable if
set"

> +
>      **user.name**
>          Your full name.
>
> +        Default: ``$NAME`` variable if set, otherwise read from
> +        ``/etc/passwd``.
> +
>      **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.
>
> +        Default: not set.
> +
>      **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
> @@ -69,11 +81,15 @@ The available configuration items are described below.
>          ignored, regardless of the location in the mail store directory
>          hierarchy.
>
> +        Default: no tags.

This should be "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.
>
> +        Default: ``deleted;spam``.
> +
>      **maildir.synchronize\_flags**
>          If true, then the following maildir flags (in message filenames)
>          will be synchronized with the corresponding notmuch tags:
> @@ -104,6 +120,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.
>
> +        Default: ``true``.
> +
>  ENVIRONMENT
>  ===========

Cheers,
-Michal

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2014-10-05 12:29 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-10-01 20:20 [PATCH] Add default configuration values to the man page Sergei Shilovsky
2014-10-04  5:40 ` David Bremner
2014-10-05 12:28 ` Michal Sojka

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).