From: David Bremner <david@tethera.net>
Date: Sat, 4 Jun 2022 21:53:59 +0000 (-0300)
Subject: doc/sexp: document range queries.
X-Git-Tag: 0.37_rc0~63
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=d73ddec5b8c48c08d38e9e71666947aadafd3fb6

doc/sexp: document range queries.

Give examples for date fields, as these are commonly useful for user
queries.
---

diff --git a/doc/man7/notmuch-sexp-queries.rst b/doc/man7/notmuch-sexp-queries.rst
index 1d7e0ae9..d28f40bb 100644
--- a/doc/man7/notmuch-sexp-queries.rst
+++ b/doc/man7/notmuch-sexp-queries.rst
@@ -119,6 +119,12 @@ a message has one such attribute, and ``and`` otherwise.
 Term or phrase fields can contain arbitrarily complex queries made up
 from terms, operators, and modifiers, but not other fields.
 
+Range fields take one or two arguments specifying lower and upper
+bounds.  One argument is interpreted as identical upper and lower
+bounds. Either upper or lower bound may be specified as ``""`` or
+``*`` to specify the lowest possible lower bound or highest possible
+upper bound.
+
 .. _field-table:
 
 .. table:: Fields with supported modifiers
@@ -240,6 +246,18 @@ EXAMPLES
 
     Match messages in the given date range with tag unread.
 
+``(and (date 2009-11-18 2009-11-18) (tag unread))``
+
+    Match messages in the given date range with tag unread.
+
+``(and (date 2009-11-18 *) (tag unread))``
+
+    Match messages from 2009-11-18 or later with tag unread.
+
+``(and (date * 2009-11-18) (tag unread))``
+
+    Match messages from 2009-11-18 or earlier with tag unread.
+
 ``(starts-with prelim)``
 
     Match any words starting with "prelim".