debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-23 03:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/man/man1/notmuch-search.1

180 lines
4.8 KiB
Groff
Raw Normal View History

bump versions to 0.15.2
2013-02-17 14:40:52 +01:00
.TH NOTMUCH-SEARCH 1 2013-02-17 "Notmuch 0.15.2"
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.SH NAME
manpages: consistent "format" for NAME section The NAME section in manpages generally doesn't start with capital letter (unless the word is 'proper noun') and doesn't end with period. Notmuch manual pages now matches that "format".
2012-06-24 23:53:27 +02:00
notmuch-search \- search for messages matching the given search terms
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.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.
man/*: fixup page references - Replace references to section X below with page refences. - Add SEE ALSO to each page. This is a bit error prone, because each SEE ALSO section is different, i.e. a page does not refer to itself.
2011-12-20 02:41:48 +01:00
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
Supported options for
.B search
include
.RS 4
.TP 4
man: document notmuch search --format=text0
2012-12-16 23:05:13 +01:00
.BR \-\-format= ( json | sexp | text | text0 )
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
man: document notmuch search --format=text0
2012-12-16 23:05:13 +01:00
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).
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.RE
search: Support --format-version
2012-12-16 04:17:24 +01:00
.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
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.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
man: document notmuch search --format=text0
2012-12-16 23:05:13 +01:00
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).
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.RE
.RS 4
.TP 4
.B messages
Output the message IDs of all messages matching the search terms,
man: document notmuch search --format=text0
2012-12-16 23:05:13 +01:00
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).
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.RE
.RS 4
.TP 4
.B files
Output the filenames of all messages matching the search terms, either
man: document notmuch search --format=text0
2012-12-16 23:05:13 +01:00
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).
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.RE
.RS 4
.TP 4
.B tags
Output all tags that appear on any message matching the search terms,
man: document notmuch search --format=text0
2012-12-16 23:05:13 +01:00
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).
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.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
cli: Add --no-exclude to the man pages for search and count
2012-03-01 23:30:34 +01:00
.RS 4
.TP 4
man: document search --exclude=all Document the new search --exclude=all option.
2013-05-11 21:50:07 +02:00
.BR \-\-exclude=(true|false|all|flag)
cli: move search to the new --exclude= naming scheme. This commit replaces the --no-exclude option with a --exclude=(true|false|flag) option. The default is to omit the excluded messages. The flag option only makes sense if output=summary (as otherwise there is nowhere to print the flag). In summary output exclude=false and exclude=flag give almost identical output: they differ in that with the exclude=flag option the match count (i.e., the x in [x/n] in the output) is the number of matching non-excluded messages rather than the number of matching messages. Note this changes the default for output=summary when no --exclude= option is given: it used to default to flag and now defaults to true (i.e. omit excluded messages). This is neccesary to keep the cli output uncluttered and for speed reasons.
2012-04-07 18:10:05 +02:00
man: clarify search --exclude documentation Highlight "excluded messages" as a term with a meaning that may not be obvious. Be explicit about the effects of search --exclude=true and --exclude=false.
2013-05-11 21:50:05 +02:00
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.
man: document search --exclude=all Document the new search --exclude=all option.
2013-05-11 21:50:07 +02:00
.B all
additionally prevents excluded messages from appearing in displayed
results, in effect behaving as though the excluded messages do not exist.
man: clarify search --exclude documentation Highlight "excluded messages" as a term with a meaning that may not be obvious. Be explicit about the effects of search --exclude=true and --exclude=false.
2013-05-11 21:50:05 +02:00
.B false
allows excluded messages to match search terms and appear in displayed
results. Excluded messages are still marked in the relevant outputs.
cli: move search to the new --exclude= naming scheme. This commit replaces the --no-exclude option with a --exclude=(true|false|flag) option. The default is to omit the excluded messages. The flag option only makes sense if output=summary (as otherwise there is nowhere to print the flag). In summary output exclude=false and exclude=flag give almost identical output: they differ in that with the exclude=flag option the match count (i.e., the x in [x/n] in the output) is the number of matching non-excluded messages rather than the number of matching messages. Note this changes the default for output=summary when no --exclude= option is given: it used to default to flag and now defaults to true (i.e. omit excluded messages). This is neccesary to keep the cli output uncluttered and for speed reasons.
2012-04-07 18:10:05 +02:00
.B flag
only has an effect when
man: clarify search --exclude=flag Improve the description of the search --exclude=flag option, using text taken from the commit that introduced the option.
2013-05-11 21:50:06 +02:00
.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.
cli: Add --no-exclude to the man pages for search and count
2012-03-01 23:30:34 +01:00
.RE
search: Support --format-version
2012-12-16 04:17:24 +01:00
.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.
man/*: fixup page references - Replace references to section X below with page refences. - Add SEE ALSO to each page. This is a bit error prone, because each SEE ALSO section is different, i.e. a page does not refer to itself.
2011-12-20 02:41:48 +01:00
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
man: reference notmuch-insert.1 Add references to notmuch-insert.1 from other man pages.
2013-06-23 06:23:58 +02:00
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
man: update SEE ALSO references in man pages Drop references to notmuch-part(1). Reference all man pages. Fix man page section of notmuch-dump(1).
2012-03-11 22:36:16 +01:00
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)
Reference in a new issue Copy permalink