X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-search-terms-7.mdwn;h=f92b7c4e791b7d3b24bdcac5f7f2bbdd2d8006a4;hb=0364b91f49267bb59ef4a70f78114673f9b3efb0;hp=61539a68dacf11fdfbd7121682153ee0cf0acdb5;hpb=6562766d20047abcb3bab0d88a1e5849baaae76d;p=notmuch-wiki diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index 61539a6..f92b7c4 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -37,12 +37,18 @@ · from:<name-or-address> + · from:/<regex>/ + · to:<name-or-address> · subject:<word-or-quoted-phrase> + · subject:/<regex>/ + · attachment:<word> + · mimetype:<word> + · tag:<tag> (or is:<tag>) · id:<message-id> @@ -55,6 +61,12 @@ · date:<since>..<until> + · lastmod:<initial-revision>..<final-revision> + + · query:<name> + + · property:<key>=<value> + The from: prefix is used to match the name or address of the sender of an email message. @@ -66,9 +78,19 @@ including quotation marks around the phrase, immediately following sub- ject:. + If notmuch is built with Xapian Field Processors (see below) the from: + and subject prefix can be also used to restrict the results to those + whose from/subject value matches a regular expression (see regex(7)) + delimited with //. + + notmuch search 'from:/bob@.*[.]example[.]com/' + The attachment: prefix can be used to search for specific filenames (or extensions) of attachments to email messages. + The mimetype: prefix will be used to match text from the content-types + of MIME parts within email messages (as specified by the sender). + For tag: and is: valid tag values include inbox and unread by default for new messages added by notmuch new as well as any other tag values added manually with notmuch tag. @@ -118,16 +140,128 @@ 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). + The lastmod: prefix can be used to restrict the result by the database + revision number of when messages were last modified (tags were + added/removed or filenames changed). This is usually used in conjunc‐ + tion with the --uuid argument to notmuch search to find messages that + have changed since an earlier query. + + The query: prefix allows queries to refer to previously saved queries + added with notmuch-config(1). Named queries are only available if not‐ + much is built with Xapian Field Processors (see below). + + The property: prefix searches for messages with a particular + <key>=<value> property pair. Properties are used internally by notmuch + (and extensions) to add metadata to messages. A given key can be + present on a given message with several different values. + - 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 +

  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 expres‐
+       sion.  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

+
+       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

+
+       Xapian  (and  hence  notmuch)  prefixes  are either boolean, supporting
+       exact matches like "tag:inbox"  or  probabilistic,  supporting  a  more
+       flexible  term  based searching. Certain special prefixes are processed
+       by notmuch in a way not stricly fitting either  of  Xapian's  built  in
+       styles. The prefixes currently supported by notmuch are as follows.
+
+       Boolean
+              tag:, id:, thread:, folder:, path:, property:
+
+       Probabilistic
+              to:, attachment:, mimetype:
+
+       Special
+              from:, query:, subject:
+
+ +

  Terms and phrases

+
+       In  general  Xapian  distinguishes  between lists of terms and phrases.
+       Phrases are indicated by double quotes (but beware you probably need to
+       protect  those  from  your shell) and insist that those unstemmed words
+       occur in that order. One useful, but initially  surprising  feature  is
+       that the following are equivalant ways to write the same phrase.
+
+       · "a list of words"
+
+       · a-list-of-words
+
+       · a/list/of/words
+
+       · a.list.of.words
+
+       Both parenthesised lists of terms and quoted phrases are ok with proba‐
+       bilisitic prefixes such as to:, from:, and subject:. In particular
+
+          subject:(pizza free)
+
+       is equivalent to
+
+          subject:pizza and subject:free
+
+       Both of these will match a subject "Free Delicious Pizza" while
+
+          subject:"pizza free"
+
+       will not.

DATE AND TIME SEARCH

@@ -153,20 +287,22 @@ could describe (the end of yesterday). Similarly, date:january..febru‐ ary matches from the beginning of January to the end of February. - Currently, we do not support spaces in range expressions. You can + date:<expr>..! can be used as a shorthand for date:<expr>..<expr>. The + expansion takes place before interpretation, and thus, for example, + date:monday..! matches from the beginning of Monday until the end of + Monday. With Xapian Field Processor support (see below), non-range + date queries such as date:yesterday will work, but otherwise will give + unexpected results; if in doubt use date:yesterday..! + + 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 + 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 possi‐ - ble to specify date:..<until> or date:<since>.. to not limit the start + Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's possi‐ + ble to specify date:..<until> or date:<since>.. 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).

  Relative date and time

@@ -243,10 +379,28 @@ Some time zone codes, e.g. UTC, EET. +

XAPIAN FIELD PROCESSORS

+
+       Certain  optional  features  of the notmuch query processor rely on the
+       presence of the Xapian field processor API. You can determine  if  your
+       notmuch  was  built  against a sufficiently recent version of Xapian by
+       running
+
+          % notmuch config get built_with.field_processor
+
+       Currently the following features require field processor support:
+
+       · non-range date queries, e.g. "date:today"
+
+       · named queries e.g. "query:my_special_query"
+
+       · regular expression searches, e.g. "subject:/^\[SPAM\]/"
+
+

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
-       much-hooks(5),  notmuch-insert(1),  notmuch-new(1),   notmuch-reply(1),
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
+       much-hooks(5),   notmuch-insert(1),  notmuch-new(1),  notmuch-reply(1),
        notmuch-restore(1), notmuch-search(1), notmuch-show(1), notmuch-tag(1)
@@ -257,7 +411,7 @@

COPYRIGHT

-       2014, Carl Worth and many others
+       2009-2017, Carl Worth and many others
-

0.18.1

+

0.24