diff options
| author | David Bremner <david@tethera.net> | 2021-08-24 08:17:45 -0700 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-09-04 17:07:19 -0700 |
| commit | 49aa44bb012e8c2412b5447119b78b61842740b8 (patch) | |
| tree | bc9860c33824d9a3a51ba1bc335012236ea20681 /doc/man7 | |
| parent | 4595a814c2117fb33ea39e3ecea41858ad3791a2 (diff) | |
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.
Diffstat (limited to 'doc/man7')
| -rw-r--r-- | doc/man7/notmuch-sexp-queries.rst | 13 |
1 files changed, 12 insertions, 1 deletions
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 ------------- |