[PATCH] doc: add a section on quoting to notmuch-search-terms(7)

[Daniel Kahn Gillmor]

On Sat 2018-04-07 19:10:51 -0300, David Bremner wrote:
> 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 | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>
> diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
> index b4d784a3..a4e5abfc 100644
> --- a/doc/man7/notmuch-search-terms.rst
> +++ b/doc/man7/notmuch-search-terms.rst
> @@ -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 will probably have to protect the double quotes
> +from the shell e.g.
> +
> +::
> +
> +   % notmuch search 'folder:"/^.*/(Junk|Spam)$/"'
> +
>  DATE AND TIME SEARCH
>  ====================

LGTM.

        --dkg