diff options
| author | Daniel Kahn Gillmor <dkg@fifthhorseman.net> | 2017-12-19 11:40:54 -0500 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2017-12-29 16:45:46 -0400 |
| commit | 8ea4a99d74737929f58568505e41c94f65a14743 (patch) | |
| tree | 883dcaa320dc97b3a9cba27d2f18f848965e57b8 /doc/man1 | |
| parent | 0ada2a05c94de72bc2c7c57a790e92b77af37a42 (diff) | |
cli/show: make --decrypt take a keyword.
We also expand tab completion for it, update the emacs bindings, and
update T350, T357, and T450 to match.
Make use of the bool-to-keyword backward-compatibility feature.
Diffstat (limited to 'doc/man1')
| -rw-r--r-- | doc/man1/notmuch-show.rst | 37 |
1 files changed, 21 insertions, 16 deletions
diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index 64caa7a6..7d2b38cb 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -115,22 +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. - - If a session key is already known for the message, then it - will be decrypted automatically unless the user explicitly - sets ``--decrypt=false``. - - Decryption expects a functioning **gpg-agent(1)** to provide any - needed credentials. Without one, the decryption will fail. - - Implies --verify. + ``--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. + + Note: ``true`` implies --verify. + + Default: ``auto`` ``--exclude=(true|false)`` Specify whether to omit threads only matching |