--- /dev/null
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 5D786431FC2\r
+ for <notmuch@notmuchmail.org>; Sat, 25 Feb 2012 19:35:18 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+ tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id fILIvMQ0RZnh for <notmuch@notmuchmail.org>;\r
+ Sat, 25 Feb 2012 19:35:17 -0800 (PST)\r
+Received: from mail-lpp01m010-f53.google.com (mail-lpp01m010-f53.google.com\r
+ [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id E8FDA431FBF\r
+ for <notmuch@notmuchmail.org>; Sat, 25 Feb 2012 19:35:16 -0800 (PST)\r
+Received: by lahd3 with SMTP id d3so4325973lah.26\r
+ for <notmuch@notmuchmail.org>; Sat, 25 Feb 2012 19:35:15 -0800 (PST)\r
+Received-SPF: pass (google.com: domain of jani@nikula.org designates\r
+ 10.152.130.102 as permitted sender) client-ip=10.152.130.102; \r
+Authentication-Results: mr.google.com;\r
+ spf=pass (google.com: domain of jani@nikula.org\r
+ designates 10.152.130.102 as permitted sender)\r
+ smtp.mail=jani@nikula.org\r
+Received: from mr.google.com ([10.152.130.102])\r
+ by 10.152.130.102 with SMTP id od6mr6895966lab.14.1330227315527\r
+ (num_hops = 1); Sat, 25 Feb 2012 19:35:15 -0800 (PST)\r
+MIME-Version: 1.0\r
+Received: by 10.152.130.102 with SMTP id od6mr5307357lab.14.1330208625367;\r
+ Sat, 25 Feb 2012 14:23:45 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw4-fe50f800-253.dhcp.inet.fi.\r
+ [84.248.80.253])\r
+ by mx.google.com with ESMTPS id nq2sm8688271lab.4.2012.02.25.14.23.43\r
+ (version=SSLv3 cipher=OTHER); Sat, 25 Feb 2012 14:23:44 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] man: document the notmuch configuration settings in\r
+ notmuch-config(1)\r
+Date: Sun, 26 Feb 2012 00:23:41 +0200\r
+Message-Id: <1330208621-7462-1-git-send-email-jani@nikula.org>\r
+X-Mailer: git-send-email 1.7.5.4\r
+X-Gm-Message-State:\r
+ ALoCoQl7KP/J1aGYM3falj0hzlykXAVWn8VU+isF1inTVfRtSrsZLVkKtyw42OImj64BpddMgWs6\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 26 Feb 2012 03:35:18 -0000\r
+\r
+At the risk of duplication between the man page and the configuration\r
+file generated by default, document the notmuch configuration options\r
+in the notmuch config man page.\r
+\r
+Existing users of notmuch should not be expected to re-generate their\r
+config file in order to get access to the documentation for new\r
+configuration options.\r
+\r
+Include some minor fixes and cleanups while at it.\r
+---\r
+ man/man1/notmuch-config.1 | 125 ++++++++++++++++++++++++++++++++++++++------\r
+ 1 files changed, 108 insertions(+), 17 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-config.1 b/man/man1/notmuch-config.1\r
+index cb3234f..0260eb7 100644\r
+--- a/man/man1/notmuch-config.1\r
++++ b/man/man1/notmuch-config.1\r
+@@ -1,6 +1,6 @@\r
+ .TH NOTMUCH-CONFIG 1 2011-12-04 "Notmuch 0.10.2"\r
+ .SH NAME\r
+-notmuch-config \- Output a single part of a multipart MIME message.\r
++notmuch-config \- Access notmuch configuration file.\r
+ .SH SYNOPSIS\r
+ \r
+ .B notmuch config get\r
+@@ -16,34 +16,125 @@ The\r
+ command can be used to get or set settings in the notmuch\r
+ configuration file.\r
+ \r
+-.SS GET\r
+-\r
++.RS 4\r
++.TP 4\r
++.B get\r
+ The value of the specified configuration item is printed to stdout. If\r
+-the item has multiple values, each value is separated by a newline\r
+-character.\r
++the item has multiple values (it is a list), each value is separated\r
++by a newline character.\r
++.RE\r
+ \r
+-Available configuration items include at least\r
++.RS 4\r
++.TP 4\r
++.B set\r
++The specified configuration item is set to the given value. To specify\r
++a multiple-value item (a list), provide each value as a separate\r
++command-line argument.\r
+ \r
+- database.path\r
++If no values are provided, the specified configuration item will be\r
++removed from the configuration file.\r
++.RE\r
+ \r
+- user.name\r
++The available configuration items are described below.\r
+ \r
+- user.primary_email\r
++.RS 4\r
++.TP 4\r
++.B database.path\r
++The top-level directory where your mail currently exists and to where\r
++mail will be delivered in the future. Files should be individual email\r
++messages. Notmuch will store its database within a sub-directory of\r
++the path configured here named\r
++.BR ".notmuch".\r
++.RE\r
+ \r
+- user.other_email\r
++.RS 4\r
++.TP 4\r
++.B user.name\r
++Your full name.\r
++.RE\r
+ \r
+- new.tags\r
++.RS 4\r
++.TP 4\r
++.B user.primary_email\r
++Your primary email address.\r
++.RE\r
+ \r
+-.SS SET\r
++.RS 4\r
++.TP 4\r
++.B user.other_email\r
++A list of other email addresses at which you receive email.\r
++.RE\r
+ \r
+-The specified configuration item is set to the given value. To\r
+-specify a multiple-value item, provide each value as a separate\r
+-command-line argument.\r
++.RS 4\r
++.TP 4\r
++.B new.tags\r
++A list of tags that will be added to all messages incorporated by\r
++.BR "notmuch new".\r
++.RE\r
+ \r
+-If no values are provided, the specified configuration item will be\r
+-removed from the configuration file.\r
++.RS 4\r
++.TP 4\r
++.B new.ignore\r
++A list of file and directory names, without path, that will not be\r
++searched for messages by\r
++.BR "notmuch new".\r
++All the files and directories matching any of the names specified here\r
++will be ignored, regardless of the location in the mail store\r
++directory hierarchy.\r
+ .RE\r
+ \r
++.RS 4\r
++.TP 4\r
++.B search.exclude\r
++A list of tags that will be excluded from search results by\r
++default. Using an excluded tag in a query will override that\r
++exclusion.\r
++.RE\r
++\r
++.RS 4\r
++.TP 4\r
++.B maildir.synchronize_flags\r
++If true, then the following maildir flags (in message filenames) will\r
++be synchronized with the corresponding notmuch tags:\r
++\r
++ Flag Tag\r
++ ---- -------\r
++ D draft\r
++ F flagged\r
++ P passed\r
++ R replied\r
++ S unread (added when 'S' flag is not present)\r
++\r
++The\r
++.B notmuch new\r
++command will notice flag changes in filenames and update tags, while\r
++the\r
++.B notmuch tag\r
++and\r
++.B notmuch restore\r
++commands will notice tag changes and update flags in filenames.\r
++\r
++If there have been any changes in the maildir (new messages added, old\r
++ones removed or renamed, maildir flags changed, etc.), it is advisable\r
++to run\r
++.B notmuch new\r
++before\r
++.B notmuch tag\r
++or\r
++.B notmuch restore\r
++commands to ensure the tag changes are properly synchronized to the\r
++maildir flags, as the commands expect the database and maildir to be\r
++in sync.\r
++.RE\r
++\r
++.RE\r
++.SH ENVIRONMENT\r
++The following environment variables can be used to control the\r
++behavior of notmuch.\r
++.TP\r
++.B NOTMUCH_CONFIG\r
++Specifies the location of the notmuch configuration file. Notmuch will\r
++use ${HOME}/.notmuch\-config if this variable is not set.\r
+ .SH SEE ALSO\r
+ \r
+ \fBnotmuch\fR(1), \fBnotmuch-count\fR(1),\r
+-- \r
+1.7.5.4\r
+\r
projects / notmuch-archives.git / commitdiff