Return-Path: <jani@nikula.org>
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 0C045431FC4
	for <notmuch@notmuchmail.org>; Sun,  9 Mar 2014 14:41:58 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"
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 3NjVS4Fb-TE3 for <notmuch@notmuchmail.org>;
	Sun,  9 Mar 2014 14:41:51 -0700 (PDT)
Received: from mail-lb0-f173.google.com (mail-lb0-f173.google.com
	[209.85.217.173]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id 0B57E431E62
	for <notmuch@notmuchmail.org>; Sun,  9 Mar 2014 14:41:00 -0700 (PDT)
Received: by mail-lb0-f173.google.com with SMTP id p9so4164631lbv.32
	for <notmuch@notmuchmail.org>; Sun, 09 Mar 2014 14:40:59 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
	d=1e100.net; s=20130820;
	h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
	:references:in-reply-to:references;
	bh=8sekKVoQNThAixA2qNh8dnfH53On3qC3rJu2Swo1nEA=;
	b=SXPWcpd0iR+Ij6t7B+DYuWd43H3UagiwRwamBYyFeopAG2m6qiidML9s5vIfMFz9HA
	TXGcJL0ThF4B24KCI63ciX6gGOPGlT+k59MtLeJTjNRJUvvvAebogSCWMYBRenLBQCmH
	tK/kvkyrlKxtLEMfL7fEplOfVW7C5DAcupqzxwkdB3NDiiQ0R+8lXP20+qOQm7k9Wo4s
	Y6461tYHMRtaqddubJod6Gx88J9Msn602vArDHJtThwl4rk3NhbUGgH23VqHIv5jL3Or
	Ra3gBnmB3uTWJBa7KNGWPHpeEj3xGLFkrAg8bAUYMaok2W/K65YM1+q3gZBZz3hcar9M
	Zg6w==
X-Gm-Message-State:
 ALoCoQkYu5JLAI6wCnIn5HC2UIT7F7hjwnfq5Lie5TBGwW6R92RGyLbN/2NjxVtvEiW4KTg//g9s
X-Received: by 10.152.43.47 with SMTP id t15mr247335lal.38.1394401259581;
	Sun, 09 Mar 2014 14:40:59 -0700 (PDT)
Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.
	[88.195.111.91])
	by mx.google.com with ESMTPSA id ir3sm26921290lac.9.2014.03.09.14.40.58
	for <multiple recipients>
	(version=TLSv1.2 cipher=RC4-SHA bits=128/128);
	Sun, 09 Mar 2014 14:40:58 -0700 (PDT)
From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH v4 09/13] man: update man pages for folder: and path: search
	terms
Date: Sun,  9 Mar 2014 23:40:30 +0200
Message-Id:
 <ab386522dfd5acc6db6fe6ff23238ed8c56d02dd.1394400503.git.jani@nikula.org>
X-Mailer: git-send-email 1.9.0
In-Reply-To: <cover.1394400503.git.jani@nikula.org>
References: <cover.1394400503.git.jani@nikula.org>
In-Reply-To: <cover.1394400503.git.jani@nikula.org>
References: <cover.1394400503.git.jani@nikula.org>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sun, 09 Mar 2014 21:41:58 -0000

Text from review by Austin Clements <amdragon@MIT.EDU>.
---
 man/man7/notmuch-search-terms.7 | 41 ++++++++++++++++++++++++++++++++++-------
 1 file changed, 34 insertions(+), 7 deletions(-)

diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7
index a768b630a4d1..a33c8d78c122 100644
--- a/man/man7/notmuch-search-terms.7
+++ b/man/man7/notmuch-search-terms.7
@@ -52,7 +52,9 @@ terms to match against specific portions of an email, (where
 
 	thread:<thread-id>
 
-	folder:<directory-path>
+	folder:<maildir-folder>
+
+	path:<directory-path> or path:<directory-path>/**
 
 	date:<since>..<until>
 
@@ -100,13 +102,38 @@ thread ID values can be seen in the first column of output from
 .B "notmuch search"
 
 The
+.B path:
+prefix searches for email messages that are in particular directories
+within the mail store. The directory must be specified relative to the
+top-level maildir (and without the leading slash). By default,
+.B path:
+matches messages in the specified directory only. The "/**" suffix can
+be used to match messages in the specified directory and all its
+subdirectories recursively.
+.B path:""
+matches messages in the root of the mail store and, likewise,
+.B path:**
+matches all messages.
+
+The
+.B folder:
+prefix searches for email messages by maildir or MH folder. For
+MH-style folders, this is equivalent to \fBpath:\fR. For maildir, this
+includes messages in the "new" and "cur" subdirectories. The exact
+syntax for maildir folders depends on your mail configuration. For
+maildir++, \fBfolder:""\fR matches the inbox folder (which is the root
+in maildir++), other folder names always start with ".", and nested
+folders are separated by "."s, such as \fBfolder:.classes.topology\fR.
+For "file system" maildir, the inbox is typically \fBfolder:INBOX\fR
+and nested folders are separated by slashes, such as
+\fBfolder:classes/topology\fR.
+
+Both
+.B path:
+and
 .B folder:
-prefix can be used to search for email message files that are
-contained within particular directories within the mail store. If the
-same email message has multiple message files associated with it, it's
-sufficient for a match that at least one of the files is contained
-within a matching directory. Only the directory components below the
-top-level mail database path are available to be searched.
+will find a message if \fIany\fR copy of that message is in the
+specific directory/folder.
 
 The
 .B date:
-- 
1.9.0