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