[Patch v6 13/14] man: update man pages for folder: and path: search terms

diff --git a/9f/002af4a0883cc13c98a52dea2f75e740fcc0b1 b/9f/002af4a0883cc13c98a52dea2f75e740fcc0b1
new file mode 100644 (file)
index 0000000..e31362b
--- /dev/null
+++ b/9f/002af4a0883cc13c98a52dea2f75e740fcc0b1
@@ -0,0 +1,109 @@
+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 174E4429E41\r
+       for <notmuch@notmuchmail.org>; Tue, 11 Mar 2014 16:02:31 -0700 (PDT)\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 JIpzjODNfTdU for <notmuch@notmuchmail.org>;\r
+       Tue, 11 Mar 2014 16:02:27 -0700 (PDT)\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 F11AF431FDC\r
+       for <notmuch@notmuchmail.org>; Tue, 11 Mar 2014 16:02:17 -0700 (PDT)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1WNVgf-0001vP-Fm; Tue, 11 Mar 2014 20:02:17 -0300\r
+Received: (nullmailer pid 25865 invoked by uid 1000); Tue, 11 Mar 2014\r
+       23:01:46 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v6 13/14] man: update man pages for folder: and path: search\r
+       terms\r
+Date: Tue, 11 Mar 2014 20:01:39 -0300\r
+Message-Id: <1394578900-25618-14-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.3\r
+In-Reply-To: <1394578900-25618-1-git-send-email-david@tethera.net>\r
+References: <1394578900-25618-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: Tue, 11 Mar 2014 23:02:31 -0000\r
+\r
+From: Jani Nikula <jani@nikula.org>\r
+\r
+Text from review by Austin Clements <amdragon@MIT.EDU>.\r
+---\r
+ doc/man7/notmuch-search-terms.rst | 32 +++++++++++++++++++++++++-------\r
+ 1 file changed, 25 insertions(+), 7 deletions(-)\r
+\r
+diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst\r
+index 20bc6f1..1acdaa0 100644\r
+--- a/doc/man7/notmuch-search-terms.rst\r
++++ b/doc/man7/notmuch-search-terms.rst\r
+@@ -46,7 +46,9 @@ indicate user-supplied values):\r
+ \r
+ -  thread:<thread-id>\r
+ \r
+--  folder:<directory-path>\r
++-  folder:<maildir-folder>\r
++\r
++-  path:<directory-path> or path:<directory-path>/**\r
+ \r
+ -  date:<since>..<until>\r
+ \r
+@@ -77,12 +79,28 @@ generated internally by notmuch (and do not appear in email messages).\r
+ These thread ID values can be seen in the first column of output from\r
+ **notmuch search**\r
+ \r
+-The **folder:** prefix can be used to search for email message files\r
+-that are contained within particular directories within the mail store.\r
+-If the same email message has multiple message files associated with it,\r
+-it's 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
++The **path:** prefix searches for email messages that are in\r
++particular directories within the mail store. The directory must be\r
++specified relative to the top-level maildir (and without the leading\r
++slash). By default, **path:** matches messages in the specified\r
++directory only. The "/\*\*" suffix can be used to match messages in\r
++the specified directory and all its subdirectories recursively.\r
++**path:""** matches messages in the root of the mail store and,\r
++likewise, **path:\*\*** matches all messages.\r
++\r
++The **folder:** prefix searches for email messages by maildir or MH\r
++folder. For MH-style folders, this is equivalent to **path:**. For\r
++maildir, this includes messages in the "new" and "cur"\r
++subdirectories. The exact syntax for maildir folders depends on your\r
++mail configuration. For maildir++, **folder:""** matches the inbox\r
++folder (which is the root in maildir++), other folder names always\r
++start with ".", and nested folders are separated by "."s, such as\r
++**folder:.classes.topology**. For "file system" maildir, the inbox is\r
++typically **folder:INBOX** and nested folders are separated by\r
++slashes, such as **folder:classes/topology**.\r
++\r
++Both **path:** and **folder:** will find a message if *any* copy of\r
++that message is in the specific directory/folder.\r
+ \r
+ The **date:** prefix can be used to restrict the results to only\r
+ messages within a particular time range (based on the Date: header) with\r
+-- \r
+1.8.5.3\r
+\r