Add documentation for the recently added folder-based searching.

[notmuch] / notmuch.1

diff --git a/notmuch.1 b/notmuch.1
index 853b5eafab31cac83959e074713174f528d6475a..95c61db09546576a6ff1499a8f3f209b021ba9d8 100644 (file)
--- a/notmuch.1
+++ b/notmuch.1
@@ -248,7 +248,7 @@ matched message will be displayed.
 
 .RS 4
 .TP 4
-.B \-\-format=(text|json|mbox)
+.B \-\-format=(text|json|mbox|raw)
 
 .RS 4
 .TP 4
@@ -286,6 +286,16 @@ 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
+.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
 .B notmuch show
@@ -300,10 +310,6 @@ See the
 section below for details of the supported syntax for <search-terms>.
 .RE
 .TP
-.BR cat  " <search-term>..."
-
-Output raw content of a single message matched by the search term.
-.TP
 .BR count " <search-term>..."
 
 Count messages matching the search terms.
@@ -520,6 +526,8 @@ terms to match against specific portions of an email, (where
 
        thread:<thread-id>
 
+       folder:<directory-path>
+
 The
 .B from:
 prefix is used to match the name or address of the sender of an email
@@ -563,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"
 
+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