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.
This commit is contained in:
David Bremner 2021-08-24 08:17:45 -07:00
parent 4595a814c2
commit 49aa44bb01

View file

@ -7,11 +7,22 @@ notmuch-sexp-queries
SYNOPSIS SYNOPSIS
======== ========
**notmuch** **search** ``--query=sexp`` '(and (to santa) (date december))' **notmuch** *subcommand* ``--query=sexp`` [option ...] ``--`` '(and (to santa) (date december))'
DESCRIPTION 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 S-EXPRESSIONS
------------- -------------