debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-25 12:28:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: remove preformatted nroff pages

Browse source 
From now on, we should edit the rst source.
This commit is contained in:
David Bremner 2014-03-09 21:59:27 -03:00
parent eb61cc7839
commit 9b31c62680
17 changed files with 0 additions and 1886 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
man/.gitignore vendored
View file

@ -1,2 +0,0 @@
# ignore gzipped man pages
*.[0-9].gz

5
man/Makefile
View file

@ -1,5 +0,0 @@
all:
$(MAKE) -C .. all
.DEFAULT:
$(MAKE) -C .. $@

62
man/man1/notmuch-compact.1
View file

@ -1,62 +0,0 @@
.TH NOTMUCH-COMPACT 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-compact \- compact the notmuch database
.SH SYNOPSIS
.B notmuch compact
.RI "[ --quiet ]"
.RI "[ --backup=<" directory "> ]"
.SH DESCRIPTION
The
.B compact
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
.BR "\-\-backup=" <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
include
.RS 4
.TP 4
.BR "\-\-backup=" <directory>
Save the current database to the given directory before replacing it
with the compacted database. The backup directory must not exist and
it must reside on the same mounted filesystem as the current database.
.RE
.RS 4
.TP 4
.BR \-\-quiet
Do not report database compaction progress to stdout.
.RE
.RE
.SH ENVIRONMENT
The following environment variables can be used to control the
behavior of notmuch.
.TP
.B NOTMUCH_CONFIG
Specifies the location of the notmuch configuration file. Notmuch will
use ${HOME}/.notmuch\-config if this variable is not set.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
\fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

158
man/man1/notmuch-config.1
View file

@ -1,158 +0,0 @@
.TH NOTMUCH-CONFIG 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-config \- access notmuch configuration file
.SH SYNOPSIS
.B notmuch config get
.RI "<" section ">.<" item ">"
.B notmuch config set
.RI "<" section ">.<" item "> [" value " ...]"
.B notmuch config list
.SH DESCRIPTION
The
.B config
command can be used to get or set settings in the notmuch
configuration file.
.RS 4
.TP 4
.B get
The value of the specified configuration item is printed to stdout. If
the item has multiple values (it is a list), each value is separated
by a newline character.
.RE
.RS 4
.TP 4
.B set
The specified configuration item is set to the given value. To specify
a multiple-value item (a list), provide each value as a separate
command-line argument.
If no values are provided, the specified configuration item will be
removed from the configuration file.
.RE
.RS 4
.TP 4
.B list
Every configuration item is printed to stdout, each on a separate line
of the form:
.RI "" section "." item "=" value
No additional whitespace surrounds the dot or equals sign characters. In a
multiple-value item (a list), the values are separated by semicolon characters.
.RE
The available configuration items are described below.
.RS 4
.TP 4
.B database.path
The top-level directory where your mail currently exists and to where
mail will be delivered in the future. Files should be individual email
messages. Notmuch will store its database within a sub-directory of
the path configured here named
.BR ".notmuch".
.RE
.RS 4
.TP 4
.B user.name
Your full name.
.RE
.RS 4
.TP 4
.B user.primary_email
Your primary email address.
.RE
.RS 4
.TP 4
.B user.other_email
A list of other email addresses at which you receive email.
.RE
.RS 4
.TP 4
.B new.tags
A list of tags that will be added to all messages incorporated by
.BR "notmuch new".
.RE
.RS 4
.TP 4
.B new.ignore
A list of file and directory names, without path, that will not be
searched for messages by
.BR "notmuch new".
All the files and directories matching any of the names specified here
will be ignored, regardless of the location in the mail store
directory hierarchy.
.RE
.RS 4
.TP 4
.B search.exclude_tags
A list of tags that will be excluded from search results by
default. Using an excluded tag in a query will override that
exclusion.
.RE
.RS 4
.TP 4
.B maildir.synchronize_flags
If true, then the following maildir flags (in message filenames) will
be synchronized with the corresponding notmuch tags:
Flag Tag
---- -------
D draft
F flagged
P passed
R replied
S unread (added when 'S' flag is not present)
The
.B notmuch new
command will notice flag changes in filenames and update tags, while
the
.B notmuch tag
and
.B notmuch restore
commands will notice tag changes and update flags in filenames.
If there have been any changes in the maildir (new messages added, old
ones removed or renamed, maildir flags changed, etc.), it is advisable
to run
.B notmuch new
before
.B notmuch tag
or
.B notmuch restore
commands to ensure the tag changes are properly synchronized to the
maildir flags, as the commands expect the database and maildir to be
in sync.
.RE
.RE
.SH ENVIRONMENT
The following environment variables can be used to control the
behavior of notmuch.
.TP
.B NOTMUCH_CONFIG
Specifies the location of the notmuch configuration file. Notmuch will
use ${HOME}/.notmuch\-config if this variable is not set.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
\fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

