diff options
author | Daniel Kahn Gillmor <dkg@fifthhorseman.net> | 2017-12-08 01:23:50 -0500 |
---|---|---|
committer | David Bremner <david@tethera.net> | 2017-12-08 08:05:53 -0400 |
commit | d3964e81ac98825a025a6120c488ebd73de2a281 (patch) | |
tree | a75286394e0ae529e6db68bb4fe964a55b27c9bd /doc/man1 | |
parent | de80ede3dfa88d50a3a4d34cedfcd71b8bde165b (diff) |
indexing: Change from try_decrypt to decrypt
the command-line interface for indexing (reindex, new, insert) used
--try-decrypt; and the configuration records used index.try_decrypt.
But by comparison with "show" and "reply", there doesn't seem to be
any reason for the "try" prefix.
This changeset adjusts the command-line interface and the
configuration interface.
For the moment, i've left indexopts_{set,get}_try_decrypt alone. The
subsequent changeset will address those.
Diffstat (limited to 'doc/man1')
-rw-r--r-- | doc/man1/notmuch-config.rst | 4 | ||||
-rw-r--r-- | doc/man1/notmuch-insert.rst | 6 | ||||
-rw-r--r-- | doc/man1/notmuch-new.rst | 6 | ||||
-rw-r--r-- | doc/man1/notmuch-reindex.rst | 6 |
4 files changed, 11 insertions, 11 deletions
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 6961737f..ea3d9754 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -138,7 +138,7 @@ The available configuration items are described below. Default: ``gpg``. - **index.try_decrypt** + **index.decrypt** **[STORED IN DATABASE]** When indexing an encrypted e-mail message, if this variable is @@ -146,7 +146,7 @@ The available configuration items are described below. the cleartext. 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 ``index.try_decrypt=true`` without considering the + DO NOT USE ``index.decrypt=true`` without considering the security of your index. Default: ``false``. diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index c500b251..eb9ff11b 100644 --- a/doc/man1/notmuch-insert.rst +++ b/doc/man1/notmuch-insert.rst @@ -51,7 +51,7 @@ Supported options for **insert** include ``--no-hooks`` Prevent hooks from being run. - ``--try-decrypt=(true|false)`` + ``--decrypt=(true|false)`` If true and the message is encrypted, try to decrypt the message while indexing. If decryption is successful, index @@ -60,10 +60,10 @@ Supported options for **insert** include 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 - ``--try-decrypt=true`` without considering the security of + ``--decrypt=true`` without considering the security of your index. - See also ``index.try_decrypt`` in **notmuch-config(1)**. + See also ``index.decrypt`` in **notmuch-config(1)**. EXIT STATUS =========== diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst index bc26aa48..1df86f06 100644 --- a/doc/man1/notmuch-new.rst +++ b/doc/man1/notmuch-new.rst @@ -43,17 +43,17 @@ Supported options for **new** include ``--quiet`` Do not print progress or results. - ``--try-decrypt=(true|false)`` + ``--decrypt=(true|false)`` If true, when encountering an encrypted message, try to decrypt it while indexing. If decryption is successful, index the cleartext itself. 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 ``--try-decrypt=true`` without + protected. DO NOT USE ``--decrypt=true`` without considering the security of your index. - See also ``index.try_decrypt`` in **notmuch-config(1)**. + See also ``index.decrypt`` in **notmuch-config(1)**. EXIT STATUS =========== diff --git a/doc/man1/notmuch-reindex.rst b/doc/man1/notmuch-reindex.rst index 21f6c7a9..782b0d7b 100644 --- a/doc/man1/notmuch-reindex.rst +++ b/doc/man1/notmuch-reindex.rst @@ -21,17 +21,17 @@ messages using the supplied options. Supported options for **reindex** include - ``--try-decrypt=(true|false)`` + ``--decrypt=(true|false)`` If true, when encountering an encrypted message, try to decrypt it while reindexing. If decryption is successful, index the cleartext itself. 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 ``--try-decrypt=true`` without + protected. DO NOT USE ``--decrypt=true`` without considering the security of your index. - See also ``index.try_decrypt`` in **notmuch-config(1)**. + See also ``index.decrypt`` in **notmuch-config(1)**. SEE ALSO ======== |