From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [Patch v6 13/14] man: update man pages for folder: and path: search terms
Date: Tue, 11 Mar 2014 20:01:39 -0300 [thread overview]
Message-ID: <1394578900-25618-14-git-send-email-david@tethera.net> (raw)
In-Reply-To: <1394578900-25618-1-git-send-email-david@tethera.net>
From: Jani Nikula <jani@nikula.org>
Text from review by Austin Clements <amdragon@MIT.EDU>.
---
doc/man7/notmuch-search-terms.rst | 32 +++++++++++++++++++++++++-------
1 file changed, 25 insertions(+), 7 deletions(-)
diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
index 20bc6f1..1acdaa0 100644
--- a/doc/man7/notmuch-search-terms.rst
+++ b/doc/man7/notmuch-search-terms.rst
@@ -46,7 +46,9 @@ indicate user-supplied values):
- thread:<thread-id>
-- folder:<directory-path>
+- folder:<maildir-folder>
+
+- path:<directory-path> or path:<directory-path>/**
- date:<since>..<until>
@@ -77,12 +79,28 @@ generated internally by notmuch (and do not appear in email messages).
These thread ID values can be seen in the first column of output from
**notmuch search**
-The **folder:** prefix can be used to search for email message files
-that are contained within particular directories within the mail store.
-If the same email message has multiple message files associated with it,
-it's sufficient for a match that at least one of the files is contained
-within a matching directory. Only the directory components below the
-top-level mail database path are available to be searched.
+The **path:** prefix searches for email messages that are in
+particular directories within the mail store. The directory must be
+specified relative to the top-level maildir (and without the leading
+slash). By default, **path:** matches messages in the specified
+directory only. The "/\*\*" suffix can be used to match messages in
+the specified directory and all its subdirectories recursively.
+**path:""** matches messages in the root of the mail store and,
+likewise, **path:\*\*** matches all messages.
+
+The **folder:** prefix searches for email messages by maildir or MH
+folder. For MH-style folders, this is equivalent to **path:**. For
+maildir, this includes messages in the "new" and "cur"
+subdirectories. The exact syntax for maildir folders depends on your
+mail configuration. For maildir++, **folder:""** matches the inbox
+folder (which is the root in maildir++), other folder names always
+start with ".", and nested folders are separated by "."s, such as
+**folder:.classes.topology**. For "file system" maildir, the inbox is
+typically **folder:INBOX** and nested folders are separated by
+slashes, such as **folder:classes/topology**.
+
+Both **path:** and **folder:** will find a message if *any* copy of
+that message is in the specific directory/folder.
The **date:** prefix can be used to restrict the results to only
messages within a particular time range (based on the Date: header) with
--
1.8.5.3
next prev parent reply other threads:[~2014-03-11 23:02 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-11 23:01 v6 of boolean folder patches David Bremner
2014-03-11 23:01 ` [Patch v6 01/14] test: add utility function to sort a json list David Bremner
2014-03-11 23:01 ` [Patch v6 02/14] test: add notmuch_search_files_sanitize and use it David Bremner
2014-03-11 23:14 ` [PATCH] test: rearrange the test corpus into subfolders, fix tests David Bremner
2014-03-11 23:01 ` [Patch v6 04/14] lib: refactor folder term update after filename removal David Bremner
2014-03-11 23:01 ` [Patch v6 05/14] lib: add support for path: prefix searches David Bremner
2014-03-11 23:01 ` [Patch v6 06/14] test: make insert test use the path: prefix David Bremner
2014-03-11 23:01 ` [Patch v6 07/14] lib: make folder: prefix literal David Bremner
2014-03-11 23:01 ` [Patch v6 08/14] test: add tests for the new boolean folder: and path: prefixes David Bremner
2014-03-11 23:01 ` [Patch v6 09/14] test: add database upgrade test from format version 1 to 2 David Bremner
2014-03-11 23:01 ` [Patch v6 10/14] devel: add script to generate test databases David Bremner
2014-03-11 23:01 ` [Patch v6 11/14] test: commit database checksum, ignore actual databases David Bremner
2014-03-11 23:01 ` [Patch v6 12/14] test: add machinery to download and verify databases David Bremner
2014-03-11 23:01 ` David Bremner [this message]
2014-03-11 23:01 ` [Patch v6 14/14] man: try to clarify the folder: and path: vs. --output=files confusion David Bremner
2014-03-11 23:10 ` v6 of boolean folder patches David Bremner
2014-03-11 23:20 ` Austin Clements
2014-03-12 11:23 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1394578900-25618-14-git-send-email-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).