doc: add material on stemming and wildcards
authorDavid Bremner <david@tethera.net>
Sun, 18 Jan 2015 12:59:30 +0000 (13:59 +0100)
committerDavid Bremner <david@tethera.net>
Tue, 24 Feb 2015 07:29:01 +0000 (08:29 +0100)
This is lightly massaged from the searching page on the wiki.

doc/man7/notmuch-search-terms.rst

index 54138d230f0b8559d48fcda20b5129f882738815..7fb4a27da5cebc15c79157eaea3044f81cfab6c7 100644 (file)
@@ -135,6 +135,33 @@ operators, but will have to be protected from interpretation by the
 shell, (such as by putting quotation marks around any parenthesized
 expression).
 
+Stemming
+--------
+
+**Stemming** in notmuch means that these searches
+
+::
+
+        notmuch search detailed
+        notmuch search details
+        notmuch search detail
+
+will all return identical results, because Xapian first "reduces" the
+term to the common stem (here 'detail') and then performs the search.
+
+There are two ways to turn this off: a search for a capitalized word
+will be performed unstemmed, so that one can search for "John" and not
+get results for "Johnson"; phrase searches are also unstemmed (see
+below for details).  Stemming is currently only supported for
+English. Searches for words in other languages will be performed unstemmed.
+
+Wildcards
+---------
+
+It is possible to use a trailing '\*' as a wildcard. A search for
+'wildc\*' will match 'wildcard', 'wildcat', etc.
+
+
 Boolean and Probabilistic Prefixes
 ----------------------------------