X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-search-terms-7.mdwn;h=0259d42a486a33bb2c7cb16696e13b7aa3a4fdb0;hb=29654905e64093a5275f4a554527231072efccb9;hp=0123d9054c6d248cdf353c24a7ccb46047e31bab;hpb=0add150ffd941ea7ed64a9116929aaf2daa927a5;p=notmuch-wiki
diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn
index 0123d90..0259d42 100644
--- a/manpages/notmuch-search-terms-7.mdwn
+++ b/manpages/notmuch-search-terms-7.mdwn
@@ -12,6 +12,8 @@
notmuch dump [--format=(batch-tag|sup)] [--] [--output=<file>] [--]
[<search-term> ...]
+ notmuch reindex [option ...] <search-term> ...
+
notmuch search [option ...] <search-term> ...
notmuch show [option ...] <search-term> ...
@@ -25,118 +27,246 @@
The search terms can consist of free-form text (and quoted phrases)
which will match all messages that contain all of the given
- terms/phrases in the body, the subject, or any of the sender or recipi-
+ terms/phrases in the body, the subject, or any of the sender or recipiâ
ent headers.
As a special case, a search string consisting of exactly a single
asterisk ("*") will match all messages.
+
+ Search prefixes
+
In addition to free text, the following prefixes can be used to force
terms to match against specific portions of an email, (where <brackets>
- indicate user-supplied values):
+ indicate user-supplied values).
+
+ If notmuch is built with Xapian Field Processors (see below) some of
+ the prefixes with <regex> forms can be also used to restrict the
+ results to those whose value matches a regular expression (see
+ regex(7)) delimited with //, for example:
+
+ notmuch search 'from:/bob@.*[.]example[.]com/'
+
+ from:<name-or-address> or from:/<regex>/
+ The from: prefix is used to match the name or address of the
+ sender of an email message.
+
+ to:<name-or-address>
+ The to: prefix is used to match the names or addresses of any
+ recipient of an email message, (whether To, Cc, or Bcc).
+
+ subject:<word-or-quoted-phrase> or subject:/<regex>/
+ Any term prefixed with subject: will match only text from the
+ subject of an email. Searching for a phrase in the subject is
+ supported by including quotation marks around the phrase, immeâ
+ diately following subject:.
+
+ attachment:<word>
+ The attachment: prefix can be used to search for specific fileâ
+ names (or extensions) of attachments to email messages.
+
+ mimetype:<word>
+ The mimetype: prefix will be used to match text from the conâ
+ tent-types of MIME parts within email messages (as specified by
+ the sender).
+
+ tag:<tag> or tag:/<regex>/ or is:<tag> or is:/<regex>/
+ 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.
+
+ id:<message-id> or mid:<message-id> or mid:/<regex>/
+ For id: and mid:, message ID values are the literal contents of
+ the Message-ID: header of email messages, but without the '<',
+ '>' delimiters.
+
+ thread:<thread-id>
+ The thread: prefix can be used with the thread ID values that
+ are generated internally by notmuch (and do not appear in email
+ messages). These thread ID values can be seen in the first colâ
+ umn of output from notmuch search
+
+ 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
+ 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
+ store and, likewise, path:** matches all messages.
+
+ 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
+ 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
+ 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
+ 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:
+ header).
+
+ 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:
+
+ <initial-timestamp>..<final-timestamp>
+
+ Each timestamp is a number representing the number of seconds
+ since 1970-01-01 00:00:00 UTC.
+
+ lastmod:<initial-revision>..<final-revision>
+ 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 conjunction with the --uuid argument to notmuch search
+ to find messages that have changed since an earlier query.
+
+ query:<name>
+ The query: prefix allows queries to refer to previously saved
+ queries added with notmuch-config(1). Named queries are only
+ available if notmuch is built with Xapian Field Processors (see
+ below).
+
+ property:<key>=<value>
+ 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. See notmuch-properties(7) for more details.
+
+
+ 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.
- · from:<name-or-address>
+ notmuch search term1 NEAR term2
- · to:<name-or-address>
+ will return results where term1 is within 10 words of term2. The
+ threshold can be set like this:
- · subject:<word-or-quoted-phrase>
+ notmuch search term1 NEAR/2 term2
- · attachment:<word>
+ The search
- · tag:<tag> (or is:<tag>)
+ notmuch search term1 ADJ term2
- · id:<message-id>
+ 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:
- · thread:<thread-id>
+ notmuch search term1 ADJ/7 term2
+
- · folder:<maildir-folder>
+ Stemming
+
+ Stemming in notmuch means that these searches
- · path:<directory-path> or path:<directory-path>/**
+ notmuch search detailed
+ notmuch search details
+ notmuch search detail
- · date:<since>..<until>
+ will all return identical results, because Xapian first "reduces" the
+ term to the common stem (here 'detail') and then performs the search.
- The from: prefix is used to match the name or address of the sender of
- an email message.
+ 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.
+
- The to: prefix is used to match the names or addresses of any recipient
- of an email message, (whether To, Cc, or Bcc).
+ Wildcards
+
+ It is possible to use a trailing '*' as a wildcard. A search for
+ 'wildc*' will match 'wildcard', 'wildcat', etc.
+
- Any term prefixed with subject: will match only text from the subject
- of an email. Searching for a phrase in the subject is supported by
- including quotation marks around the phrase, immediately following sub-
- ject:.
+ 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 strictly fitting either of Xapian's built in
+ styles. The prefixes currently supported by notmuch are as follows.
- The attachment: prefix can be used to search for specific filenames (or
- extensions) of attachments to email messages.
+ Boolean
+ tag:, id:, thread:, folder:, path:, property:
- 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.
+ Probabilistic
+ to:, attachment:, mimetype:
- For id:, message ID values are the literal contents of the Message-ID:
- header of email messages, but without the '<', '>' delimiters.
+ Special
+ from:, query:, subject:
+
- 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
+ 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 equivalent ways to write the same phrase.
- 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
- the root of the mail store and, likewise, path:** matches all messages.
+ · "a list of words"
- 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" 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
- system" maildir, the inbox is typically folder:INBOX and nested folders
- are separated by slashes, such as folder:classes/topology.
+ · a-list-of-words
- Both path: and folder: will find a message if any copy of that message
- is in the specific directory/folder.
+ · a/list/of/words
- 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:
+ · a.list.of.words
- date:<since>..<until>
+ Both parenthesised lists of terms and quoted phrases are ok with probaâ
+ bilistic prefixes such as to:, from:, and subject:. In particular
- See DATE AND TIME SEARCH below for details on the range expression, and
- supported syntax for <since> and <until> date and time expressions.
+ subject:(pizza free)
- The time range can also be specified using timestamps with a syntax of:
+ is equivalent to
- <initial-timestamp>..<final-timestamp>
+ subject:pizza and subject:free
- Each timestamp is a number representing the number of seconds since
- 1970-01-01 00:00:00 UTC.
+ Both of these will match a subject "Free Delicious Pizza" while
- 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).
+ subject:"pizza free"
- 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).
+ will not.
DATE AND TIME SEARCH
- notmuch understands a variety of standard and natural ways of express-
- ing dates and times, both in absolute terms ("2012-10-24") and in rela-
- tive terms ("yesterday"). Any number of relative terms can be combined
- ("1 hour 25 minutes") and an absolute date/time can be combined with
- relative terms to further adjust it. A non-exhaustive description of
+ notmuch understands a variety of standard and natural ways of expressâ
+ ing dates and times, both in absolute terms ("2012-10-24") and in relaâ
+ tive terms ("yesterday"). Any number of relative terms can be combined
+ ("1 hour 25 minutes") and an absolute date/time can be combined with
+ relative terms to further adjust it. A non-exhaustive description of
the syntax supported for absolute and relative terms is given below.
@@ -144,47 +274,49 @@
date:<since>..<until>
- The above expression restricts the results to only messages from
+ The above expression restricts the results to only messages from
<since> to <until>, based on the Date: header.
- <since> and <until> can describe imprecise times, such as "yesterday".
- In this case, <since> is taken as the earliest time it could describe
+ <since> and <until> can describe imprecise times, such as "yesterday".
+ In this case, <since> is taken as the earliest time it could describe
(the beginning of yesterday) and <until> is taken as the latest time it
- could describe (the end of yesterday). Similarly, date:january..febru-
+ 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
+ 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
for clarity.
- Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's possi-
+ 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
- [N|number]
+ [N|number] (years|months|weeks|days|hours|hrs|minutes|mins|secâ
onds|secs) [...]
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
@@ -243,11 +375,30 @@
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-restore(1), notmuch-search(1), notmuch-show(1), notmuch-tag(1)
+ 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)
AUTHOR
@@ -257,7 +408,7 @@
COPYRIGHT
- 2014, Carl Worth and many others
+ 2009-2018, Carl Worth and many others
-0.18
+0.26