picked instructions how to do that from commit message from Aug 2013.
=================
* <a href='notmuch-1/'>notmuch</a>(1) - thread-based email index, search, and tagging
+* <a href='notmuch-compact-1/'>notmuch-compact</a>(1) - compact the notmuch database
* <a href='notmuch-config-1/'>notmuch-config</a>(1) - access notmuch configuration file
* <a href='notmuch-count-1/'>notmuch-count</a>(1) - count messages matching the given search terms
* <a href='notmuch-dump-1/'>notmuch-dump</a>(1) - creates a plain-text dump of the tags of each message
tax. See notmuch-search-terms(7) for more details on the supported syn-
tax.
- The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email data-
- base.
+ The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email
+ database.
The <b>reply</b> command is useful for preparing a template for an email
reply.
(server: irc.freenode.net, channel: #notmuch).
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
--- /dev/null
+<h1>NOTMUCH-COMPACT(1)</h1>
+
+<h2>NAME</h2>
+<pre>
+ notmuch-compact - compact the notmuch database
+</pre>
+
+<h2>SYNOPSIS</h2>
+<pre>
+ <b>notmuch</b> <b>compact</b> [ --quiet ] [ --backup=<<u>directory</u>> ]
+</pre>
+
+<h2>DESCRIPTION</h2>
+<pre>
+ The <b>compact</b> command can be used to compact the notmuch database. This
+ can both reduce the space required by the database and improve lookup
+ performance.
+
+ The compacted database is built in a temporary directory and is later
+ moved into the place of the origin database. The original uncompacted
+ database is discarded, unless the <b>--backup=</b><directory> option is used.
+
+ Note that the database write lock will be held during the compaction
+ process (which may be quite long) to protect data integrity.
+
+ Supported options for <b>compact</b> include
+
+ <b>--backup=</b><directory>
+
+ Save the current database to the given directory before replac-
+ ing it with the compacted database. The backup directory must
+ not exist and it must reside on the same mounted filesystem as
+ the current database.
+
+ <b>--quiet</b>
+
+ Do not report database compaction progress to stdout.
+</pre>
+
+<h2>ENVIRONMENT</h2>
+<pre>
+ The following environment variables can be used to control the behavior
+ of notmuch.
+
+ <b>NOTMUCH</b>_<b>CONFIG</b>
+ Specifies the location of the notmuch configuration file. Not-
+ much will use ${HOME}/.notmuch-config if this variable is not
+ set.
+</pre>
+
+<h2>SEE ALSO</h2>
+<pre>
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
+ <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
+ <a href='../notmuch-tag-1/'>tag</a>(1)
+</pre>
+
+<h2>Notmuch 0.17</h2>
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
The number of matching messages (or threads) is output to stdout.
- With no search terms, a count of all messages (or threads) in the data-
- base will be displayed.
+ With no search terms, a count of all messages (or threads) in the
+ database will be displayed.
See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
<search-terms>.
Supported options for <b>count</b> include
- <b>--output=(messages|threads)</b>
+ <b>--output=(messages|threads|files)</b>
<b>messages</b>
Output the number of matching threads.
+ <b>files</b>
+
+ Output the number of files associated with matching mes-
+ sages. This may be bigger than the number of matching mes-
+ sages due to duplicates (i.e. multiple files having the
+ same message-id).
+
<b>--exclude=(true|false)</b>
- Specify whether to omit messages matching search.tag_exclude
+ Specify whether to omit messages matching search.tag_exclude
from the count (the default) or not.
<b>--batch</b>
- Read queries from a file (stdin by default), one per line, and
- output the number of matching messages (or threads) to stdout,
- one per line. On an empty input line the count of all messages
+ Read queries from a file (stdin by default), one per line, and
+ output the number of matching messages (or threads) to stdout,
+ one per line. On an empty input line the count of all messages
(or threads) in the database will be output. This option is not
compatible with specifying search terms on the command line.
<b>--input=</b><filename>
- Read input from given file, instead of from stdin. Implies
+ Read input from given file, instead of from stdin. Implies
<b>--batch</b>.
</pre>
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
- <a href='../notmuch-insert-1/'>much-insert</a>(1),
<a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
- <a href='../notmuch-search-1/'>notmuch-search</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
+ <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
+ <a href='../notmuch-insert-1/'>much-insert</a>(1),
<a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-search-1/'>notmuch-search</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
Notmuch restore supports two plain text dump formats, both with one
message-id per line, followed by a list of tags.
- <b>sup</b>
-
- The <b>sup</b> dump file format is specifically chosen to be compati-
+ <b>sup</b> The <b>sup</b> dump file format is specifically chosen to be compati-
ble with the format of files produced by sup-dump. So if
you've previously been using sup for mail, then the <b>notmuch</b>
<b>restore</b> command provides you a way to import all of your tags
Tags are hex-encoded by replacing every byte not matching the
regex <b>[A-Za-z0-9@=.,</b>_<b>+-]</b> with <b>%nn</b> where nn is the two digit hex
encoding. The message ID is a valid Xapian query, quoted using
- Xapian boolean term quoting rules: if the ID contains white-
- space or a close paren or starts with a double quote, it must
- be enclosed in double quotes and double quotes inside the ID
- must be doubled. The astute reader will notice this is a spe-
- cial case of the batch input format for <a href='../notmuch-tag-1/'>notmuch-tag</a>(1); note
- th
at the single message-id query is mandatory for <a href='../notmuch-restore-1/'>notmuch-</a>
+ Xapian boolean term quoting rules: if the ID contains whites-
+ pace or a close paren or starts with a double quote, it must be
+ enclosed in double quotes and double quotes inside the ID must
+ be doubled. The astute reader will notice this is a special
+ case of the batch input format for <a href='../notmuch-tag-1/'>notmuch-tag</a>(1); note that
+ th
e single message-id query is mandatory for <a href='../notmuch-restore-1/'>notmuch-</a>
<a href='../notmuch-restore-1/'>restore</a>(1).
With no search terms, a dump of all messages in the database will
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
configuration option, then by operations specified on the command-line:
tags prefixed by '+' are added while those prefixed by '-' are removed.
- If the new message is a duplicate of an existing message in the data-
- base (it has same Message-ID), it will be added to the maildir folder
- and notmuch database, but the tags will not be changed.
+ If the new message is a duplicate of an existing message in the
+ database (it has same Message-ID), it will be added to the maildir
+ folder and notmuch database, but the tags will not be changed.
- Option arguments must appear before any tag operation arguments. Sup-
+ Option arguments must appear before any tag operation arguments. Sup-
ported options for <b>insert</b> include
<b>--folder=</b><<b>&</b>lt;<u>folder</u>><b>&</b>gt;
- Deliver the message to the specified folder, relative to the
- top-level directory given by the value of <b>database.path</b>. The
+ Deliver the message to the specified folder, relative to the
+ top-level directory given by the value of <b>database.path</b>. The
default is to deliver to the top-level directory.
<b>--create-folder</b>
- Try to create the folder named by the <b>--folder</b> option, if it
- does not exist. Otherwise the folder must already exist for
+ Try to create the folder named by the <b>--folder</b> option, if it
+ does not exist. Otherwise the folder must already exist for
mail delivery to succeed.
</pre>
<h2>EXIT STATUS</h2>
<pre>
- This command returns exit status 0 if the message was successfully
- added to the mail directory, even if the message could not be indexed
- and added to the notmuch database. In the latter case, a warning will
+ This command returns exit status 0 if the message was successfully
+ added to the mail directory, even if the message could not be indexed
+ and added to the notmuch database. In the latter case, a warning will
be printed to standard error but the message file will be left on disk.
If the message could not be written to disk then a non-zero exit status
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
<b>--format=</b>(<b>default</b>|<b>json</b>|<b>sexp</b>|<b>headers-only</b>)
<b>default</b>
- Includes subject and quoted message body.
+ Includes subject and quoted message body as an RFC 2822
+ message.
<b>json</b>
Produces JSON output containing headers for a reply mes-
sage and the contents of the original message. This out-
- put can be used by a client to create a reply message
+ put can be used by a client to create a reply message
intelligently.
<b>sexp</b>
- Produces S-Expression output containing headers for a
- reply message and the contents of the original message.
- This output can be used by a client to create a reply
+ Produces S-Expression output containing headers for a
+ reply message and the contents of the original message.
+ This output can be used by a client to create a reply
message intelligently.
<b>headers-only</b>
- Only produces In-Reply-To, References, To, Cc, and Bcc
+ Only produces In-Reply-To, References, To, Cc, and Bcc
headers.
<b>--format-version=N</b>
Replies to all addresses.
<b>sender</b>
- Replies only to the sender. If replying to user's own
- message (Reply-to: or From: header is one of the user's
- configured email addresses), try To:, Cc:, and Bcc:
- headers in this order, and copy values from the first
- that contains something other than only the user's
+ Replies only to the sender. If replying to user's own
+ message (Reply-to: or From: header is one of the user's
+ configured email addresses), try To:, Cc:, and Bcc:
+ headers in this order, and copy values from the first
+ that contains something other than only the user's
addresses.
<b>--decrypt</b>
- Decrypt any MIME encrypted parts found in the selected con-
- tent (ie. "multipart/encrypted" parts). Status of the
- decryption will be reported (currently only supported with
- --format=json and --format=sexp) and on successful decryp-
- tion the multipart/encrypted part will be replaced by the
+ Decrypt any MIME encrypted parts found in the selected con-
+ tent (ie. "multipart/encrypted" parts). Status of the
+ decryption will be reported (currently only supported with
+ --format=json and --format=sexp) and on successful decryp-
+ tion the multipart/encrypted part will be replaced by the
decrypted content.
Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
needed credentials. Without one, the decryption will fail.
- See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
+ See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
<search-terms>.
- Note: It is most common to use <b>notmuch</b> <b>reply</b> with a search string
- matching a single message, (such as id:<message-id>), but it can be
+ Note: It is most common to use <b>notmuch</b> <b>reply</b> with a search string
+ matching a single message, (such as id:<message-id>), but it can be
useful to reply to several messages at once. For example, when a series
- of patches are sent in a single thread, replying to the entire thread
- allows for the reply to comment on issues found in multiple patches.
- The default format supports replying to multiple messages at once, but
+ of patches are sent in a single thread, replying to the entire thread
+ allows for the reply to comment on issues found in multiple patches.
+ The default format supports replying to multiple messages at once, but
the JSON and S-Expression formats do not.
</pre>
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
- <a href='../notmuch-search-1/'>notmuch-search</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
+ <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-search-1/'>notmuch-search</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
line specifying a message-id and a set of tags. For details of
the actual formats, see <a href='../notmuch-dump-1/'>notmuch-dump</a>(1).
- <b>sup</b>
-
- The <b>sup</b> dump file format is specifically chosen to be com-
+ <b>sup</b> The <b>sup</b> dump file format is specifically chosen to be com-
patible with the format of files produced by sup-dump. So
if you've previously been using sup for mail, then the <b>not-</b>
<b>much</b> <b>restore</b> command provides you a way to import all of
<b>batch-tag</b>
The <b>batch-tag</b> dump format is intended to more robust
- against malformed message-ids and tags containing white-
-
space or non-<b>ascii</b>(7) characters. See <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) for
+ against malformed message-ids and tags containing whites-
+
pace or non-<b>ascii</b>(7) characters. See <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) for
details on this format.
<b>notmuch</b> <b>restore</b> updates the maildir flags according to tag
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
null characters (--format=text0), as a JSON array (--for-
mat=json), or as an S-Expression list (--format=sexp).
+ Note that each message may have multiple filenames associ-
+ ated with it. All of them are included in the output,
+ unless limited with the --duplicate=N option.
+
<b>tags</b>
Output all tags that appear on any message matching the
<b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>)
This option can be used to present results in either chronolog-
- ical order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b>
- <b>est-first</b>).
+ ical order (<b>oldest-first</b>) or reverse chronological order
+ (<b>newest-first</b>).
Note: The thread order will be distinct between these two
options (beyond being simply reversed). When sorting by <b>old-</b>
almost identical to <b>false</b>, but the "match count" is the number
of matching non-excluded messages in the thread, rather than
the number of matching messages.
+
+ <b>--duplicate=N</b>
+
+ Effective with <b>--output=files</b>, output the Nth filename associ-
+ ated with each message matching the query (N is 1-based). If N
+ is greater than the number of files associated with the mes-
+ sage, don't print anything.
+
+ Note that this option is orthogonal with the <b>folder:</b> search
+ prefix. The prefix matches messages based on filenames. This
+ option filters filenames of the matching messages.
</pre>
<h2>EXIT STATUS</h2>
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
- <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
+ <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
<a href='../notmuch-tag-1/'>tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
<b>notmuch</b> <b>search</b>
The <b>folder:</b> prefix can be used to search for email message files that
- are contained within particular directories within the mail store. Only
- the directory components below the top-level mail database path are
- available to be searched.
+ are contained within particular directories within the mail store. If
+ the same email message has multiple message files associated with it,
+ it's sufficient for a match that at least one of the files is contained
+ within a matching directory. Only the directory components below the
+ top-level mail database path are available to be searched.
The <b>date:</b> prefix can be used to restrict the results to only messages
within a particular time range (based on the Date: header) with a range
<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.
- In addition to individual terms, multiple terms can be combined with
- Boolean operators ( <b>and</b>, <b>or</b>, <b>not</b> , 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
+ In addition to individual terms, multiple terms can be combined with
+ Boolean operators ( <b>and</b>, <b>or</b>, <b>not</b> , 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).
- 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
+ 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).
</pre>
<h2>DATE AND TIME SEARCH</h2>
<pre>
- notmuch understands a variety of standard and natural ways of express-
+ 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
+ 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.
<b>The</b> <b>range</b> <b>expression</b>
date:<since>..<until>
- The above expression restricts the results to only messages
+ 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 "yes-
- terday". 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 yester-
- day). Similarly, date:january..february matches from the begin-
- ning of January to the end of February.
+ <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 yes-
+ terday). Similarly, date:january..february matches from the
+ beginning of January to the end of February.
- Currently, we do not support spaces in range expressions. You
+ 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
+ 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
- possible 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
+ possible 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..yester-
+ 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..yester-
day).
<b>Relative</b> <b>date</b> <b>and</b> <b>time</b>
All refer to past, can be repeated and will be accumulated.
- Units can be abbreviated to any length, with the otherwise
+ 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, hun-
- dred. Additionally, the unit may be preceded by "last" or
+ Number can also be written out one, two, ..., ten, dozen, hun-
+ dred. 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
+ 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
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
<a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
tax. See notmuch-search-terms(7) for more details on the supported syn-
tax.
- The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email data-
- base.
+ The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email
+ database.
The <b>reply</b> command is useful for preparing a template for an email
reply.
(server: irc.freenode.net, channel: #notmuch).
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
(ie. "multipart/encrypted" parts). Status of the decryption
will be reported (currently only supported with --format=json
and --format=sexp) and on successful decryption the multi-
- part/encrypted part will be replaced by the decrypted content.
+ part/encrypted part will be replaced by the decrypted content.
- Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
+ Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
needed credentials. Without one, the decryption will fail.
Implies --verify.
<b>--exclude=(true|false)</b>
- Specify whether to omit threads only matching search.tag_ex-
- clude from the search results (the default) or not. In either
- case the excluded message will be marked with the exclude flag
- (except when output=mbox when there is nowhere to put the
+ Specify whether to omit threads only matching search.tag_ex-
+ clude from the search results (the default) or not. In either
+ case the excluded message will be marked with the exclude flag
+ (except when output=mbox when there is nowhere to put the
flag).
- If --entire-thread is specified then complete threads are re-
+ If --entire-thread is specified then complete threads are re-
turned regardless (with the excluded flag being set when appro-
- priate) but threads that only match in an excluded message are
+ priate) but threads that only match in an excluded message are
not returned when <b>--exclude=true.</b>
The default is <b>--exclude=true.</b>
<b>--body=(true|false)</b>
- If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
- messages in the output; if false, bodies are omitted.
- <b>--body=false</b> is only implemented for the json and sexp formats
+ If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
+ messages in the output; if false, bodies are omitted.
+ <b>--body=false</b> is only implemented for the json and sexp formats
and it is incompatible with <b>--part</b> ><b>&</b>gt; <b>0.</b>
- This is useful if the caller only needs the headers as body-
+ This is useful if the caller only needs the headers as body-
less output is much faster and substantially smaller.
- A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email
+ <b>--include-html</b>
+
+ Include "text/html" parts as part of the output (currently only
+ supported with --format=json and --format=sexp). By default,
+ unless <b>--part=N</b> is used to select a specific part or <b>--include-</b>
+ <b>html</b> is used to include all "text/html" parts, no part with
+ content type "text/html" is included in the output.
+
+ A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email
messages. For this, use a search term of "thread:<thread-id>" as can be
seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
</pre>
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
<a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-tag-1/'>not-</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
+<<u>tag</u>>|-<<u>tag</u>> [...] [--] <<u>query</u>>
- Each line is interpreted similarly to <b>notmuch</b> <b>tag</b> command line argu-
- ments. The delimiter is one or more spaces ' '. Any characters in <<u>tag</u>>
- <b>may</b> be hex-encoded with %NN where NN is the hexadecimal value of the
- character. To hex-encode a character with a multi-byte UTF-8 encoding,
- hex-encode each byte. Any spaces in <tag> <b>must</b> be hex-encoded as %20.
- Any characters that are not part of <<u>tag</u>> <b>must</b> <b>not</b> be hex-encoded.
-
- In the future tag:"tag with spaces" style quoting may be supported for
- <<u>tag</u>> as well; for this reason all double quote characters in <<u>tag</u>>
+ Each line is interpreted similarly to <b>notmuch</b> <b>tag</b> command line
+ arguments. The delimiter is one or more spaces ' '. Any characters in
+ <<u>tag</u>> <b>may</b> be hex-encoded with %NN where NN is the hexadecimal value of
+ the character. To hex-encode a character with a multi-byte UTF-8 encod-
+ ing, hex-encode each byte. Any spaces in <tag> <b>must</b> be hex-encoded as
+ %20. Any characters that are not part of <<u>tag</u>> <b>must</b> <b>not</b> be hex-encoded.
+
+ In the future tag:"tag with spaces" style quoting may be supported for
+ <<u>tag</u>> as well; for this reason all double quote characters in <<u>tag</u>>
<b>should</b> be hex-encoded.
- The <<u>query</u>> should be quoted using Xapian boolean term quoting rules:
- if a term contains whitespace or a close paren or starts with a double
- quote, it must be enclosed in double quotes (not including any prefix)
- and double quotes inside the term must be doubled (see below for exam-
+ The <<u>query</u>> should be quoted using Xapian boolean term quoting rules:
+ if a term contains whitespace or a close paren or starts with a double
+ quote, it must be enclosed in double quotes (not including any prefix)
+ and double quotes inside the term must be doubled (see below for exam-
ples).
Leading and trailing space ' ' is ignored. Empty lines and lines begin-
<h3> EXAMPLE</h3>
<pre>
- The following shows a valid input to batch tagging. Note that only the
- isolated '*' acts as a wildcard. Also note the two different quotings
+ The following shows a valid input to batch tagging. Note that only the
+ isolated '*' acts as a wildcard. Also note the two different quotings
of the tag <b>space</b> <b>in</b> <b>tags</b>
+winner *
+foo::bar%25 -- (One and Two) or (One and tag:winner)
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-1/'>notmuch</a>(1),
<a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5),
<a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
<a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>not-</a>
<a href='../notmuch-show-1/'>much-show</a>(1),
</pre>
-<h2>Notmuch 0.16</h2>
+<h2>Notmuch 0.17</h2>
projects / notmuch-wiki / commitdiff