diff options
author | David Bremner <david@tethera.net> | 2017-12-31 09:26:13 -0400 |
---|---|---|
committer | David Bremner <david@tethera.net> | 2017-12-31 09:26:13 -0400 |
commit | 99407db25cbd44f915fb33708c497bc375ff63de (patch) | |
tree | 2b357c6cb01ac5ec9ce2e262077184c9f7a7b075 /doc/man1 | |
parent | e5e252de5560fee386bd46f8f279c800b953c667 (diff) | |
parent | eff029de4a8782ccfe20e26814c740a271cb5285 (diff) |
Merge branch 'release'
Conflicts:
doc/man1/notmuch-reply.rst
doc/man1/notmuch-show.rst
Conflicts taken from release (dkg's doc changes)
Diffstat (limited to 'doc/man1')
-rw-r--r-- | doc/man1/notmuch-reply.rst | 34 | ||||
-rw-r--r-- | doc/man1/notmuch-show.rst | 37 |
2 files changed, 41 insertions, 30 deletions
diff --git a/doc/man1/notmuch-reply.rst b/doc/man1/notmuch-reply.rst index 4c86a92f..b0169834 100644 --- a/doc/man1/notmuch-reply.rst +++ b/doc/man1/notmuch-reply.rst @@ -70,20 +70,26 @@ Supported options for **reply** include order, and copy values from the first that contains something other than only the user's addresses. -``--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 likely fail. + ``--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 secret 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 likely fail. + + Default: ``auto`` See **notmuch-search-terms(7)** for details of the supported syntax for <search-terms>. diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index 3bc8d17b..ad72a740 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -110,22 +110,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 search.tag\_exclude |