X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-new.rst;fp=doc%2Fman1%2Fnotmuch-new.rst;h=9cb4a54e75343733e3dfd6fa3ed8e00ad235f5dc;hp=1044d1cdd0f5c0ce3fb09b087cae61262bd080ad;hb=f2e2f2aa96cb0d40c6fb85cde2ab82380c367485;hpb=574b2436eeabf60c930ba227931ee87b0b151a65 diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst index 1044d1cd..9cb4a54e 100644 --- a/doc/man1/notmuch-new.rst +++ b/doc/man1/notmuch-new.rst @@ -40,36 +40,43 @@ details on hooks. Supported options for **new** include -``--no-hooks`` - Prevents hooks from being run. - -``--quiet`` - Do not print progress or results. - -``--verbose`` - Print file names being processed. Ignored when combined with - ``--quiet``. - -``--decrypt=(true|nostash|auto|false)`` - If ``true``, when encountering an encrypted message, try to - decrypt it while indexing, and stash any discovered session keys. - 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. - If decryption is successful, index the cleartext of the message. - - Be aware that the index is likely sufficient (and the session key - is certainly 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`` or - ``--decrypt=nostash`` without considering the security of your - index. - - See also ``index.decrypt`` in :any:`notmuch-config(1)`. - -``--full-scan`` - By default notmuch-new uses directory modification times (mtimes) - to optimize the scanning of directories for new mail. This option turns - that optimization off. +.. program:: new + +.. option:: --no-hooks + + Prevents hooks from being run. + +.. option:: --quiet + + Do not print progress or results. + +.. option:: --verbose + + Print file names being processed. Ignored when combined with + ``--quiet``. + +.. option:: --decrypt=(true|nostash|auto|false) + + If ``true``, when encountering an encrypted message, try to + decrypt it while indexing, and stash any discovered session keys. + 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. + If decryption is successful, index the cleartext of the message. + + Be aware that the index is likely sufficient (and the session key + is certainly 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`` or + ``--decrypt=nostash`` without considering the security of your + index. + + See also ``index.decrypt`` in :any:`notmuch-config(1)`. + +.. option:: --full-scan + + By default notmuch-new uses directory modification times (mtimes) + to optimize the scanning of directories for new mail. This option turns + that optimization off. EXIT STATUS ===========