X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=notmuch.1;h=3ec9c55c0d453fa0a2e97ab175cbeb0ec8221feb;hb=4bb1b1603c416c167459203fd2bd0fe94518bacb;hp=96fd2429d4945cf33416050731c796db704ab03b;hpb=74168777cba27ad0e217399de4332ad576bd9398;p=notmuch diff --git a/notmuch.1 b/notmuch.1 index 96fd2429..3ec9c55c 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -126,7 +126,7 @@ syntax. See the section below for more details on the supported syntax. The -.BR search " and "show +.BR search ", " show " and " count commands are used to query the email database. .RS 4 .TP 4 @@ -201,13 +201,13 @@ matched message will be displayed. .RS 4 .TP 4 -.B \-\-format=(json|text) +.B \-\-format=(text|json|mbox) .RS 4 .TP 4 .B text -The default plain-text format has text-content MIME parts +The default plain-text format has all text-content MIME parts decoded. Various components in the output, .RB ( message ", " header ", " body ", " attachment ", and MIME " part ), will be delimited by easily-parsed markers. Each marker consists of a @@ -220,12 +220,27 @@ or close the component. .TP 4 .B json -Format output as Javascript Object Notation (JSON). JSON output always -includes all messages in a matching thread; in effect +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 .B \-\-format=json implies .B \-\-entire\-thread +.RE +.RS 4 +.TP 4 +.B mbox + +All matching messages are output in the traditional, Unix mbox format +with each message being prefixed by a line beginning with "From " and +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: +http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html + .RE A common use of .B notmuch show @@ -239,6 +254,16 @@ See the .B "SEARCH SYNTAX" section below for details of the supported syntax for . .RE +.TP +.BR count " ..." + +Count messages matching the search terms. + +The number of matching messages is output to stdout. + +With no search terms, a count of all messages in the database will be +displayed. +.RE .RE The