X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=95c61db09546576a6ff1499a8f3f209b021ba9d8;hp=1919176e79ca52aa64e3113bace55b7a5c671263;hb=3863e88e965f37e316de90978071c985fb4e5701;hpb=6dcb7592e32ed5140ea0c0357ce78d6a37af6066 diff --git a/notmuch.1 b/notmuch.1 index 1919176e..95c61db0 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -153,7 +153,7 @@ Presents the results in either JSON or plain-text (default). .RS 4 .TP 4 -.B \-\-output=(summary|threads|messages|tags) +.B \-\-output=(summary|threads|messages|files|tags) .RS 4 .TP 4 @@ -169,24 +169,31 @@ the authors of the thread and the subject. .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). +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). +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). +either one per line (\-\-format=text) or as a JSON array +(\-\-format=json). .RE .RE @@ -241,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 @@ -279,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 @@ -509,6 +526,8 @@ terms to match against specific portions of an email, (where thread: + folder: + The .B from: prefix is used to match the name or address of the sender of an email @@ -552,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