]> git.notmuchmail.org Git - notmuch/commitdiff
doc/sexp-queries: update synopsis and description
authorDavid Bremner <david@tethera.net>
Tue, 24 Aug 2021 15:17:45 +0000 (08:17 -0700)
committerDavid Bremner <david@tethera.net>
Sun, 5 Sep 2021 00:07:19 +0000 (17:07 -0700)
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

index 81e3929ba7dd479f293e8d5018e2eb659174cb8b..019d15f0b70fcfafc8cdcd2ccc7abec0a81ef7d5 100644 (file)
@@ -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
 -------------