Return-Path: <bremner@tethera.net>
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 1A550429E35
	for <notmuch@notmuchmail.org>; Sat,  8 Mar 2014 13:21:26 -0800 (PST)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 0
X-Spam-Level: 
X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]
	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 8t4PW3+fg3bb for <notmuch@notmuchmail.org>;
	Sat,  8 Mar 2014 13:21:20 -0800 (PST)
Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])
	(using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id 570E3431FC0
	for <notmuch@notmuchmail.org>; Sat,  8 Mar 2014 13:20:44 -0800 (PST)
Received: from remotemail by yantan.tethera.net with local (Exim 4.80)
	(envelope-from <bremner@tethera.net>)
	id 1WMOfj-00059W-Px; Sat, 08 Mar 2014 17:20:43 -0400
Received: (nullmailer pid 28546 invoked by uid 1000); Sat, 08 Mar 2014
	21:20:03 -0000
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [Patch v3 10/15] man: update man pages for folder: and path: search
	terms
Date: Sat,  8 Mar 2014 17:19:40 -0400
Message-Id: <1394313585-28422-11-git-send-email-david@tethera.net>
X-Mailer: git-send-email 1.8.5.3
In-Reply-To: <1394313585-28422-1-git-send-email-david@tethera.net>
References: <1394313585-28422-1-git-send-email-david@tethera.net>
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: Sat, 08 Mar 2014 21:21:26 -0000

From: Jani Nikula <jani@nikula.org>

---
 man/man7/notmuch-search-terms.7 | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7
index a768b63..907403d 100644
--- a/man/man7/notmuch-search-terms.7
+++ b/man/man7/notmuch-search-terms.7
@@ -54,6 +54,8 @@ terms to match against specific portions of an email, (where
 
 	folder:<directory-path>
 
+	path:<directory-path> or path:<directory-path>/**
+
 	date:<since>..<until>
 
 The
@@ -101,12 +103,26 @@ thread ID values can be seen in the first column of output from
 
 The
 .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.
+and
+.B path:
+prefixes can be used to search for email message files that are
+contained within particular directories within the mail store. The
+directories are specified relative from the top-level mail database
+path, and thus only the directory components below that are available
+to be searched.
+
+The
+.B folder:
+prefix matches messages in the specified maildir folder, i.e. in the
+specified directory and its "new" and "cur" subdirectories. The
+.B path:
+prefix matches messages in the specified directory only, unless the
+"/**" suffix is used to denote the specified directory and all its
+subdirectories recursively. For both, the empty string "" matches the
+top level maildir folder or directory. 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.
 
 The
 .B date:
-- 
1.8.5.3