X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-show.rst;h=7d2b38cbb97eb3c1dc1c61282330af75da5123c6;hb=8ea4a99d74737929f58568505e41c94f65a14743;hp=c4518ec821e62c5bd1e2072cbc687eb093b55756;hpb=56871c628bea5a86feea5b2bc704661bbe02cccc;p=notmuch diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index c4518ec8..7d2b38cb 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -50,20 +50,19 @@ Supported options for **show** include messages is reflected in nested JSON output. By default JSON output includes all messages in a matching thread; that is, by default, - - ``--format=json`` sets ``--entire-thread`` The caller can - disable this behaviour by setting ``--entire-thread=false`` + ``--format=json`` sets ``--entire-thread``. The caller can + disable this behaviour by setting ``--entire-thread=false``. + The JSON output is always encoded as UTF-8 and any message + content included in the output will be charset-converted to + UTF-8. **sexp** - The output is formatted as an S-Expression (sexp). This - format is more robust than the text format for automated - processing. The nested structure of multipart MIME messages - is reflected in nested S-Expression output. By default, - S-Expression output includes all messages in a matching - thread; that is, by default, - - ``--format=sexp`` sets ``--entire-thread`` The caller can - disable this behaviour by setting ``--entire-thread=false`` + The output is formatted as the Lisp s-expression (sexp) + equivalent of the JSON format above. Objects are formatted + as property lists whose keys are keywords (symbols preceded + by a colon). True is formatted as ``t`` and both false and + null are formatted as ``nil``. As for JSON, the s-expression + output is always encoded as UTF-8. **mbox** All matching messages are output in the traditional, Unix @@ -74,7 +73,7 @@ Supported options for **show** include '>' 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 + http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html **raw** (default if --part is given) Write the raw bytes of the given MIME part of a message to @@ -116,18 +115,27 @@ Supported options for **show** include supported with --format=json and --format=sexp), and the multipart/signed part will be replaced by the signed data. - ``--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 - --format=sexp) and on successful decryption the - multipart/encrypted part will be replaced by the decrypted - content. + ``--decrypt=(false|auto|true)`` + If ``true``, decrypt any MIME encrypted parts found in the + selected content (i.e. "multipart/encrypted" parts). Status of + the decryption will be reported (currently only supported + with --format=json and --format=sexp) and on successful + decryption the multipart/encrypted part will be replaced by + the decrypted content. + + If ``auto``, and a session key is already known for the + message, then it will be decrypted, but notmuch will not try + to access the user's keys. + + Use ``false`` to avoid even automatic decryption. + + Non-automatic decryption expects a functioning + **gpg-agent(1)** to provide any needed credentials. Without + one, the decryption will fail. - Decryption expects a functioning **gpg-agent(1)** to provide any - needed credentials. Without one, the decryption will fail. + Note: ``true`` implies --verify. - Implies --verify. + Default: ``auto`` ``--exclude=(true|false)`` Specify whether to omit threads only matching @@ -177,7 +185,15 @@ This command supports the following special exit status codes SEE ALSO ======== -**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**, -**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**, -**notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**, -**notmuch-search(1)**, **notmuch-search-terms(7)**, **notmuch-tag(1)** +**notmuch(1)**, +**notmuch-config(1)**, +**notmuch-count(1)**, +**notmuch-dump(1)**, +**notmuch-hooks(5)**, +**notmuch-insert(1)**, +**notmuch-new(1)**, +**notmuch-reply(1)**, +**notmuch-restore(1)**, +**notmuch-search(1)**, +**notmuch-search-terms(7)**, +**notmuch-tag(1)**