[Patch v3 10/15] man: update man pages for folder: and path: search terms
[notmuch-archives.git] / 5a / 855939a79bc1963c15365cb44582a8c95ef1f8
diff --git a/5a/855939a79bc1963c15365cb44582a8c95ef1f8 b/5a/855939a79bc1963c15365cb44582a8c95ef1f8
new file mode 100644 (file)
index 0000000..5c6e258
--- /dev/null
@@ -0,0 +1,104 @@
+Return-Path: <bremner@tethera.net>\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 1A550429E35\r
+       for <notmuch@notmuchmail.org>; Sat,  8 Mar 2014 13:21:26 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 8t4PW3+fg3bb for <notmuch@notmuchmail.org>;\r
+       Sat,  8 Mar 2014 13:21:20 -0800 (PST)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 570E3431FC0\r
+       for <notmuch@notmuchmail.org>; Sat,  8 Mar 2014 13:20:44 -0800 (PST)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1WMOfj-00059W-Px; Sat, 08 Mar 2014 17:20:43 -0400\r
+Received: (nullmailer pid 28546 invoked by uid 1000); Sat, 08 Mar 2014\r
+       21:20:03 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v3 10/15] man: update man pages for folder: and path: search\r
+       terms\r
+Date: Sat,  8 Mar 2014 17:19:40 -0400\r
+Message-Id: <1394313585-28422-11-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.3\r
+In-Reply-To: <1394313585-28422-1-git-send-email-david@tethera.net>\r
+References: <1394313585-28422-1-git-send-email-david@tethera.net>\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: Sat, 08 Mar 2014 21:21:26 -0000\r
+\r
+From: Jani Nikula <jani@nikula.org>\r
+\r
+---\r
+ man/man7/notmuch-search-terms.7 | 28 ++++++++++++++++++++++------\r
+ 1 file changed, 22 insertions(+), 6 deletions(-)\r
+\r
+diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7\r
+index a768b63..907403d 100644\r
+--- a/man/man7/notmuch-search-terms.7\r
++++ b/man/man7/notmuch-search-terms.7\r
+@@ -54,6 +54,8 @@ terms to match against specific portions of an email, (where\r
\r
+       folder:<directory-path>\r
\r
++      path:<directory-path> or path:<directory-path>/**\r
++\r
+       date:<since>..<until>\r
\r
+ The\r
+@@ -101,12 +103,26 @@ thread ID values can be seen in the first column of output from\r
\r
+ The\r
+ .B folder:\r
+-prefix can be used to search for email message files that are\r
+-contained within particular directories within the mail store. If the\r
+-same email message has multiple message files associated with it, it's\r
+-sufficient for a match that at least one of the files is contained\r
+-within a matching directory. Only the directory components below the\r
+-top-level mail database path are available to be searched.\r
++and\r
++.B path:\r
++prefixes can be used to search for email message files that are\r
++contained within particular directories within the mail store. The\r
++directories are specified relative from the top-level mail database\r
++path, and thus only the directory components below that are available\r
++to be searched.\r
++\r
++The\r
++.B folder:\r
++prefix matches messages in the specified maildir folder, i.e. in the\r
++specified directory and its "new" and "cur" subdirectories. The\r
++.B path:\r
++prefix matches messages in the specified directory only, unless the\r
++"/**" suffix is used to denote the specified directory and all its\r
++subdirectories recursively. For both, the empty string "" matches the\r
++top level maildir folder or directory. If the same email message has\r
++multiple message files associated with it, it's sufficient for a match\r
++that at least one of the files is contained within a matching\r
++directory.\r
\r
+ The\r
+ .B date:\r
+-- \r
+1.8.5.3\r
+\r