[Patch v2 2/4] doc: add more information on operators.

2015-02-23 Thread David Bremner 
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 '-' can be used for 
'not ' 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

[Patch v2 2/4] doc: add more information on operators.

2015-02-23 Thread W. Trevor King 
On Mon, Feb 23, 2015 at 09:05:35PM +0100, David Bremner wrote:
> +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 '-' can be used 
> for 'not ' 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).

We should probably:

* Re-wrap the paragraph to avoid one long line.
* Drop the comma before the ?(except ?)? parens.

Cheers,
Trevor

-- 
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy
-- next part --
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: OpenPGP digital signature
URL:

[Patch v2 2/4] doc: add more information on operators.

2015-02-23 Thread David Bremner 
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

___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch