debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-24 20:08:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

cli/new, insert, reindex: update documentation for --decrypt=auto

Browse source 
we also include --decrypt=auto in the tab completion.
This commit is contained in:
Daniel Kahn Gillmor 2017-12-08 01:23:57 -05:00 committed by David Bremner
parent f845fb2a51
commit 181d4091c4
4 changed files with 33 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
completion/notmuch-completion.bash
View file

@ -288,7 +288,7 @@ _notmuch_insert()
return return
;; ;;
--decrypt) --decrypt)
COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) ) COMPREPLY=( $( compgen -W "true false auto" -- "${cur}" ) )
return return
;; ;;
esac esac
@ -320,7 +320,7 @@ _notmuch_new()
$split && $split &&
case "${prev}" in case "${prev}" in
--decrypt) --decrypt)
COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) ) COMPREPLY=( $( compgen -W "true false auto" -- "${cur}" ) )
return return
;; ;;
esac esac
@ -442,7 +442,7 @@ _notmuch_reindex()
$split && $split &&
case "${prev}" in case "${prev}" in
--decrypt) --decrypt)
COMPREPLY=( $( compgen -W "true false" -- "${cur}" ) ) COMPREPLY=( $( compgen -W "true false auto" -- "${cur}" ) )
return return
;; ;;
esac esac

16
doc/man1/notmuch-insert.rst
View file

@ -51,14 +51,18 @@ Supported options for **insert** include
``--no-hooks`` ``--no-hooks``
Prevent hooks from being run. Prevent hooks from being run.
``--decrypt=(true|false)`` ``--decrypt=(true|auto|false)``
If true and the message is encrypted, try to decrypt the If ``true`` and the message is encrypted, try to decrypt the
message while indexing. If decryption is successful, index message while indexing. If ``auto``, and notmuch already
knows about a session key for the message, it will try
decrypting using that session key but will not try to access
the user's secret keys. If decryption is successful, index
the cleartext itself. Either way, the message is always the cleartext itself. Either way, the message is always
stored to disk in its original form (ciphertext). Be aware stored to disk in its original form (ciphertext).
that the index is likely sufficient to reconstruct the
cleartext of the message itself, so please ensure that the Be aware that the index is likely sufficient to reconstruct
the cleartext of the message itself, so please ensure that the
notmuch message index is adequately protected. DO NOT USE notmuch message index is adequately protected. DO NOT USE
``--decrypt=true`` without considering the security of ``--decrypt=true`` without considering the security of
your index. your index.

10
doc/man1/notmuch-new.rst
View file

@ -43,11 +43,15 @@ Supported options for **new** include
``--quiet`` ``--quiet``
Do not print progress or results. Do not print progress or results.
``--decrypt=(true|false)`` ``--decrypt=(true|auto|false)``
If true, when encountering an encrypted message, try to If ``true``, when encountering an encrypted message, try to
decrypt it while indexing. If decryption is successful, index decrypt it while indexing. If decryption is successful, index
the cleartext itself. Be aware that the index is likely the cleartext itself. If ``auto``, try to use any session key
already known to belong to this message, but do not attempt to
use the user's secret keys.
Be aware that the index is likely
sufficient to reconstruct the cleartext of the message itself, sufficient to reconstruct the cleartext of the message itself,
so please ensure that the notmuch message index is adequately so please ensure that the notmuch message index is adequately
protected. DO NOT USE ``--decrypt=true`` without protected. DO NOT USE ``--decrypt=true`` without

21
doc/man1/notmuch-reindex.rst
View file

@ -21,15 +21,20 @@ messages using the supplied options.
Supported options for **reindex** include Supported options for **reindex** include
``--decrypt=(true|false)`` ``--decrypt=(true|auto|false)``
If true, when encountering an encrypted message, try to If ``true``, when encountering an encrypted message, try to
decrypt it while reindexing. If decryption is successful, decrypt it while reindexing. If ``auto``, and notmuch already
index the cleartext itself. Be aware that the index is likely knows about a session key for the message, it will try
sufficient to reconstruct the cleartext of the message itself, decrypting using that session key but will not try to access
so please ensure that the notmuch message index is adequately the user's secret keys. If decryption is successful, index
protected. DO NOT USE ``--decrypt=true`` without the cleartext itself.
considering the security of your index.
Be aware that the index is likely sufficient to reconstruct
the cleartext of the message itself, so please ensure that the
notmuch message index is adequately protected. DO NOT USE
``--decrypt=true`` without considering the security of your
index.
See also ``index.decrypt`` in **notmuch-config(1)**. See also ``index.decrypt`` in **notmuch-config(1)**.