unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: Jani Nikula <jani@nikula.org>, David Bremner <david@tethera.net>,
	notmuch@notmuchmail.org
Subject: [PATCH 3/3] doc: add more information on operators.
Date: Sun, 18 Jan 2015 13:59:31 +0100	[thread overview]
Message-ID: <1421585971-29949-3-git-send-email-david@tethera.net> (raw)
In-Reply-To: <1421585971-29949-1-git-send-email-david@tethera.net>

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

diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
index 3b27053..a315fbe 100644
--- a/doc/man7/notmuch-search-terms.rst
+++ b/doc/man7/notmuch-search-terms.rst
@@ -118,17 +118,50 @@ 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 until we get Xapian defect #402
+fixed).  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

  parent reply	other threads:[~2015-01-18 13:39 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-01-18  9:33 [PATCH] doc: add details about Xapian search syntax David Bremner
2015-01-18 10:29 ` Jani Nikula
2015-01-18 12:59   ` [PATCH 1/3] " David Bremner
2015-01-18 12:59     ` [PATCH 2/3] doc: add material on stemming and wildcards David Bremner
2015-02-23 18:18       ` Jani Nikula
2015-01-18 12:59     ` David Bremner [this message]
2015-02-23 18:23       ` [PATCH 3/3] doc: add more information on operators Jani Nikula
2015-01-25 17:58     ` [PATCH 1/3] doc: add details about Xapian search syntax David Bremner
2015-02-23 20:05       ` David Bremner
2015-02-23 20:05         ` [Patch v2 1/4] doc: add material on stemming and wildcards David Bremner
2015-02-23 20:05         ` [Patch v2 2/4] doc: add more information on operators David Bremner
2015-02-23 20:13           ` W. Trevor King
2015-02-23 20:05         ` [Patch v2 3/4] doc: typo fix for prefix discussion David Bremner
2015-02-23 20:05         ` [Patch v2 4/4] doc: update list of prefixes David Bremner
2015-02-24  7:32         ` David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1421585971-29949-3-git-send-email-david@tethera.net \
    --to=david@tethera.net \
    --cc=jani@nikula.org \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).