Add documentation for the recently added folder-based searching.

[notmuch] / notmuch.1

diff --git a/notmuch.1 b/notmuch.1
index f803f908f1a447f104de11ade9c3058c657a2203..95c61db09546576a6ff1499a8f3f209b021ba9d8 100644 (file)
--- a/notmuch.1
+++ b/notmuch.1
@@ -150,6 +150,53 @@ include
 
 Presents the results in either JSON or plain-text (default).
 .RE
 
 Presents the results in either JSON or plain-text (default).
 .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) or as a JSON array
+(\-\-format=json).
+.RE
+.RS 4
+.TP 4
+.B messages
+
+Output the message IDs of all messages matching the search terms,
+either one per line (\-\-format=text) or as a JSON array
+(\-\-format=json).
+.RE
+.RS 4
+.TP 4
+.B files
+
+Output the filenames of all messages matching the search terms, either
+one per line (\-\-format=text) or as a JSON array (\-\-format=json).
+.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) or as a JSON array
+(\-\-format=json).
+.RE
+.RE
+

 .RS 4
 .TP 4
 .BR \-\-sort= ( newest\-first | oldest\-first )
 .RS 4
 .TP 4
 .BR \-\-sort= ( newest\-first | oldest\-first )


@@ -201,7 +248,7 @@ matched message will be displayed.
 
 .RS 4
 .TP 4
 
 .RS 4
 .TP 4

-.B \-\-format=(text|json|mbox)
+.B \-\-format=(text|json|mbox|raw)

 
 .RS 4
 .TP 4
 
 .RS 4
 .TP 4


@@ -214,7 +261,6 @@ 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.
 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.

-

 .RE
 .RS 4
 .TP 4
 .RE
 .RS 4
 .TP 4


@@ -240,6 +286,15 @@ 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:
 http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
 an additional '>' character added. This reversible escaping
 is termed "mboxrd" format and described in detail here:
 http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html

+.RE
+.RS 4
+.TP 4
+.B raw
+
+The original, raw content of the email message is displayed.
+Consumers of this format should expect to implement MIME decoding and
+similar functions. This format must only be used with search terms
+matching a single message.

 
 .RE
 A common use of
 
 .RE
 A common use of


@@ -471,6 +526,8 @@ terms to match against specific portions of an email, (where
 
        thread:<thread-id>
 
 
        thread:<thread-id>
 

+       folder:<directory-path>
+

 The
 .B from:
 prefix is used to match the name or address of the sender of an email
 The
 .B from:
 prefix is used to match the name or address of the sender of an email


@@ -514,6 +571,13 @@ 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"
 
 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. Only
+the directory components below the top-level mail database path are
+available to be searched.
+

 In addition to individual terms, multiple terms can be
 combined with Boolean operators (
 .BR and ", " or ", " not
 In addition to individual terms, multiple terms can be
 combined with Boolean operators (
 .BR and ", " or ", " not