X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=82b48c3b942758790017cf4a1e2cf957d637a7f4;hp=95c61db09546576a6ff1499a8f3f209b021ba9d8;hb=916c2aa6247c6ef3d2a9c9c784cf4d3a5de263d0;hpb=3863e88e965f37e316de90978071c985fb4e5701 diff --git a/notmuch.1 b/notmuch.1 index 95c61db0..82b48c3b 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -252,7 +252,7 @@ matched message will be displayed. .RS 4 .TP 4 -.B text +.BR text " (default for messages)" The default plain-text format has all text-content MIME parts decoded. Various components in the output, @@ -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 @@ -289,14 +291,31 @@ http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html .RE .RS 4 .TP 4 -.B raw +.BR raw " (default for a single part, see \-\-part)" -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. +For a message, the original, raw content of the email message is +output. Consumers of this format should expect to implement MIME +decoding and similar functions. +For a single part (\-\-part) the raw part content is output after +performing any necessary MIME decoding. + +The raw format must only be used with search terms matching single +message. +.RE +.RE + +.RS 4 +.TP 4 +.B \-\-part=N + +Output the single decoded MIME part N of a single message. The search +terms must match only a single message. Message parts are numbered in +a depth-first walk of the message MIME structure, and are identified +in the 'json' or +'text' output formats. .RE + A common use of .B notmuch show is to display a single thread of email messages. For this, use a @@ -309,7 +328,8 @@ See the .B "SEARCH SYNTAX" section below for details of the supported syntax for . .RE -.TP +.RS 4 +.TP 4 .BR count " ..." Count messages matching the search terms.