Re: [PATCH 0/4] Allow specifying alternate names for addresses in other_email
[notmuch-archives.git] / 9f / 002af4a0883cc13c98a52dea2f75e740fcc0b1
1 Return-Path: <bremner@tethera.net>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5         by olra.theworths.org (Postfix) with ESMTP id 174E4429E41\r
6         for <notmuch@notmuchmail.org>; Tue, 11 Mar 2014 16:02:31 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: 0\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
12         autolearn=disabled\r
13 Received: from olra.theworths.org ([127.0.0.1])\r
14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
15         with ESMTP id JIpzjODNfTdU for <notmuch@notmuchmail.org>;\r
16         Tue, 11 Mar 2014 16:02:27 -0700 (PDT)\r
17 Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
18         (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
19         (No client certificate requested)\r
20         by olra.theworths.org (Postfix) with ESMTPS id F11AF431FDC\r
21         for <notmuch@notmuchmail.org>; Tue, 11 Mar 2014 16:02:17 -0700 (PDT)\r
22 Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
23         (envelope-from <bremner@tethera.net>)\r
24         id 1WNVgf-0001vP-Fm; Tue, 11 Mar 2014 20:02:17 -0300\r
25 Received: (nullmailer pid 25865 invoked by uid 1000); Tue, 11 Mar 2014\r
26         23:01:46 -0000\r
27 From: David Bremner <david@tethera.net>\r
28 To: notmuch@notmuchmail.org\r
29 Subject: [Patch v6 13/14] man: update man pages for folder: and path: search\r
30         terms\r
31 Date: Tue, 11 Mar 2014 20:01:39 -0300\r
32 Message-Id: <1394578900-25618-14-git-send-email-david@tethera.net>\r
33 X-Mailer: git-send-email 1.8.5.3\r
34 In-Reply-To: <1394578900-25618-1-git-send-email-david@tethera.net>\r
35 References: <1394578900-25618-1-git-send-email-david@tethera.net>\r
36 X-BeenThere: notmuch@notmuchmail.org\r
37 X-Mailman-Version: 2.1.13\r
38 Precedence: list\r
39 List-Id: "Use and development of the notmuch mail system."\r
40         <notmuch.notmuchmail.org>\r
41 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
42         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
43 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
44 List-Post: <mailto:notmuch@notmuchmail.org>\r
45 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
46 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
47         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
48 X-List-Received-Date: Tue, 11 Mar 2014 23:02:31 -0000\r
49 \r
50 From: Jani Nikula <jani@nikula.org>\r
51 \r
52 Text from review by Austin Clements <amdragon@MIT.EDU>.\r
53 ---\r
54  doc/man7/notmuch-search-terms.rst | 32 +++++++++++++++++++++++++-------\r
55  1 file changed, 25 insertions(+), 7 deletions(-)\r
56 \r
57 diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst\r
58 index 20bc6f1..1acdaa0 100644\r
59 --- a/doc/man7/notmuch-search-terms.rst\r
60 +++ b/doc/man7/notmuch-search-terms.rst\r
61 @@ -46,7 +46,9 @@ indicate user-supplied values):\r
62  \r
63  -  thread:<thread-id>\r
64  \r
65 --  folder:<directory-path>\r
66 +-  folder:<maildir-folder>\r
67 +\r
68 +-  path:<directory-path> or path:<directory-path>/**\r
69  \r
70  -  date:<since>..<until>\r
71  \r
72 @@ -77,12 +79,28 @@ generated internally by notmuch (and do not appear in email messages).\r
73  These thread ID values can be seen in the first column of output from\r
74  **notmuch search**\r
75  \r
76 -The **folder:** prefix can be used to search for email message files\r
77 -that are contained within particular directories within the mail store.\r
78 -If the same email message has multiple message files associated with it,\r
79 -it's sufficient for a match that at least one of the files is contained\r
80 -within a matching directory. Only the directory components below the\r
81 -top-level mail database path are available to be searched.\r
82 +The **path:** prefix searches for email messages that are in\r
83 +particular directories within the mail store. The directory must be\r
84 +specified relative to the top-level maildir (and without the leading\r
85 +slash). By default, **path:** matches messages in the specified\r
86 +directory only. The "/\*\*" suffix can be used to match messages in\r
87 +the specified directory and all its subdirectories recursively.\r
88 +**path:""** matches messages in the root of the mail store and,\r
89 +likewise, **path:\*\*** matches all messages.\r
90 +\r
91 +The **folder:** prefix searches for email messages by maildir or MH\r
92 +folder. For MH-style folders, this is equivalent to **path:**. For\r
93 +maildir, this includes messages in the "new" and "cur"\r
94 +subdirectories. The exact syntax for maildir folders depends on your\r
95 +mail configuration. For maildir++, **folder:""** matches the inbox\r
96 +folder (which is the root in maildir++), other folder names always\r
97 +start with ".", and nested folders are separated by "."s, such as\r
98 +**folder:.classes.topology**. For "file system" maildir, the inbox is\r
99 +typically **folder:INBOX** and nested folders are separated by\r
100 +slashes, such as **folder:classes/topology**.\r
101 +\r
102 +Both **path:** and **folder:** will find a message if *any* copy of\r
103 +that message is in the specific directory/folder.\r
104  \r
105  The **date:** prefix can be used to restrict the results to only\r
106  messages within a particular time range (based on the Date: header) with\r
107 -- \r
108 1.8.5.3\r
109 \r