86
man/man1/notmuch-count.1
View file

@ -1,86 +0,0 @@
.TH NOTMUCH-COUNT 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-count \- count messages matching the given search terms
.SH SYNOPSIS
.B notmuch count
.RI [ options "... ] <" search-term ">..."
.SH DESCRIPTION
Count messages matching the search terms.
The number of matching messages (or threads) is output to stdout.
With no search terms, a count of all messages (or threads) in the database will
be displayed.
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
Supported options for
.B count
include
.RS 4
.TP 4
.B \-\-output=(messages|threads|files)
.RS 4
.TP 4
.B messages
Output the number of matching messages. This is the default.
.RE
.RS 4
.TP 4
.B threads
Output the number of matching threads.
.RE
.RS 4
.TP 4
.B files
Output the number of files associated with matching messages. This may
be bigger than the number of matching messages due to duplicates
(i.e. multiple files having the same message-id).
.RE
.RE
.RS 4
.TP 4
.BR \-\-exclude=(true|false)
Specify whether to omit messages matching search.tag_exclude from the
count (the default) or not.
.RE
.RS 4
.TP 4
.BR \-\-batch
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.
.RE
.RS 4
.TP 4
.BR "\-\-input=" <filename>
Read input from given file, instead of from stdin. Implies
.BR --batch .
.RE
.RE
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-dump\fR(1),
\fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

100
man/man1/notmuch-dump.1
View file

@ -1,100 +0,0 @@
.TH NOTMUCH-DUMP 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-dump \- creates a plain-text dump of the tags of each message
.SH SYNOPSIS
.B "notmuch dump"
.RB [ "\-\-format=(sup|batch-tag)" "] [--]"
.RI "[ --output=<" filename "> ] [--]"
.RI "[ <" search-term ">...]"
.SH DESCRIPTION
Dump tags for messages matching the given search terms.
Output is to the given filename, if any, or to stdout.
These tags are the only data in the notmuch database that can't be
recreated from the messages themselves. The output of notmuch dump is
therefore the only critical thing to backup (and much more friendly to
incremental backup than the native database files.)
.TP 4
.B \-\-format=(sup|batch-tag)
Notmuch restore supports two plain text dump formats, both with one message-id
per line, followed by a list of tags.
.RS 4
.TP 4
.B batch-tag
The default
.B batch-tag
dump format is intended to more robust against malformed message-ids
and tags containing whitespace or non-\fBascii\fR(7) characters.
Each line has the form
.RS 4
.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >
Tags are hex-encoded by replacing every byte not matching the regex
.B [A-Za-z0-9@=.,_+-]
with
.B %nn
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
whitespace 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 \fBnotmuch-tag\fR(1); note that the single message-id query is
mandatory for \fBnotmuch-restore\fR(1).
.RE
.RE
.RS 4
.TP 4
.B sup
The
.B sup
dump file format is specifically chosen to be
compatible with the format of files produced by sup-dump.
So if you've previously been using sup for mail, then the
.B "notmuch restore"
command provides you a way to import all of your tags (or labels as
sup calls them).
Each line has the following form
.RS 4
.RI < message-id >
.B (
.RI < tag "> ..."
.B )
with zero or more tags are separated by spaces. Note that (malformed)
message-ids may contain arbitrary non-null characters. Note also
that tags with spaces will not be correctly restored with this format.
.RE
.RE
With no search terms, a dump of all messages in the database will be
generated. A "--" argument instructs notmuch that the
remaining arguments are search terms.
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

75
man/man1/notmuch-insert.1
View file

@ -1,75 +0,0 @@
.TH NOTMUCH-INSERT 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-insert \- add a message to the maildir and notmuch database
.SH SYNOPSIS
.B notmuch insert
.RI "[" options "]"
.RI "[ +<" tag> "|\-<" tag "> ... ]"
.SH DESCRIPTION
.B notmuch insert
reads a message from standard input
and delivers it into the maildir directory given by configuration option
.BR database.path ,
then incorporates the message into the notmuch database.
It is an alternative to using a separate tool to deliver
the message then running
.B notmuch new
afterwards.
The new message will be tagged with the tags specified by the
.B new.tags
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 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.
Supported options for
.B insert
include
.RS 4
.TP 4
.BI "--folder=<" folder ">"
Deliver the message to the specified folder,
relative to the top-level directory given by the value of
\fBdatabase.path\fR.
The default is to deliver to the top-level directory.
.RE
.RS 4
.TP 4
.B "--create-folder"
Try to create the folder named by the
.B "--folder"
option, if it does not exist.
Otherwise the folder must already exist for mail
delivery to succeed.
.RE
.SH EXIT STATUS
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 is returned.
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),
\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

75
man/man1/notmuch-new.1
View file

@ -1,75 +0,0 @@
.TH NOTMUCH-NEW 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-new \- incorporate new mail into the notmuch database
.SH SYNOPSIS
.B notmuch new
.RB "[" --no-hooks "]"
.SH DESCRIPTION
Find and import any new messages to the database.
The
.B new
command scans all sub-directories of the database, performing
full-text indexing on new messages that are found. Each new message
will automatically be tagged with both the
.BR inbox " and " unread
tags.
You should run
.B "notmuch new"
once after first running
.B "notmuch setup"
to create the initial database. The first run may take a long time if
you have a significant amount of mail (several hundred thousand
messages or more). Subsequently, you should run
.B "notmuch new"
whenever new mail is delivered and you wish to incorporate it into the
database. These subsequent runs will be much quicker than the initial
run.
Invoking
.B notmuch
with no command argument will run
.B new
if
.B "notmuch setup"
has previously been completed, but
.B "notmuch new"
has not previously been run.
.B "notmuch new"
updates tags according to maildir flag changes if the
.B "maildir.synchronize_flags"
configuration option is enabled. See \fBnotmuch-config\fR(1) for
details.
The
.B new
command supports hooks. See \fBnotmuch-hooks(5)\fR
for more details on hooks.
Supported options for
.B new
include
.RS 4
.TP 4
.BR \-\-no\-hooks
Prevents hooks from being run.
.RE
.RS 4
.TP 4
.BR \-\-quiet
Do not print progress or results.
.RE
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

133
man/man1/notmuch-reply.1
View file

@ -1,133 +0,0 @@
.TH NOTMUCH-REPLY 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-reply \- constructs a reply template for a set of messages
.SH SYNOPSIS
.B notmuch reply
.RI "[" options "...] <" search-term ">..."
.SH DESCRIPTION
Constructs a reply template for a set of messages.
To make replying to email easier,
.B notmuch reply
takes an existing set of messages and constructs a suitable mail
template. The Reply-to: header (if any, otherwise From:) is used for
the To: address. Unless
.BR \-\-reply-to=sender
is specified, values from the To: and Cc: headers are copied, but not
including any of the current user's email addresses (as configured in
primary_mail or other_email in the .notmuch\-config file) in the
recipient list.
It also builds a suitable new subject, including Re: at the front (if
not already present), and adding the message IDs of the messages being
replied to to the References list and setting the In\-Reply\-To: field
correctly.
Finally, the original contents of the emails are quoted by prefixing
each line with '> ' and included in the body.
The resulting message template is output to stdout.
Supported options for
.B reply
include
.RS
.TP 4
.BR \-\-format= ( default | json | sexp | headers\-only )
.RS
.TP 4
.BR default
Includes subject and quoted message body as an RFC 2822 message.
.TP
.BR json
Produces JSON 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.
.TP
.BR sexp
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.
.TP
.BR headers\-only
Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
.RE
.RE
.RS
.TP 4
.BR \-\-format-version=N
Use the specified structured output format version. This is intended
for programs that invoke \fBnotmuch\fR(1) internally. If omitted, the
latest supported version will be used.
.RE
.RS
.TP 4
.BR \-\-reply\-to= ( all | sender )
.RS
.TP 4
.BR all " (default)"
Replies to all addresses.
.TP 4
.BR sender
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.
.RE
.RE
.RS
.TP 4
.B \-\-decrypt
Decrypt any MIME encrypted parts found in the selected content
(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 multipart/encrypted
part will be replaced by the decrypted content.
Decryption expects a functioning \fBgpg-agent\fR(1) to provide any
needed credentials. Without one, the decryption will fail.
.RE
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
Note: It is most common to use
.B "notmuch reply"
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 the JSON and S-Expression
formats do not.
.RE
.RE
.SH EXIT STATUS
This command supports the following special exit status codes
.TP
.B 20
The requested format version is too old.
.TP
.B 21
The requested format version is too new.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

91
man/man1/notmuch-restore.1
View file

@ -1,91 +0,0 @@
.TH NOTMUCH-RESTORE 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-restore \- restores the tags from the given file (see notmuch dump)
.SH SYNOPSIS
.B "notmuch restore"
.RB [ "--accumulate" ]
.RB [ "--format=(auto|batch-tag|sup)" ]
.RI "[ --input=<" filename "> ]"
.SH DESCRIPTION
Restores the tags from the given file (see
.BR "notmuch dump" ")."
The input is read from the given filename, if any, or from stdin.
Supported options for
.B restore
include
.RS 4
.TP 4
.B \-\-accumulate
The union of the existing and new tags is applied, instead of
replacing each message's tags as they are read in from the dump file.
.RE
.RS 4
.TP 4
.B \-\-format=(sup|batch-tag|auto)
Notmuch restore supports two plain text dump formats, with each line
specifying a message-id and a set of tags.
For details of the actual formats, see \fBnotmuch-dump\fR(1).
.RS 4
.TP 4
.B sup
The
.B sup
dump file format is specifically chosen to be
compatible with the format of files produced by sup-dump.
So if you've previously been using sup for mail, then the
.B "notmuch restore"
command provides you a way to import all of your tags (or labels as
sup calls them).
.RE
.RS 4
.TP 4
.B batch-tag
The
.B batch-tag
dump format is intended to more robust against malformed message-ids
and tags containing whitespace or non-\fBascii\fR(7) characters. See
\fBnotmuch-dump\fR(1) for details on this format.
.B "notmuch restore"
updates the maildir flags according to tag changes if the
.B "maildir.synchronize_flags"
configuration option is enabled. See \fBnotmuch-config\fR(1) for
details.
.RE
.RS 4
.TP 4
.B auto
This option (the default) tries to guess the format from the
input. For correctly formed input in either supported format, this
heuristic, based the fact that batch-tag format contains no parentheses,
should be accurate.
.RE
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

199
man/man1/notmuch-search.1
View file

@ -1,199 +0,0 @@
.TH NOTMUCH-SEARCH 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-search \- search for messages matching the given search terms
.SH SYNOPSIS
.B notmuch search
.RI [ options "...] <" search-term ">..."
.SH DESCRIPTION
Search for messages matching the given search terms, and display as
results the threads containing the matched messages.
The output consists of one line per thread, giving a thread ID, the
date of the newest (or oldest, depending on the sort option) matched
message in the thread, the number of matched messages and total
messages in the thread, the names of all participants in the thread,
and the subject of the newest (or oldest) message.
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
Supported options for
.B search
include
.RS 4
.TP 4
.BR \-\-format= ( json | sexp | text | text0 )
Presents the results in either JSON, S-Expressions, newline character
separated plain-text (default), or null character separated plain-text
(compatible with \fBxargs\fR(1) -0 option where available).
.RE
.RS 4
.TP 4
.BR \-\-format-version=N
Use the specified structured output format version. This is intended
for programs that invoke \fBnotmuch\fR(1) internally. If omitted, the
latest supported version will be used.
.RE
.RS 4
.TP 4
.B \-\-output=(summary|threads|messages|files|tags)
.RS 4
.TP 4
.B summary
Output a summary of each thread with any message matching the search
terms. The summary includes the thread ID, date, the number of
messages in the thread (both the number matched and the total number),
the authors of the thread and the subject.
.RE
.RS 4
.TP 4
.B threads
Output the thread IDs of all threads with any message matching the
search terms, either one per line (\-\-format=text), separated by null
characters (\-\-format=text0), as a JSON array (\-\-format=json), or
an S-Expression list (\-\-format=sexp).
.RE
.RS 4
.TP 4
.B messages
Output the message IDs of all messages matching the search terms,
either one per line (\-\-format=text), separated by null characters
(\-\-format=text0), as a JSON array (\-\-format=json), or as an
S-Expression list (\-\-format=sexp).
.RE
.RS 4
.TP 4
.B files
Output the filenames of all messages matching the search terms, either
one per line (\-\-format=text), separated by null characters
(\-\-format=text0), as a JSON array (\-\-format=json), or as an
S-Expression list (\-\-format=sexp).
Note that each message may have multiple filenames associated with it.
All of them are included in the output, unless limited with the
\-\-duplicate=N option.
.RE
.RS 4
.TP 4
.B tags
Output all tags that appear on any message matching the search terms,
either one per line (\-\-format=text), separated by null characters
(\-\-format=text0), as a JSON array (\-\-format=json), or as an
S-Expression list (\-\-format=sexp).
.RE
.RE
.RS 4
.TP 4
.BR \-\-sort= ( newest\-first | oldest\-first )
This option can be used to present results in either chronological order
.RB ( oldest\-first )
or reverse chronological order
.RB ( newest\-first ).
Note: The thread order will be distinct between these two options
(beyond being simply reversed). When sorting by
.B oldest\-first
the threads will be sorted by the oldest message in each thread, but
when sorting by
.B newest\-first
the threads will be sorted by the newest message in each thread.
By default, results will be displayed in reverse chronological order,
(that is, the newest results will be displayed first).
.RE
.RS 4
.TP 4
.BR \-\-offset=[\-]N
Skip displaying the first N results. With the leading '\-', start at the Nth
result from the end.
.RE
.RS 4
.TP 4
.BR \-\-limit=N
Limit the number of displayed results to N.
.RE
.RS 4
.TP 4
.BR \-\-exclude=(true|false|all|flag)
A message is called "excluded" if it matches at least one tag in
search.tag_exclude that does not appear explicitly in the search terms.
This option specifies whether to omit excluded messages in the search
process.
The default value,
.BR true ,
prevents excluded messages from matching the search terms.
.B all
additionally prevents excluded messages from appearing in displayed
results, in effect behaving as though the excluded messages do not exist.
.B false
allows excluded messages to match search terms and appear in displayed
results. Excluded messages are still marked in the relevant outputs.
.B flag
only has an effect when
.BR --output=summary .
The output is almost identical to
.BR false ,
but the "match count" is the number of matching non-excluded messages in the
thread, rather than the number of matching messages.
.RE
.RS 4
.TP 4
.BR \-\-duplicate=N
Effective with
.BR --output=files ,
output the Nth filename associated with each message matching the
query (N is 1-based). If N is greater than the number of files
associated with the message, don't print anything.
Note that this option is orthogonal with the
.BR folder:
search prefix. The prefix matches messages based on filenames. This
option filters filenames of the matching messages.
.RE
.SH EXIT STATUS
This command supports the following special exit status codes
.TP
.B 20
The requested format version is too old.
.TP
.B 21
The requested format version is too new.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

1
man/man1/notmuch-setup.1
View file

@ -1 +0,0 @@
notmuch.1

250
man/man1/notmuch-show.1
View file

@ -1,250 +0,0 @@
.TH NOTMUCH-SHOW 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-show \- show messages matching the given search terms
.SH SYNOPSIS
.B notmuch show
.RI "[" options "...] <" search-term ">..."
.SH DESCRIPTION
Shows all messages matching the search terms.
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
The messages will be grouped and sorted based on the threading (all
replies to a particular message will appear immediately after that
message in date order). The output is not indented by default, but
depth tags are printed so that proper indentation can be performed by
a post-processor (such as the emacs interface to notmuch).
Supported options for
.B show
include
.RS 4
.TP 4
.B \-\-entire\-thread=(true|false)
If true,
.B notmuch show
outputs all messages in the thread of any message matching the search
terms; if false, it outputs only the matching messages. For
.B --format=json
and
.B --format=sexp
this defaults to true. For other formats, this defaults to false.
.RE
.RS 4
.TP 4
.B \-\-format=(text|json|sexp|mbox|raw)
.RS 4
.TP 4
.BR text " (default for messages)"
The default plain-text format has all text-content MIME parts
decoded. Various components in the output,
.RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
will be delimited by easily-parsed markers. Each marker consists of a
Control-L character (ASCII decimal 12), the name of the marker, and
then either an opening or closing brace, ('{' or '}'), to either open
or close the component. For a multipart MIME message, these parts will
be nested.
.RE
.RS 4
.TP 4
.B json
The output is formatted with Javascript Object Notation (JSON). This
format is more robust than the text format for automated
processing. The nested structure of multipart MIME messages is
reflected in nested JSON output. By default JSON output includes all
messages in a matching thread; that is, by default,
.B \-\-format=json
sets
.B "\-\-entire\-thread"
The caller can disable this behaviour by setting
.B \-\-entire\-thread=false
.RE
.RS 4
.TP 4
.B sexp
The output is formatted as an S-Expression (sexp). This
format is more robust than the text format for automated
processing. The nested structure of multipart MIME messages is
reflected in nested S-Expression output. By default,
S-Expression output includes all messages in a matching thread;
that is, by default,
.B \-\-format=sexp
sets
.B "\-\-entire\-thread"
The caller can disable this behaviour by setting
.B \-\-entire\-thread=false
.RE
.RS 4
.TP 4
.B mbox
All matching messages are output in the traditional, Unix mbox format
with each message being prefixed by a line beginning with "From " and
a blank line separating each message. Lines in the message content
beginning with "From " (preceded by zero or more '>' characters) have
an additional '>' character added. This reversible escaping
is termed "mboxrd" format and described in detail here:
.nf
.nh
http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
.hy
.fi
.
.RE
.RS 4
.TP 4
.BR raw " (default for a single part, see \-\-part)"
For a message or an attached message part, the original, raw content
of the email message is output. Consumers of this format should expect
to implement MIME decoding and similar functions.
For a single part (\-\-part) the raw part content is output after
performing any necessary MIME decoding. Note that messages with a
simple body still have two parts: part 0 is the whole message and part
1 is the body.
For a multipart part, the part headers and body (including all child
parts) is output.
The raw format must only be used with search terms matching single
message.
.RE
.RE
.RS 4
.TP 4
.BR \-\-format-version=N
Use the specified structured output format version. This is intended
for programs that invoke \fBnotmuch\fR(1) internally. If omitted, the
latest supported version will be used.
.RE
.RS 4
.TP 4
.B \-\-part=N
Output the single decoded MIME part N of a single message. The search
terms must match only a single message. Message parts are numbered in
a depth-first walk of the message MIME structure, and are identified
in the 'json', 'sexp' or 'text' output formats.
.RE
.RS 4
.TP 4
.B \-\-verify
Compute and report the validity of any MIME cryptographic signatures
found in the selected content (ie. "multipart/signed" parts). Status
of the signature will be reported (currently only supported with
--format=json and --format=sexp), and the multipart/signed part
will be replaced by the signed data.
.RE
.RS 4
.TP 4
.B \-\-decrypt
Decrypt any MIME encrypted parts found in the selected content
(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 multipart/encrypted
part will be replaced by the decrypted content.
Decryption expects a functioning \fBgpg-agent\fR(1) to provide any
needed credentials. Without one, the decryption will fail.
Implies --verify.
.RE
.RS 4
.TP 4
.BR \-\-exclude=(true|false)
Specify whether to omit threads only matching search.tag_exclude 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 returned
regardless (with the excluded flag being set when appropriate) but
threads that only match in an excluded message are not returned when
.B --exclude=true.
The default is
.B --exclude=true.
.RE
.RS 4
.TP 4
.B \-\-body=(true|false)
If true (the default)
.B notmuch show
includes the bodies of the messages in the output; if false,
bodies are omitted.
.B --body=false
is only implemented for the json and sexp formats and it is incompatible with
.B --part > 0.
This is useful if the caller only needs the headers as body-less
output is much faster and substantially smaller.
.RE
.RS 4
.TP 4
.B \-\-include-html
Include "text/html" parts as part of the output (currently only supported with
--format=json and --format=sexp).
By default, unless
.B --part=N
is used to select a specific part or
.B --include-html
is used to include all "text/html" parts, no part with content type "text/html"
is included in the output.
.RE
A common use of
.B notmuch show
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 search
command.
.SH EXIT STATUS
This command supports the following special exit status codes
.TP
.B 20
The requested format version is too old.
.TP
.B 21
The requested format version is too new.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
\fBnotmuch-tag\fR(1)

142
man/man1/notmuch-tag.1
View file

@ -1,142 +0,0 @@
.TH NOTMUCH-TAG 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-tag \- add/remove tags for all messages matching the search terms
.SH SYNOPSIS
.B notmuch tag
.RI [ options "...] +<" tag ">|\-<" tag "> [...] [\-\-] <" search-term "> [...]"
.B notmuch tag
.RI "--batch"
.RI "[ --input=<" filename "> ]"
.SH DESCRIPTION
Add/remove tags for all messages matching the search terms.
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for
.RI < search-term >.
Tags prefixed by '+' are added while those prefixed by '\-' are
removed. For each message, tag changes are applied in the order they
appear on the command line.
The beginning of the search terms is recognized by the first
argument that begins with neither '+' nor '\-'. Support for
an initial search term beginning with '+' or '\-' is provided
by allowing the user to specify a "\-\-" argument to separate
the tags from the search terms.
.B "notmuch tag"
updates the maildir flags according to tag changes if the
.B "maildir.synchronize_flags"
configuration option is enabled. See \fBnotmuch-config\fR(1) for
details.
Supported options for
.B tag
include
.RS 4
.TP 4
.BR \-\-remove\-all
Remove all tags from each message matching the search terms before
applying the tag changes appearing on the command line. This means
setting the tags of each message to the tags to be added. If there are
no tags to be added, the messages will have no tags.
.RE
.RS 4
.TP 4
.BR \-\-batch
Read batch tagging operations from a file (stdin by default). This is more
efficient than repeated
.B notmuch tag
invocations. See
.B TAG FILE FORMAT
below for the input format. This option is not compatible with
specifying tagging on the command line.
.RE
.RS 4
.TP 4
.BR "\-\-input=" <filename>
Read input from given file, instead of from stdin. Implies
.BR --batch .
.SH TAG FILE FORMAT
The input must consist of lines of the format:
.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" query ">"
Each line is interpreted similarly to
.B notmuch tag
command line arguments. The delimiter is one or more spaces ' '. Any
characters in
.RI < tag >
.B may
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
be hex-encoded as %20. Any characters that are not
part of
.RI < tag >
.B must not
be hex-encoded.
In the future tag:"tag with spaces" style quoting may be supported for
.RI < tag >
as well;
for this reason all double quote characters in
.RI < tag >
.B should
be hex-encoded.
The
.RI < query >
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
examples).
Leading and trailing space ' ' is ignored. Empty lines and lines
beginning with '#' are ignored.
.SS EXAMPLE
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 in tags
.
.RS
.nf
+winner *
+foo::bar%25 -- (One and Two) or (One and tag:winner)
+found::it -- tag:foo::bar%
# ignore this line and the next
+space%20in%20tags -- Two
# add tag '(tags)', among other stunts.
+crazy{ +(tags) +&are +#possible\e -- tag:"space in tags"
+match*crazy -- tag:crazy{
+some_tag -- id:"this is ""nauty)"""
.fi
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
\fBnotmuch-show\fR(1),

190
man/man1/notmuch.1
View file

@ -1,190 +0,0 @@
.\" notmuch - Not much of an email program, (just index, search and tagging)
.\"
.\" Copyright © 2009 Carl Worth
.\"
.\" Notmuch is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" Notmuch is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see http://www.gnu.org/licenses/ .
.\"
.\" Author: Carl Worth <cworth@cworth.org>
.TH NOTMUCH 1 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch \- thread-based email index, search, and tagging
.SH SYNOPSIS
.B notmuch
.RI "[" option " ...] " command " [" arg " ...]"
.SH DESCRIPTION
Notmuch is a command-line based program for indexing, searching,
reading, and tagging large collections of email messages.
This page describes how to get started using notmuch from the command
line, and gives a brief overview of the commands available. For more
information on e.g.
.B notmuch show
consult the \fBnotmuch-show\fR(1) man page, also accessible via
.B notmuch help show
The quickest way to get started with Notmuch is to simply invoke the
.B notmuch
command with no arguments, which will interactively guide you through
the process of indexing your mail.
.SH NOTE
While the command-line program
.B notmuch
provides powerful functionality, it does not provide the most
convenient interface for that functionality. More sophisticated
interfaces are expected to be built on top of either the command-line
interface, or more likely, on top of the notmuch library
interface. See http://notmuchmail.org for more about alternate
interfaces to notmuch. The emacs-based interface to notmuch (available under
.B emacs/
in the Notmuch source distribution) is probably the most widely used at
this time.
.SH OPTIONS
Supported global options for
.B notmuch
include
.RS 4
.TP 4
.B \-\-help
Print a synopsis of available commands and exit.
.RE
.RS 4
.TP 4
.B \-\-version
Print the installed version of notmuch, and exit.
.RE
.RS 4
.TP 4
.B \-\-config=FILE
Specify the configuration file to use. This overrides any
configuration file specified by ${NOTMUCH_CONFIG}.
.RE
.SH COMMANDS
.SS SETUP
The
.B notmuch setup
command is used to configure Notmuch for first use, (or to reconfigure
it later).
The setup command will prompt for your full name, your primary email
address, any alternate email addresses you use, and the directory
containing your email archives. Your answers will be written to a
configuration file in ${NOTMUCH_CONFIG} (if set) or
${HOME}/.notmuch-config . This configuration file will be created with
descriptive comments, making it easy to edit by hand later to change the
configuration. Or you can run
.B "notmuch setup"
again to change the configuration.
The mail directory you specify can contain any number of
sub-directories and should primarily contain only files with individual
email messages (eg. maildir or mh archives are perfect). If there are
other, non-email files (such as indexes maintained by other email
programs) then notmuch will do its best to detect those and ignore
them.
Mail storage that uses mbox format, (where one mbox file contains many
messages), will not work with notmuch. If that's how your mail is
currently stored, it is recommended you first convert it to maildir
format with a utility such as mb2md before running
.B "notmuch setup" .
Invoking
.B notmuch
with no command argument will run
.B setup
if the setup command has not previously been completed.
.RE
.SS OTHER COMMANDS
Several of the notmuch commands accept search terms with a common
syntax. See \fNnotmuch-search-terms\fR(7)
for more details on the supported syntax.
The
.BR search ", " show " and " count
commands are used to query the email database.
The
.B reply
command is useful for preparing a template for an email reply.
The
.B tag
command is the only command available for manipulating database
contents.
The
.BR dump " and " restore
commands can be used to create a textual dump of email tags for backup
purposes, and to restore from that dump.
The
.B config
command can be used to get or set settings in the notmuch
configuration file.
.SH ENVIRONMENT
The following environment variables can be used to control the
behavior of notmuch.
.TP
.B NOTMUCH_CONFIG
Specifies the location of the notmuch configuration file. Notmuch will
use ${HOME}/.notmuch\-config if this variable is not set.
.TP
.B NOTMUCH_TALLOC_REPORT
Location to write a talloc memory usage report. See
.B talloc_enable_leak_report_full
in \fBtalloc\fR(3)
for more information.
.TP
.B NOTMUCH_DEBUG_QUERY
If set to a non-empty value, the notmuch library will print (to stderr) Xapian
queries it constructs.
.SH SEE ALSO
\fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
The notmuch website:
.B http://notmuchmail.org
.SH CONTACT
Feel free to send questions, comments, or kudos to the notmuch mailing
list <notmuch@notmuchmail.org> . Subscription is not required before
posting, but is available from the notmuchmail.org website.
Real-time interaction with the Notmuch community is available via IRC
(server: irc.freenode.net, channel: #notmuch).

48
man/man5/notmuch-hooks.5
View file

@ -1,48 +0,0 @@
.TH NOTMUCH-HOOKS 5 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-hooks \- hooks for notmuch
.SH SYNOPSIS
$DATABASEDIR/.notmuch/hooks/*
.SH DESCRIPTION
Hooks are scripts (or arbitrary executables or symlinks to such) that notmuch
invokes before and after certain actions. These scripts reside in
the .notmuch/hooks directory within the database directory and must have
executable permissions.
The currently available hooks are described below.
.RS 4
.TP 4
.B pre\-new
This hook is invoked by the
.B new
command before scanning or importing new messages into the database. If this
hook exits with a non-zero status, notmuch will abort further processing of the
.B new
command.
Typically this hook is used for fetching or delivering new mail to be imported
into the database.
.RE
.RS 4
.TP 4
.B post\-new
This hook is invoked by the
.B new
command after new messages have been imported into the database and initial tags
have been applied. The hook will not be run if there have been any errors during
the scan or import.
Typically this hook is used to perform additional query\-based tagging on the
imported messages.
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)

269
man/man7/notmuch-search-terms.7
View file

@ -1,269 +0,0 @@
.TH NOTMUCH-SEARCH-TERMS 7 2013-12-30 "Notmuch 0.17"
.SH NAME
notmuch-search-terms \- syntax for notmuch queries
.SH SYNOPSIS
.B notmuch count
.RI [ options... ]
.RI < search-term ">..."
.B "notmuch dump"
.RI "[ <" filename "> ] [--]"
.RI "[ <" search-term ">...]"
.B notmuch search
.RI [ options "...] <" search-term ">..."
.B notmuch show
.RI "[" options "...] <" search-term ">..."
.B notmuch tag
.RI "+<" tag> "|\-<" tag "> [...] [\-\-] <" search-term ">..."
.SH DESCRIPTION
Several notmuch commands accept a common syntax for search terms.
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
recipient headers.
As a special case, a search string consisting of exactly a single
asterisk ("*") will match all messages.
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):
from:<name-or-address>
to:<name-or-address>
subject:<word-or-quoted-phrase>
attachment:<word>
tag:<tag> (or is:<tag>)
id:<message-id>
thread:<thread-id>
folder:<directory-path>
date:<since>..<until>
The
.B from:
prefix is used to match the name or address of the sender of an email
message.
The
.B to:
prefix is used to match the names or addresses of any recipient of an
email message, (whether To, Cc, or Bcc).
Any term prefixed with
.B 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
.BR subject: .
The
.B attachment:
prefix can be used to search for specific filenames (or extensions) of
attachments to email messages.
For
.BR tag: " and " is:
valid tag values include
.BR inbox " and " unread
by default for new messages added by
.B notmuch new
as well as any other tag values added manually with
.BR "notmuch tag" .
For
.BR id: ,
message ID values are the literal contents of the Message\-ID: header
of email messages, but without the '<', '>' delimiters.
The
.B 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 column of output from
.B "notmuch search"
The
.B folder:
prefix can be used to search for email message files that 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:
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:
date:<since>..<until>
See \fBDATE AND TIME SEARCH\fR below for details on the range
expression, 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.
In addition to individual terms, multiple terms can be
combined with Boolean operators (
.BR 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).
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).
.SH DATE AND TIME SEARCH
notmuch understands a variety of standard and natural ways of
expressing dates and times, both in absolute terms ("2012-10-24") and
in relative 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.
.RS 4
.TP 4
.B The range expression
date:<since>..<until>
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
(the beginning of yesterday) and <until> is taken as the latest time
it could describe (the end of yesterday). 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 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
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..yesterday).
.RE
.RS 4
.TP 4
.B Relative date and time
[N|number] (years|months|weeks|days|hours|hrs|minutes|mins|seconds|secs) [...]
All refer to past, can be repeated and will be accumulated.
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. 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
time.
Examples: 5M2d, two weeks
.RE
.RS 4
.TP 4
.B Supported absolute time formats
H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
H[H] (am|a.m.|pm|p.m.)
HHMMSS
now
noon
midnight
Examples: 17:05, 5pm
.RE
.RS 4
.TP 4
.B Supported absolute date formats
YYYY-MM[-DD]
DD-MM[-[YY]YY]
MM-YYYY
M[M]/D[D][/[YY]YY]
M[M]/YYYY
D[D].M[M][.[YY]YY]
D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
Wee[kday]
Month names can be abbreviated at three or more characters.
Weekday names can be abbreviated at three or more characters.
Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
.RE
.RS 4
.TP 4
.B Time zones
(+|-)HH:MM
(+|-)HH[MM]
Some time zone codes, e.g. UTC, EET.
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search\fR(1), \fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)