Re: [Patch v3 10/15] man: update man pages for folder: and path: search terms
authorAustin Clements <amdragon@MIT.EDU>
Sun, 9 Mar 2014 03:52:38 +0000 (22:52 +1900)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:00:29 +0000 (10:00 -0800)
a4/caf1141fb2b1a01d9e94e4861fdefc0b24a441 [new file with mode: 0644]

diff --git a/a4/caf1141fb2b1a01d9e94e4861fdefc0b24a441 b/a4/caf1141fb2b1a01d9e94e4861fdefc0b24a441
new file mode 100644 (file)
index 0000000..2c01374
--- /dev/null
@@ -0,0 +1,178 @@
+Return-Path: <amdragon@mit.edu>\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 17EB3431FBD\r
+       for <notmuch@notmuchmail.org>; Sat,  8 Mar 2014 19:52:52 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\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 XvRuHFzq7+py for <notmuch@notmuchmail.org>;\r
+       Sat,  8 Mar 2014 19:52:44 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-2.mit.edu (dmz-mailsec-scanner-2.mit.edu\r
+       [18.9.25.13])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 94B0C431FB6\r
+       for <notmuch@notmuchmail.org>; Sat,  8 Mar 2014 19:52:44 -0800 (PST)\r
+X-AuditID: 1209190d-f79776d000000ce9-8d-531be58a4ae4\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-2.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 7D.BE.03305.A85EB135; Sat,  8 Mar 2014 22:52:42 -0500 (EST)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id s293qeHt011007; \r
+       Sat, 8 Mar 2014 22:52:41 -0500\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s293qdst009916\r
+       (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT);\r
+       Sat, 8 Mar 2014 22:52:40 -0500\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.80)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1WMUn0-000302-Q1; Sat, 08 Mar 2014 22:52:38 -0500\r
+Date: Sat, 8 Mar 2014 22:52:38 -0500\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: jani@nikula.org, David Bremner <david@tethera.net>\r
+Subject: Re: [Patch v3 10/15] man: update man pages for folder: and path:\r
+       search terms\r
+Message-ID: <20140309035238.GN4709@mit.edu>\r
+References: <1394313585-28422-1-git-send-email-david@tethera.net>\r
+       <1394313585-28422-11-git-send-email-david@tethera.net>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <1394313585-28422-11-git-send-email-david@tethera.net>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFuphleLIzCtJLcpLzFFi42IRYrdT0e16Kh1s0LNZyOJGazejRdN0Z4vr\r
+       N2cyOzB73Lr/mt3j2apbzB5bDr1nDmCO4rJJSc3JLEst0rdL4MroP/ORueCYbMWc+yeYGxj/\r
+       iHcxcnJICJhIbD51jBXCFpO4cG89WxcjF4eQwGwmiQv/JrFDOBsYJbbNuMIK4Zxiknh/8zdU\r
+       ZgmjxMx/O1lA+lkEVCR+HTnEDGKzCWhIbNu/nLGLkYNDRMBMYtryWpAws4C0xLffzUwgtrBA\r
+       hMTxed/ZQWxeAW2J9ZNng8WFBKokFu1fwgYRF5Q4OfMJC0SvlsSNfy+ZQEaCzFn+jwMkzCng\r
+       LDHxzi+wraJAF0w5uY1tAqPQLCTds5B0z0LoXsDIvIpRNiW3Sjc3MTOnODVZtzg5MS8vtUjX\r
+       SC83s0QvNaV0EyMo0DkleXcwvjuodIhRgINRiYe3Y4J0sBBrYllxZe4hRkkOJiVR3hMPgEJ8\r
+       SfkplRmJxRnxRaU5qcWHGCU4mJVEeF92AuV4UxIrq1KL8mFS0hwsSuK8fWclgoUE0hNLUrNT\r
+       UwtSi2CyMhwcShK8bMCIFhIsSk1PrUjLzClBSDNxcIIM5wEafvYJyPDigsTc4sx0iPwpRkUp\r
+       cd5nIAkBkERGaR5cLywRvWIUB3pFmPcDSBUPMInBdb8CGswENLj5uBTI4JJEhJRUA+OJcJOX\r
+       f56oT3Z/udV38/eSolnfrjlU9G52expzakFp5+T3vAHBEpFN38/1/286accwgS19+pz/XAHL\r
+       /gWpnXnFFnhlhYZduPsjOZeAilSfY+73PpgW3XIwz3SOV1rPG7lJ9LXm1oBfMj+rpGy3rH99\r
+       +JBuvrhKz6kfuz/KGfFsyT5eJjF1jagSS3FGoqEWc1FxIgCgTPqQHwMAAA==\r
+Cc: notmuch@notmuchmail.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 03:52:52 -0000\r
+\r
+Quoth David Bremner on Mar 08 at  5:19 pm:\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
+Maybe change to folder:<maildir-folder>?\r
+\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
+This isn't bad, but I think it could be more from a user's perspective\r
+without losing the operational details.  What about something like the\r
+following?  This follows much of what the above says, but is\r
+structured somewhat differently and works in some examples.\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\r
+the top-level maildir (and without the leading slash).  By default,\r
+.B path:\r
+matches messages in the specified directory only.  The "/**" suffix\r
+can 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,\r
+this includes messages in the "new" and "cur" subdirectories.  The\r
+exact syntax for maildir folders depends on your mail configuration.\r
+For maildir++, \fBfolder:""\fR matches the inbox folder (which is the\r
+root in maildir++), other folder names always start with ".", and\r
+nested folders are separated by "."s, such as\r
+\fBfolder:.classes.topology\fR.  For "file system" maildir, the inbox\r
+is typically \fBfolder:INBOX\fR and nested folders are separated by\r
+slashes, such as \fBfolder:classes/topology\fR.\r
+\r
+Both\r
+.B path:\r
+and\r
+.B folder:\r
+will find a message if \fIany\fR copy of that message is in the\r
+specific directory/folder.\r
+\r
+>  \r
+>  The\r
+>  .B date:\r