[PATCH v5] man: update man pages for folder: and path: search terms
authorJani Nikula <jani@nikula.org>
Mon, 10 Mar 2014 06:25:44 +0000 (08:25 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:00:33 +0000 (10:00 -0800)
be/51d9e0a7877e893b2ab9cef65b0a7def127ebf [new file with mode: 0644]

diff --git a/be/51d9e0a7877e893b2ab9cef65b0a7def127ebf b/be/51d9e0a7877e893b2ab9cef65b0a7def127ebf
new file mode 100644 (file)
index 0000000..0342b30
--- /dev/null
@@ -0,0 +1,126 @@
+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 2CF48431FBF\r
+       for <notmuch@notmuchmail.org>; Sun,  9 Mar 2014 23:25:53 -0700 (PDT)\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 oV3xokSFmfHC for <notmuch@notmuchmail.org>;\r
+       Sun,  9 Mar 2014 23:25:47 -0700 (PDT)\r
+Received: from mail-ee0-f48.google.com (mail-ee0-f48.google.com\r
+ [74.125.83.48])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ 7CAEC431FBD   for <notmuch@notmuchmail.org>; Sun,  9 Mar 2014 23:25:47 -0700\r
+ (PDT)\r
+Received: by mail-ee0-f48.google.com with SMTP id e51so2880414eek.7\r
+       for <notmuch@notmuchmail.org>; Sun, 09 Mar 2014 23:25:46 -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;\r
+       bh=HygLmH+8KJLELkTShvSszvxOEyRKq+mIMLehAMe0at8=;\r
+       b=gzvk5XJlvGB4DFzOZ8iZpoBEwyf/KsFYA/9+W0i6Cs4WR/oLKMWXsJnUUYuvP2sRF/\r
+       Rb92MT5vaOHpnLSo6wE30MGSwgztEP7JziyerJ+1Y8/SJntZ2FHFZZjs0SCb3Zdxmkd/\r
+       AVaDqLZCeFtLVMFD0zMLRUzSHPyWSgyAue+eackeNf0Z/Y98Iu9uC276TEgfFDyp5Fkv\r
+       9vbOhvt+nj7oRWEWHC8TlGqZbKViK64/kNSWbW9bzBqNM5iIH7ygQhypdxSfo5aWM8dI\r
+       0rLrgN7eCuPAhjhJnlVLQw2pzQHmbiEAsPT+pnj5ygSQGsQs+S81JNY8VHwTXKHPKcG/\r
+       aH9w==\r
+X-Gm-Message-State:\r
+ ALoCoQnSG3DraDLnmGDCE0mmNRMnmVyjfcELblPBEJMdOR0jC1UFvzIxVC0Vnk98wzVH9S7FKJhU\r
+X-Received: by 10.14.251.5 with SMTP id a5mr115131ees.108.1394432746271;\r
+       Sun, 09 Mar 2014 23:25:46 -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 m8sm41198444eef.14.2014.03.09.23.25.44\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sun, 09 Mar 2014 23:25:45 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v5] man: update man pages for folder: and path: search terms\r
+Date: Mon, 10 Mar 2014 08:25:44 +0200\r
+Message-Id: <1394432744-3404-1-git-send-email-jani@nikula.org>\r
+X-Mailer: git-send-email 1.9.0\r
+In-Reply-To:\r
+ <ab386522dfd5acc6db6fe6ff23238ed8c56d02dd.1394400503.git.jani@nikula.org>\r
+References:\r
+ <ab386522dfd5acc6db6fe6ff23238ed8c56d02dd.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: Mon, 10 Mar 2014 06:25:53 -0000\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 20bc6f1e1488..1acdaa0b38de 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.9.0\r
+\r