[PATCH v4 09/13] man: update man pages for folder: and path: search terms

diff --git a/0a/b68260f0c57dae22c52be6e03038a89aa1d859 b/0a/b68260f0c57dae22c52be6e03038a89aa1d859
new file mode 100644 (file)
index 0000000..58fcfe6
--- /dev/null
+++ b/0a/b68260f0c57dae22c52be6e03038a89aa1d859
@@ -0,0 +1,139 @@
+Return-Path: <jani@nikula.org>\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 0C045431FC4\r
+       for <notmuch@notmuchmail.org>; Sun,  9 Mar 2014 14:41:58 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 3NjVS4Fb-TE3 for <notmuch@notmuchmail.org>;\r
+       Sun,  9 Mar 2014 14:41:51 -0700 (PDT)\r
+Received: from mail-lb0-f173.google.com (mail-lb0-f173.google.com\r
+       [209.85.217.173]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 0B57E431E62\r
+       for <notmuch@notmuchmail.org>; Sun,  9 Mar 2014 14:41:00 -0700 (PDT)\r
+Received: by mail-lb0-f173.google.com with SMTP id p9so4164631lbv.32\r
+       for <notmuch@notmuchmail.org>; Sun, 09 Mar 2014 14:40:59 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
+       :references:in-reply-to:references;\r
+       bh=8sekKVoQNThAixA2qNh8dnfH53On3qC3rJu2Swo1nEA=;\r
+       b=SXPWcpd0iR+Ij6t7B+DYuWd43H3UagiwRwamBYyFeopAG2m6qiidML9s5vIfMFz9HA\r
+       TXGcJL0ThF4B24KCI63ciX6gGOPGlT+k59MtLeJTjNRJUvvvAebogSCWMYBRenLBQCmH\r
+       tK/kvkyrlKxtLEMfL7fEplOfVW7C5DAcupqzxwkdB3NDiiQ0R+8lXP20+qOQm7k9Wo4s\r
+       Y6461tYHMRtaqddubJod6Gx88J9Msn602vArDHJtThwl4rk3NhbUGgH23VqHIv5jL3Or\r
+       Ra3gBnmB3uTWJBa7KNGWPHpeEj3xGLFkrAg8bAUYMaok2W/K65YM1+q3gZBZz3hcar9M\r
+       Zg6w==\r
+X-Gm-Message-State:\r
+ ALoCoQkYu5JLAI6wCnIn5HC2UIT7F7hjwnfq5Lie5TBGwW6R92RGyLbN/2NjxVtvEiW4KTg//g9s\r
+X-Received: by 10.152.43.47 with SMTP id t15mr247335lal.38.1394401259581;\r
+       Sun, 09 Mar 2014 14:40:59 -0700 (PDT)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91])\r
+       by mx.google.com with ESMTPSA id ir3sm26921290lac.9.2014.03.09.14.40.58\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sun, 09 Mar 2014 14:40:58 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v4 09/13] man: update man pages for folder: and path: search\r
+       terms\r
+Date: Sun,  9 Mar 2014 23:40:30 +0200\r
+Message-Id:\r
+ <ab386522dfd5acc6db6fe6ff23238ed8c56d02dd.1394400503.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.9.0\r
+In-Reply-To: <cover.1394400503.git.jani@nikula.org>\r
+References: <cover.1394400503.git.jani@nikula.org>\r
+In-Reply-To: <cover.1394400503.git.jani@nikula.org>\r
+References: <cover.1394400503.git.jani@nikula.org>\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: Sun, 09 Mar 2014 21:41:58 -0000\r
+\r
+Text from review by Austin Clements <amdragon@MIT.EDU>.\r
+---\r
+ man/man7/notmuch-search-terms.7 | 41 ++++++++++++++++++++++++++++++++++-------\r
+ 1 file changed, 34 insertions(+), 7 deletions(-)\r
+\r
+diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7\r
+index a768b630a4d1..a33c8d78c122 100644\r
+--- a/man/man7/notmuch-search-terms.7\r
++++ b/man/man7/notmuch-search-terms.7\r
+@@ -52,7 +52,9 @@ terms to match against specific portions of an email, (where\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
+@@ -100,13 +102,38 @@ thread ID values can be seen in the first column of output from\r
+ .B "notmuch search"\r
+ \r
+ The\r
++.B path:\r
++prefix searches for email messages that are in particular directories\r
++within the mail store. The directory must be specified relative to the\r
++top-level maildir (and without the leading slash). By default,\r
++.B path:\r
++matches messages in the specified directory only. The "/**" suffix can\r
++be used to match messages in the specified directory and all its\r
++subdirectories recursively.\r
++.B path:""\r
++matches messages in the root of the mail store and, likewise,\r
++.B path:**\r
++matches all messages.\r
++\r
++The\r
++.B folder:\r
++prefix searches for email messages by maildir or MH folder. For\r
++MH-style folders, this is equivalent to \fBpath:\fR. For maildir, this\r
++includes messages in the "new" and "cur" subdirectories. The exact\r
++syntax for maildir folders depends on your mail configuration. For\r
++maildir++, \fBfolder:""\fR matches the inbox folder (which is the root\r
++in maildir++), other folder names always start with ".", and nested\r
++folders are separated by "."s, such as \fBfolder:.classes.topology\fR.\r
++For "file system" maildir, the inbox is typically \fBfolder:INBOX\fR\r
++and nested folders are separated by slashes, such as\r
++\fBfolder:classes/topology\fR.\r
++\r
++Both\r
++.B path:\r
++and\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
++will find a message if \fIany\fR copy of that message is in the\r
++specific directory/folder.\r
+ \r
+ The\r
+ .B date:\r
+-- \r
+1.9.0\r
+\r