X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=2912fcfda67d456ba5002d9cbfdf1ccf8150b2e6;hp=e4eed60fc95e5f828f940b4efda1a094f34c3180;hb=362ab047c264ae67ec3de041aec637979077db21;hpb=1cb28764d86e5e0c98bdd49140568e523571a5a2 diff --git a/notmuch.1 b/notmuch.1 index e4eed60f..2912fcfd 100644 --- 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 @@ -260,7 +260,8 @@ decoded. Various components in the output, 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. +or close the component. For a multipart MIME message, these parts will +be nested. .RE .RS 4 .TP 4 @@ -268,8 +269,9 @@ or close the component. The output is formatted with Javascript Object Notation (JSON). This format is more robust than the text format for automated -processing. JSON output always includes all messages in a matching -thread; in effect +processing. The nested structure of multipart MIME messages is +reflected in nested JSON output. JSON output always includes all +messages in a matching thread; in effect .B \-\-format=json implies .B \-\-entire\-thread @@ -286,6 +288,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 @@ -516,6 +528,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 @@ -559,6 +573,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