X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-search-terms-7.mdwn;h=e46c6b5e9d024f942e882bb74d8b954da719a911;hb=edc130b91717dd825c911fdc18f4051dcd2c8896;hp=0259d42a486a33bb2c7cb16696e13b7aa3a4fdb0;hpb=29654905e64093a5275f4a554527231072efccb9;p=notmuch-wiki diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index 0259d42..e46c6b5 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -9,7 +9,7 @@
notmuch count [option ...] <search-term> ... - notmuch dump [--format=(batch-tag|sup)] [--] [--output=<file>] [--] + notmuch dump [--gzip] [--format=(batch-tag|sup)] [--output=<file>] [--] [<search-term> ...] notmuch reindex [option ...] <search-term> ... @@ -45,7 +45,10 @@ results to those whose value matches a regular expression (see regex(7)) delimited with //, for example: - notmuch search 'from:/bob@.*[.]example[.]com/' + notmuch search 'from:"/bob@.*[.]example[.]com/"' + + body:<word-or-quoted-phrase> + Match terms in the body of messages. from:<name-or-address> or from:/<regex>/ The from: prefix is used to match the name or address of the @@ -86,50 +89,65 @@ messages). These thread ID values can be seen in the first colâ umn of output from notmuch search + thread:{<notmuch query>} + If notmuch is built with Xapian Field Processors (see below), + threads may be searched for indirectly by providing an arbitrary + notmuch query in {}. For example, the following returns threads + containing a message from mallory and one (not necessarily the + same message) with Subject containing the word "crypto". + + % notmuch search 'thread:"{from:mallory}" and thread:"{subject:crypto}"' + + The performance of such queries can vary wildly. To understand + this, the user should think of the query thread:{<something>} as + expanding to all of the thread IDs which match <something>; notâ + much then performs a second search using the expanded query. + path:<directory-path> or path:<directory-path>/** or path:/<regex>/ The path: prefix searches for email messages that are in particâ - ular directories within the mail store. The directory must be - specified relative to the top-level maildir (and without the + ular directories within the mail store. The directory must be + specified relative to the top-level maildir (and without the leading slash). By default, path: matches messages in the speciâ - fied directory only. The "/**" suffix can be used to match mesâ - sages in the specified directory and all its subdirectories - recursively. path:"" matches messages in the root of the mail + fied directory only. The "/**" suffix can be used to match mesâ + sages 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. - path: will find a message if any copy of that message is in the + path: will find a message if any copy of that message is in the specific directory. folder:<maildir-folder> or folder:/<regex>/ - The folder: prefix searches for email messages by maildir or MH - folder. For MH-style folders, this is equivalent to path:. For + The folder: prefix searches for email messages by maildir or MH + folder. For MH-style folders, this is equivalent to path:. For maildir, this includes messages in the "new" and "cur" subdirecâ - tories. The exact syntax for maildir folders depends on your - mail configuration. For maildir++, folder:"" matches the inbox - folder (which is the root in maildir++), other folder names + tories. The exact syntax 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 folders 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. - folder: will find a message if any copy of that message is in + folder: will find a message if any copy of that message is in the specific folder. date:<since>..<until> or date:<date> - The date: prefix can be used to restrict the results to only - messages within a particular time range (based on the Date: + The date: prefix can be used to restrict the results to only + messages within a particular time range (based on the Date: header). - See DATE AND TIME SEARCH below for details on the range expresâ + See DATE AND TIME SEARCH below for details on the range expresâ sion, and supported syntax for <since> and <until> date and time expressions. - The time range can also be specified using timestamps with a - syntax of: + The time range can also be specified using timestamps without + including the date prefix using a syntax of: <initial-timestamp>..<final-timestamp> - Each timestamp is a number representing the number of seconds - since 1970-01-01 00:00:00 UTC. + Each timestamp is a number representing the number of seconds + since 1970-01-01 00:00:00 UTC. Specifying a time range this way + is considered legacy and predates the date prefix. lastmod:<initial-revision>..<final-revision> The lastmod: prefix can be used to restrict the result by the @@ -150,27 +168,30 @@ notmuch (and extensions) to add metadata to messages. A given key can be present on a given message with several different values. See notmuch-properties(7) for more details. + + User defined prefixes are also supported, see notmuch-config(1) for + details.
- 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 + 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 + 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 + 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 + will return results where term1 is within 10 words of term2. The threshold can be set like this: notmuch search term1 NEAR/2 term2 @@ -180,7 +201,7 @@ 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 + same order as in the query. The threshold can be set the same as with NEAR: notmuch search term1 ADJ/7 term2 @@ -194,35 +215,35 @@ notmuch search details notmuch search detail - will all return identical results, because Xapian first "reduces" the + 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. + 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.
- It is possible to use a trailing '*' as a wildcard. A search for + It is possible to use a trailing '*' as a wildcard. A search for 'wildc*' will match 'wildcard', 'wildcat', etc.
- 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 strictly fitting either of Xapian's built in + 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 strictly 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: + body:, to:, attachment:, mimetype: Special from:, query:, subject: @@ -230,10 +251,10 @@Terms and phrases
- In general Xapian distinguishes between lists of 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 + 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 equivalent ways to write the same phrase. · "a list of words" @@ -260,6 +281,25 @@ will not.+Quoting
++ Double quotes are also used by the notmuch query parser to protect + boolean terms, regular expressions, or subqueries containing spaces or + other special characters, e.g. + + tag:"a tag" + + folder:"/^.*/(Junk|Spam)$/" + + thread:"{from:mallory and date:2009}" + + As with phrases, you need to protect the double quotes from the shell + e.g. + + % notmuch search 'folder:"/^.*/(Junk|Spam)$/"' + % notmuch search 'thread:"{from:mallory and date:2009}" and thread:{to:mallory}' ++DATE AND TIME SEARCH
notmuch understands a variety of standard and natural ways of expressâ @@ -283,20 +323,26 @@ could describe (the end of yesterday). Similarly, date:january..februâ ary matches from the beginning of January to the end of February. - 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 + If specifying a time range using timestamps in conjunction with the + date prefix, each timestamp must be preceded by @ (ASCII hex 40). As + above, each timestamp is a number representing the number of seconds + since 1970-01-01 00:00:00 UTC. For example: + date:@<initial-timestamp>..@<final-timestamp> + + 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 + 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.@@ -308,15 +354,15 @@ All refer to past, can be repeated and will be accumulated. - Units can be abbreviated to any length, with the otherwise ambiguous + Units can be abbreviated to any length, with the otherwise ambiguous single m being m for minutes and M for months. - Number can also be written out one, two, ..., ten, dozen, hundred. + Number can also be written out one, two, ..., ten, dozen, hundred. Additionally, the unit may be preceded by "last" or "this" (e.g., "last week" or "this month"). - When combined with absolute date and time, the relative date and time - specification will be relative from the specified absolute date and + When combined with absolute date and time, the relative date and time + specification will be relative from the specified absolute date and time. Examples: 5M2d, two weeks @@ -377,9 +423,9 @@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 + 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 @@ -391,13 +437,15 @@ · named queries e.g. "query:my_special_query" · regular expression searches, e.g. "subject:/^\[SPAM\]/" + + · thread subqueries, e.g. "thread:{from:bob}"SEE ALSO
- notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), notâ - much-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reindex(1), - notmuch-properties(1), *notmuch-reply(1), notmuch-restore(1), notâ + notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), notâ + much-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reindex(1), + notmuch-properties(1), *notmuch-reply(1), notmuch-restore(1), notâ much-search(1), *notmuch-show(1), notmuch-tag(1)@@ -408,7 +456,7 @@COPYRIGHT
- 2009-2018, Carl Worth and many others + 2009-2019, Carl Worth and many others-0.26
+0.29