From: David Bremner <david@tethera.net>
Date: Tue, 24 Aug 2021 15:17:45 +0000 (-0700)
Subject: doc/sexp-queries: update synopsis and description
X-Git-Tag: archive/debian/0.34_rc0-1~29
X-Git-Url: https://git.cworth.org/git?p=notmuch;a=commitdiff_plain;h=49aa44bb012e8c2412b5447119b78b61842740b8

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.
---

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
+<https://en.wikipedia.org/wiki/S-expression>`_ . 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
 -------------