From 49aa44bb012e8c2412b5447119b78b61842740b8 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Tue, 24 Aug 2021 08:17:45 -0700 Subject: [PATCH] doc/sexp-queries: update synopsis and description I chose to go with a somewhat terse synopsis to try to keep the length of the page down. --- doc/man7/notmuch-sexp-queries.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/man7/notmuch-sexp-queries.rst b/doc/man7/notmuch-sexp-queries.rst index 81e3929b..019d15f0 100644 --- a/doc/man7/notmuch-sexp-queries.rst +++ b/doc/man7/notmuch-sexp-queries.rst @@ -7,11 +7,22 @@ notmuch-sexp-queries SYNOPSIS ======== -**notmuch** **search** ``--query=sexp`` '(and (to santa) (date december))' +**notmuch** *subcommand* ``--query=sexp`` [option ...] ``--`` '(and (to santa) (date december))' DESCRIPTION =========== +Notmuch supports an alternative query syntax based on `S-expressions +`_ . It can be selected +with the command line ``--query=sexp`` or with the appropriate option +to the library function :c:func:`notmuch_query_create_with_syntax`. +Support for this syntax is currently optional, you can test if your +build of notmuch supports it with + +:: + + $ notmuch config get built_with.sexpr_query + S-EXPRESSIONS -------------