]> git.notmuchmail.org Git - notmuch/commitdiff
doc: add a section on quoting to notmuch-search-terms(7)
authorDavid Bremner <david@tethera.net>
Sat, 7 Apr 2018 22:10:51 +0000 (19:10 -0300)
committerDavid Bremner <david@tethera.net>
Wed, 25 Apr 2018 02:08:10 +0000 (23:08 -0300)
I think we've diverged enough from the Xapian query parser
that we can't rely on that syntax description [1]. As far as I can
tell, [1] also only discusses quotes in the context of phrases.

[1]: https://xapian.org/docs/queryparser.html

doc/man7/notmuch-search-terms.rst

index b4d784a300582e083a6cd0be2e97669c33e02bba..248444e3cf989684387cd927aab8361ee996beae 100644 (file)
@@ -42,7 +42,7 @@ of the prefixes with <regex> forms can be also used to restrict the
 results to those whose value matches a regular expression (see
 **regex(7)**) delimited with //, for example::
 
-   notmuch search 'from:/bob@.*[.]example[.]com/'
+   notmuch search 'from:"/bob@.*[.]example[.]com/"'
 
 from:<name-or-address> or from:/<regex>/
     The **from:** prefix is used to match the name or address of
@@ -273,6 +273,28 @@ Both of these will match a subject "Free Delicious Pizza" while
 
 will not.
 
+Quoting
+-------
+
+Double quotes are also used by the notmuch query parser to protect
+boolean terms or regular expressions containing spaces or other
+special characters, e.g.
+
+::
+
+   tag:"a tag"
+
+::
+
+   folder:"/^.*/(Junk|Spam)$/"
+
+As with phrases, you need to protect the double quotes from the shell
+e.g.
+
+::
+
+   % notmuch search 'folder:"/^.*/(Junk|Spam)$/"'
+
 DATE AND TIME SEARCH
 ====================