X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-search-terms-7.mdwn;h=40b082d54323d183619990e6a7f089553fb291c7;hb=887679e40c165171f4f9687932439d1b9fe7d338;hp=ee5c1b2205455da5eccd42d6f365e327393bba3e;hpb=cf2df983cb6d13042694366be4aba76d4a98048b;p=notmuch-wiki diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index ee5c1b2..40b082d 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -43,6 +43,8 @@ · attachment:<word> + · mimetype:<word> + · tag:<tag> (or is:<tag>) · id:<message-id> @@ -55,6 +57,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. @@ -69,40 +77,43 @@ The attachment: prefix can be used to search for specific filenames (or extensions) of attachments to email messages. - 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 + 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. - For id:, message ID values are the literal contents of the Message-ID: + For id:, message ID values are the literal contents of the Message-ID: header of email messages, but without the '<', '>' delimiters. - The thread: prefix can be used with the thread ID values that are gen‐ - erated internally by notmuch (and do not appear in email messages). - These thread ID values can be seen in the first column of output from + The thread: prefix can be used with the thread ID values that are gen‐ + erated internally by notmuch (and do not appear in email messages). + These thread ID values can be seen in the first column of output from notmuch search - The path: prefix searches for email messages that are in particular + The path: prefix searches for email messages that are in particular directories within the mail store. The directory must be specified rel‐ - ative to the top-level maildir (and without the leading slash). By - default, path: matches messages in the specified directory only. The - "/**" suffix can be used to match messages in the specified directory - and all its subdirectories recursively. path:"" matches messages in + ative to the top-level maildir (and without the leading slash). By + default, path: matches messages in the specified directory only. The + "/**" suffix can be used to match messages in the specified directory + and all its subdirectories recursively. path:"" matches messages in the root of the mail store and, likewise, path:** matches all messages. The folder: prefix searches for email messages by maildir or MH folder. - For MH-style folders, this is equivalent to path:. For maildir, this + For MH-style folders, this is equivalent to path:. For maildir, this includes messages in the "new" and "cur" subdirectories. The exact syn‐ - tax for maildir folders depends on your mail configuration. For - maildir++, folder:"" matches the inbox folder (which is the root in - maildir++), other folder names always start with ".", and nested fold‐ - ers are separated by "."s, such as folder:.classes.topology. For "file + tax for maildir folders depends on your mail configuration. For + maildir++, folder:"" matches the inbox folder (which is the root in + maildir++), other folder names always start with ".", and nested fold‐ + ers are separated by "."s, such as folder:.classes.topology. For "file system" maildir, the inbox is typically folder:INBOX and nested folders are separated by slashes, such as folder:classes/topology. - Both path: and folder: will find a message if any copy of that message + Both path: and folder: will find a message if any copy of that message is in the specific directory/folder. - The date: prefix can be used to restrict the results to only messages + The date: prefix can be used to restrict the results to only messages within a particular time range (based on the Date: header) with a range syntax of: @@ -115,19 +126,127 @@ <initial-timestamp>..<final-timestamp> - Each timestamp is a number representing the number of seconds since + Each timestamp is a number representing the number of seconds since 1970-01-01 00:00:00 UTC. + 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. + + +

  Operators

+
        In  addition  to  individual terms, multiple terms can be combined with
-       Boolean operators ( and, or, not , etc.). Each term in the  query  will
+       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).
-
-       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
+       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. The prefixes currently supported by not‐
+       much are as follows.
+
+       Boolean
+              tag:, id:, thread:, folder:, path:, property:
+
+       Probabilistic
+              from:, to:, subject:, attachment:, mimetype:
+
+ +

  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 +272,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 +364,26 @@ 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"
+
+

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 +394,7 @@

COPYRIGHT

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

0.19

+

0.23.4