X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=c1aa4e329c43f0e377539b6ed454b95c1555b2ea;hp=95c61db09546576a6ff1499a8f3f209b021ba9d8;hb=59a9c36316293b161528097a73c72d5f5ed58781;hpb=3863e88e965f37e316de90978071c985fb4e5701 diff --git a/notmuch.1 b/notmuch.1 index 95c61db0..c1aa4e32 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 @@ -285,18 +287,62 @@ a blank line separating each message. Lines in the message content 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: + +.nf +.nh http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html +.hy +.fi +. .RE .RS 4 .TP 4 -.B raw +.BR raw " (default for a single part, see \-\-part)" + +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 -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. +.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 + +.RS 4 +.TP 4 +.B \-\-verify + +Compute and report the validity of any MIME cryptographic signatures +found in the selected content (ie. "multipart/signed" parts). Status +of the signature will be reported (currently only supported with +--format=json), and the multipart/signed part will be replaced by the +signed data. +.RE + +.RS 4 +.TP 4 +.B \-\-decrypt + +Decrypt any MIME encrypted parts found in the selected content +(ie. "multipart/encrypted" parts). Status of the decryption will be +reported (currently only supported with --format=json) and the +multipart/encrypted part will be replaced by the decrypted +content. +.RE + A common use of .B notmuch show is to display a single thread of email messages. For this, use a @@ -309,7 +355,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.