From: Jani Nikula Date: Tue, 30 Oct 2012 20:32:39 +0000 (+0200) Subject: [PATCH v6 8/9] man: document the date:since..until range queries X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=5aebc959787821f698ea37485b5693d49036c2f8;p=notmuch-archives.git [PATCH v6 8/9] man: document the date:since..until range queries --- diff --git a/3a/74c5307fc3b8ff3e5492dd3ee646751fe74a05 b/3a/74c5307fc3b8ff3e5492dd3ee646751fe74a05 new file mode 100644 index 000000000..6cc7c7981 --- /dev/null +++ b/3a/74c5307fc3b8ff3e5492dd3ee646751fe74a05 @@ -0,0 +1,252 @@ +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 66C7F431FAF + for ; Tue, 30 Oct 2012 13:33:24 -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 9-KCOwQUfdwm for ; + Tue, 30 Oct 2012 13:33:22 -0700 (PDT) +Received: from mail-lb0-f181.google.com (mail-lb0-f181.google.com + [209.85.217.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 6AAE9429E32 + for ; Tue, 30 Oct 2012 13:33:11 -0700 (PDT) +Received: by mail-lb0-f181.google.com with SMTP id gg6so567600lbb.26 + for ; Tue, 30 Oct 2012 13:33:10 -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=ajPBPDRnTMDI8c8arNLk4NRjdk5CLVxmbgWXU+fR3Gk=; + b=mOwyN9s//csjVCPH5W4zMQEs00rqtM60ifmqFKaVJoOsVEHN+/mA+SfuwJdMS8m7kC + lZI0DBCBPFte0mT5W1XpjTbR8zYd7SooBJRDstJds1tRaj5YGjDUj3TZ0SpRjQspjtzW + 3e4gVz71DG2oG7REj3isFWK8iuqI3NnW5DFJUEX7umL7hBeXeqE/japB5YgJKAVbtb0K + bB3dhUa/JEPO9Bl6orP8BzpE2WOzzACeYPuaPV1xeQIkt4ShBQ/hrUI7xX0BMIo92ROo + xA5VJqbrwCHt9KftQ/Vo689lwCSmKefi/ATsIPE/MCXqoVNsZ8fSASiwsn/k0cdJymiZ + 0NiQ== +Received: by 10.152.47.148 with SMTP id d20mr31320333lan.42.1351629190917; + Tue, 30 Oct 2012 13:33:10 -0700 (PDT) +Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi. + [80.223.81.27]) + by mx.google.com with ESMTPS id z9sm754739lbk.15.2012.10.30.13.33.09 + (version=SSLv3 cipher=OTHER); Tue, 30 Oct 2012 13:33:10 -0700 (PDT) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH v6 8/9] man: document the date:since..until range queries +Date: Tue, 30 Oct 2012 22:32:39 +0200 +Message-Id: + <88274590f0d652a3fc76e2b5185922b9f13c4d03.1351626272.git.jani@nikula.org> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: +References: +In-Reply-To: +References: +X-Gm-Message-State: + ALoCoQk4PzetRN6AP/zCSF1flbAU09P1ChtMMmEIf0jjCZBDrra6ZOHBmEX+Dhde8y/iV7WZnuq3 +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: Tue, 30 Oct 2012 20:33:24 -0000 + +--- + man/man7/notmuch-search-terms.7 | 150 +++++++++++++++++++++++++++++++++++---- + 1 file changed, 138 insertions(+), 12 deletions(-) + +diff --git a/man/man7/notmuch-search-terms.7 b/man/man7/notmuch-search-terms.7 +index 17a109e..e39b944 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,124 @@ 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 + +- .. ++notmuch understands a variety of standard and natural ways of ++expressing dates and times, both in absolute terms ("2012-10-24") and ++in relative terms ("yesterday"). Any number of relative terms can be ++combined ("1 hour 25 minutes") and an absolute date/time can be ++combined with relative terms to further adjust it. A non-exhaustive ++description of the syntax supported for absolute and relative terms is ++given below. + +-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. ++ ++ and can describe imprecise times, such as "yesterday". ++In this case, is taken as the earliest time it could describe ++(the beginning of yesterday) and is taken as the latest time ++it could describe (the end of yesterday). Similarly, ++date:january..february matches from the beginning of January to the ++end of February. ++ ++Currently, we do 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. Examples in this man page use ++spaces for clarity. ++ ++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. Pre-1.2.1 Xapian does not report an ++error on open ended ranges, but it does not work as expected either. ++ ++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 can also be written out one, two, ..., ten, dozen, ++hundred. Additionally, the unit may be preceded by "last" or "this" ++(e.g., "last week" or "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 absolute 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 absolute 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.10.4 +