From edadd8ebb11873157fab42feaf2bc0b44c1787a7 Mon Sep 17 00:00:00 2001 From: Jani Nikula Date: Sat, 4 Aug 2012 10:41:45 +0300 Subject: [PATCH] [PATCH v2 7/7] man: document the date:since..until range queries --- ff/da9be08e74f1336e22d0b4b970e5692c31e4ee | 249 ++++++++++++++++++++++ 1 file changed, 249 insertions(+) create mode 100644 ff/da9be08e74f1336e22d0b4b970e5692c31e4ee diff --git a/ff/da9be08e74f1336e22d0b4b970e5692c31e4ee b/ff/da9be08e74f1336e22d0b4b970e5692c31e4ee new file mode 100644 index 000000000..48793036b --- /dev/null +++ b/ff/da9be08e74f1336e22d0b4b970e5692c31e4ee @@ -0,0 +1,249 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 825EC431FAE + for ; Sat, 4 Aug 2012 00:43:00 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id xWE5wK1SF03E for ; + Sat, 4 Aug 2012 00:42:59 -0700 (PDT) +Received: from mail-lpp01m010-f53.google.com (mail-lpp01m010-f53.google.com + [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id DEF49431FDB + for ; Sat, 4 Aug 2012 00:42:21 -0700 (PDT) +Received: by mail-lpp01m010-f53.google.com with SMTP id u2so844636lag.26 + for ; Sat, 04 Aug 2012 00:42:21 -0700 (PDT) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=google.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references + :in-reply-to:references:x-gm-message-state; + bh=NUGsySKvm0TnO8zgeEd8pi58+RaZGhVr/lYk5zIcaoY=; + b=bMl4wOvyweixvoJkhOdSZHNF1Mz/Yf3Fcc0lJSJefKZm3tbfZdfVmI4vxMtIC1Jyc0 + J4096cA4SvjPkWCKen5nbhOYRazlSxVeAhnZcfvHge1+FgUH+ZmyrFRcKTd+sk7tg8IK + ibOFvXW2nZBIuvrfSMP95f7Tx4MwAXRzJbwysBRWvrHpT/F5WkLEXaXjo5PmkZVtxQ8T + Arq2Dlqr7c49OuB6QDqTlzn/PTjg81iVf5uYVrqNNU9gDzqGHoI1qToT1PV95UsIM5CA + Rjk6bjXsYreL2ueN+tSnUhEjG3OvvGrVMEZjxx9APvErNeN4pnRXqe5XVb0aX5uiV83E + 9PZg== +Received: by 10.152.148.195 with SMTP id tu3mr4040613lab.16.1344066141479; + Sat, 04 Aug 2012 00:42:21 -0700 (PDT) +Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi. + [80.223.81.27]) + by mx.google.com with ESMTPS id fd1sm2438553lbb.7.2012.08.04.00.42.19 + (version=SSLv3 cipher=OTHER); Sat, 04 Aug 2012 00:42:20 -0700 (PDT) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH v2 7/7] man: document the date:since..until range queries +Date: Sat, 4 Aug 2012 10:41:45 +0300 +Message-Id: + <745bdbe18e69e604beb8f36c22def0b074f9dc99.1344065790.git.jani@nikula.org> +X-Mailer: git-send-email 1.7.9.5 +In-Reply-To: +References: +In-Reply-To: +References: +X-Gm-Message-State: + ALoCoQkvw2meY/czRLvoQ07DCfuUTLniIDfLVWRYv5yPmS0Q1zJ4R5bptX/BCRqleaTPCCHdQlOJ +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 04 Aug 2012 07:43:00 -0000 + +--- + man/man7/notmuch-search-terms.7 | 147 +++++++++++++++++++++++++++++++++++---- + 1 file changed, 135 insertions(+), 12 deletions(-) + +diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7 +index b8ab52d..cec3785 100644 +--- a/man/man7/notmuch-search-terms.7 ++++ b/man/man7/notmuch-search-terms.7 +@@ -54,6 +54,8 @@ terms to match against specific portions of an email, (where + + folder: + ++ date:.. ++ + The + .B from: + prefix is used to match the name or address of the sender of an email +@@ -104,6 +106,26 @@ contained within particular directories within the mail store. Only + the directory components below the top-level mail database path are + available to be searched. + ++The ++.B date: ++prefix can be used to restrict the results to only messages within a ++particular time range (based on the Date: header) with a range syntax ++of: ++ ++ date:.. ++ ++See \fBDATE AND TIME SEARCH\fR below for details on the range ++expression, and supported syntax for and date and time ++expressions. ++ ++The time range can also be specified using timestamps with a syntax ++of: ++ ++ .. ++ ++Each timestamp is a number representing the number of seconds since ++1970\-01\-01 00:00:00 UTC. ++ + In addition to individual terms, multiple terms can be + combined with Boolean operators ( + .BR and ", " or ", " not +@@ -117,20 +139,121 @@ operators, but will have to be protected from interpretation by the + shell, (such as by putting quotation marks around any parenthesized + expression). + +-Finally, results can be restricted to only messages within a +-particular time range, (based on the Date: header) with a syntax of: ++.SH DATE AND TIME SEARCH + +- .. ++This is a non-exhaustive description of the date and time search with ++some pseudo notation. Most of the constructs can be mixed freely, and ++in any order, but the same absolute date or time can't be expressed ++twice. + +-Each timestamp is a number representing the number of seconds since +-1970\-01\-01 00:00:00 UTC. This is not the most convenient means of +-expressing date ranges, but until notmuch is fixed to accept a more +-convenient form, one can use the date program to construct +-timestamps. For example, with the bash shell the following syntax would +-specify a date range to return messages from 2009\-10\-01 until the +-current time: +- +- $(date +%s \-d 2009\-10\-01)..$(date +%s) ++.RS 4 ++.TP 4 ++.B The range expression ++ ++date:.. ++ ++The above expression restricts the results to only messages from ++ to , based on the Date: header. ++ ++If or describes time at an accuracy of days or less, ++the date/time is rounded, towards past for and towards future ++for , to be inclusive. For example, date:january..february ++matches from the beginning of January until the end of ++February. Similarly, date:yesterday..yesterday matches from the ++beginning of yesterday until the end of yesterday. ++ ++Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's ++possible to specify date:.. or date:.. to not limit the ++start or end time, respectively. Unfortunately, pre-1.2.1 Xapian does ++not report an error on open ended ranges, but it does not work as ++expected either. ++ ++Xapian does not support spaces in range expressions. You can replace ++the spaces with '_', or (in most cases) '-', or (in some cases) leave ++the spaces out altogether. ++ ++Entering date:expr without ".." (for example date:yesterday) won't ++work, as it's not interpreted as a range expression at all. You can ++achieve the expected result by duplicating the expr both sides of ".." ++(for example date:yesterday..yesterday). ++.RE ++ ++.RS 4 ++.TP 4 ++.B Relative date and time ++[N|number] (years|months|weeks|days|hours|hrs|minutes|mins|seconds|secs) [...] ++ ++All refer to past, can be repeated and will be accumulated. ++ ++Units can be abbreviated to any length, with the otherwise ambiguous ++single m being m for minutes and M for months. ++ ++Number multiplier can also be written out one, two, ..., ten, dozen, ++hundred. As special cases last means one ("last week") and this means ++zero ("this month"). ++ ++When combined with absolute date and time, the relative date and time ++specification will be relative from the specified absolute date and ++time. ++ ++Examples: 5M2d, two weeks ++.RE ++ ++.RS 4 ++.TP 4 ++.B Supported time formats ++H[H]:MM[:SS] [(am|a.m.|pm|p.m.)] ++ ++H[H] (am|a.m.|pm|p.m.) ++ ++HHMMSS ++ ++now ++ ++noon ++ ++midnight ++ ++Examples: 17:05, 5pm ++.RE ++ ++.RS 4 ++.TP 4 ++.B Supported date formats ++YYYY-MM[-DD] ++ ++DD-MM[-[YY]YY] ++ ++MM-YYYY ++ ++M[M]/D[D][/[YY]YY] ++ ++M[M]/YYYY ++ ++D[D].M[M][.[YY]YY] ++ ++D[D][(st|nd|rd|th)] Mon[thname] [YYYY] ++ ++Mon[thname] D[D][(st|nd|rd|th)] [YYYY] ++ ++Wee[kday] ++ ++Month names can be abbreviated at three or more characters. ++ ++Weekday names can be abbreviated at three or more characters. ++ ++Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3 ++.RE ++ ++.RS 4 ++.TP 4 ++.B Time zones ++(+|-)HH:MM ++ ++(+|-)HH[MM] ++ ++Some time zone codes, e.g. UTC, EET. ++.RE + + .SH SEE ALSO + +-- +1.7.9.5 + -- 2.26.2