From: Michal Sojka Date: Sun, 5 Oct 2014 12:28:50 +0000 (+0200) Subject: Re: [PATCH] Add default configuration values to the man page X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=ea058d42f0f137acd95054f2a1db17fbf93b70af;p=notmuch-archives.git Re: [PATCH] Add default configuration values to the man page --- diff --git a/ee/cdda9555e46563e2b9a6be852b611cb9294a89 b/ee/cdda9555e46563e2b9a6be852b611cb9294a89 new file mode 100644 index 000000000..65e815aa6 --- /dev/null +++ b/ee/cdda9555e46563e2b9a6be852b611cb9294a89 @@ -0,0 +1,133 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 1DF5C431FB6 + for ; Sun, 5 Oct 2014 05:29:08 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -2.3 +X-Spam-Level: +X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id HXKYlX87YRKu for ; + Sun, 5 Oct 2014 05:29:02 -0700 (PDT) +Received: from max.feld.cvut.cz (max.feld.cvut.cz [147.32.192.36]) + by olra.theworths.org (Postfix) with ESMTP id 7E915431FAE + for ; Sun, 5 Oct 2014 05:29:02 -0700 (PDT) +Received: from localhost (unknown [192.168.200.7]) + by max.feld.cvut.cz (Postfix) with ESMTP id AE5D43CFEE4; + Sun, 5 Oct 2014 14:28:57 +0200 (CEST) +X-Virus-Scanned: IMAP STYX AMAVIS +Received: from max.feld.cvut.cz ([192.168.200.1]) + by localhost (styx.feld.cvut.cz [192.168.200.7]) (amavisd-new, + port 10044) + with ESMTP id WMsIIBee3qVa; Sun, 5 Oct 2014 14:28:52 +0200 (CEST) +Received: from imap.feld.cvut.cz (imap.feld.cvut.cz [147.32.192.34]) + by max.feld.cvut.cz (Postfix) with ESMTP id D344C3CFE86; + Sun, 5 Oct 2014 14:28:51 +0200 (CEST) +Received: from wsh by steelpick.2x.cz with local (Exim 4.84) + (envelope-from ) + id 1Xakvi-0000OJ-4B; Sun, 05 Oct 2014 14:28:50 +0200 +From: Michal Sojka +To: Sergei Shilovsky , notmuch@notmuchmail.org +Subject: Re: [PATCH] Add default configuration values to the man page +In-Reply-To: <1412194841-24303-1-git-send-email-sshilovsky@gmail.com> +References: <1412194841-24303-1-git-send-email-sshilovsky@gmail.com> +User-Agent: Notmuch/0.18.1+101~g56b0ff0 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Sun, 05 Oct 2014 14:28:50 +0200 +Message-ID: <87oatq66pp.fsf@steelpick.2x.cz> +MIME-Version: 1.0 +Content-Type: text/plain +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 05 Oct 2014 12:29:08 -0000 + +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