Return-Path: <bremner@tesseract.cs.unb.ca>
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 F3BC1429E26
	for <notmuch@notmuchmail.org>; Mon, 23 Feb 2015 12:17:25 -0800 (PST)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 2.438
X-Spam-Level: **
X-Spam-Status: No, score=2.438 tagged_above=-999 required=5
	tests=[DNS_FROM_AHBL_RHSBL=2.438] 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 EcUEajlVL-LC for <notmuch@notmuchmail.org>;
	Mon, 23 Feb 2015 12:17:25 -0800 (PST)
Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net
	[87.98.215.224])
	(using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id 445FD429E25
	for <notmuch@notmuchmail.org>; Mon, 23 Feb 2015 12:17:25 -0800 (PST)
Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim
	4.80) (envelope-from <bremner@tesseract.cs.unb.ca>)
	id 1YPzHh-0001d4-Ru; Mon, 23 Feb 2015 20:07:17 +0000
Received: (nullmailer pid 5904 invoked by uid 1000); Mon, 23 Feb 2015
	20:06:24 -0000
From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, Jani Nikula <jani@nikula.org>,
	notmuch@notmuchmail.org
Subject: [Patch v2 2/4] doc: add more information on operators.
Date: Mon, 23 Feb 2015 21:05:35 +0100
Message-Id: <1424721937-5797-3-git-send-email-david@tethera.net>
X-Mailer: git-send-email 2.1.4
In-Reply-To: <1424721937-5797-1-git-send-email-david@tethera.net>
References: <87a9163fpf.fsf@maritornes.cs.unb.ca>
	<1424721937-5797-1-git-send-email-david@tethera.net>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Mon, 23 Feb 2015 20:17:26 -0000

More material borrowed from the wiki page on "searching"
---
 doc/man7/notmuch-search-terms.rst | 42 ++++++++++++++++++++++++++++++++++-----
 1 file changed, 37 insertions(+), 5 deletions(-)

diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
index 7fb4a27..1bd3df5 100644
--- a/doc/man7/notmuch-search-terms.rst
+++ b/doc/man7/notmuch-search-terms.rst
@@ -124,17 +124,49 @@ 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 ( **and**, **or**, **not** , etc.). Each term in the
-query will be implicitly connected by a logical AND if no explicit
-operator is provided, (except that terms with a common prefix will be
-implicitly combined with OR until we get Xapian defect #402 fixed).
+Operators
+---------
 
+In addition to individual terms, multiple terms can be combined with
+Boolean operators (**and**, **or**, **not**, and **xor**). Each term
+in the query will be implicitly connected by a logical AND if no
+explicit operator is provided, (except that terms with a common prefix
+will be implicitly combined with OR).  The shorthand '-<term>' can be used for 'not <term>' but
+unfortunately this does not work at the start of an expression.
 Parentheses can also be used to control the combination of the Boolean
 operators, but will have to be protected from interpretation by the
 shell, (such as by putting quotation marks around any parenthesized
 expression).
 
+In addition to the standard boolean operators, Xapian provides several
+operators specific to text searching.
+
+::
+
+        notmuch search term1 NEAR term2
+
+will return results where term1 is within 10 words of term2. The
+threshold can be set like this:
+
+::
+
+        notmuch search term1 NEAR/2 term2
+
+The search
+
+::
+
+        notmuch search term1 ADJ term2
+
+will return results where term1 is within 10 words of term2, but in the
+same order as in the query. The threshold can be set the same as with
+NEAR:
+
+::
+
+        notmuch search term1 ADJ/7 term2
+
+
 Stemming
 --------
 
-- 
2.1.4