aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>2017-12-08 01:23:56 -0500
committerDavid Bremner <david@tethera.net>2017-12-08 08:08:46 -0400
commitf845fb2a51f87dfa60388d65ac481ba21556bb78 (patch)
tree806e11ce94b792fb370f01695beeb9daba8613b9 /doc
parenta1260896f6b2beb82f46c41663f00cb42a4c5ce7 (diff)
cli/show, reply: document use of stashed session keys in notmuch-properties
The stashed session keys are stored internally as notmuch properties. So a user or developer who is reading about those properties might want to understand how they fit into the bigger picture. Note here that decrypting with a stored session key no longer needs -decrypt for "notmuch show" and "notmuch reply".
Diffstat (limited to 'doc')
-rw-r--r--doc/man7/notmuch-properties.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/man7/notmuch-properties.rst b/doc/man7/notmuch-properties.rst
index 05444f6c..1a3f690e 100644
--- a/doc/man7/notmuch-properties.rst
+++ b/doc/man7/notmuch-properties.rst
@@ -77,9 +77,12 @@ of its normal activity.
**session-key**
When **notmuch-show(1)** or **nomtuch-reply** encounters a message
- with an encrypted part and ``--decrypt`` is set, if notmuch finds a
- ``session-key`` property associated with the message, it will try
- that stashed session key for decryption.
+ with an encrypted part, if notmuch finds a ``session-key``
+ property associated with the message, it will try that stashed
+ session key for decryption.
+
+ If you do not want to use any stashed session keys that might be
+ present, you should pass those programs ``--decrypt=false``.
Using a stashed session key with "notmuch show" will speed up
rendering of long encrypted threads. It also allows the user to