diff options
| author |  Carl Worth <cworth@cworth.org> | 2010-11-06 12:03:51 -0700 |
|---|---|---|
| committer | Carl Worth <cworth@cworth.org> | 2010-11-06 12:03:51 -0700 |
| commit | 81d3bd3670f570c9aeb7e1f3b317b86194ee4426 (patch) | |
| tree | 0a0149bffd49998c2325bf5d33e1f0842e488483 /notmuch.1 | |
| parent | 581ea7c8d39c9de73282b21de16dd9b0192ec5ac (diff) | |
Rename "notmuch cat" to "notmuch show --format=raw"
This is part of an effort to avoid proliferation of excessive
top-level notmuch commands. Also, "raw" better captures the
functionality here, (as opposed to "cat" which is a fairly oblique
reference to a bad Unix abbreviation whose metaphor doesn't work here
since "notmuch cat" operates only on a single message and hence cannot
"con'cat'enate" anything).
Diffstat (limited to 'notmuch.1')
| -rw-r--r-- | notmuch.1 | 16 |
1 files changed, 11 insertions, 5 deletions
@@ -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 @@ -287,6 +287,16 @@ 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 is to display a single thread of email messages. For this, use a @@ -300,10 +310,6 @@ See the section below for details of the supported syntax for <search-terms>. .RE .TP -.BR cat " <search-term>..." - -Output raw content of a single message matched by the search term. -.TP .BR count " <search-term>..." Count messages matching the search terms. |