]> git.notmuchmail.org Git - notmuch/commitdiff
doc/sexp: document range queries.
authorDavid Bremner <david@tethera.net>
Sat, 4 Jun 2022 21:53:59 +0000 (18:53 -0300)
committerDavid Bremner <david@tethera.net>
Sat, 25 Jun 2022 22:52:42 +0000 (19:52 -0300)
Give examples for date fields, as these are commonly useful for user
queries.

doc/man7/notmuch-sexp-queries.rst

index 1d7e0ae9a5aa1b63639c92660d4b4c62a7330bd2..d28f40bb3f3901dbecf8d8ceb37d81a538d020d2 100644 (file)
@@ -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".