manpages updates for release 0.26

[notmuch-wiki] / manpages / notmuch-insert-1.mdwn

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn
index 329ebc2faafba5bd5a697f901286ca4a2c61fe58..bf44bdc4b4a1d9ae48eaa07110d6e7a553c186ff 100644 (file)
--- a/manpages/notmuch-insert-1.mdwn
+++ b/manpages/notmuch-insert-1.mdwn
@@ -32,40 +32,62 @@
        Option arguments must appear before any tag operation arguments.   Sup‐
        ported options for <b>insert</b> include
 
        Option arguments must appear before any tag operation arguments.   Sup‐
        ported options for <b>insert</b> include
 

-          <b>--folder=&lt;folder&gt;</b>
-                 Deliver  the message to the specified folder, relative to the
-                 top-level directory given by the value of <b>database.path</b>.  The
-                 default is to deliver to the top-level directory.
-
-          <b>--create-folder</b>
-                 Try  to create the folder named by the <b>--folder</b> option, if it
-                 does not exist. Otherwise the folder must already  exist  for
-                 mail delivery to succeed.
-
-          <b>--keep</b> Keep the message file if indexing fails, and keep the message
-                 indexed if applying  tags  or  maildir  flag  synchronization
-                 fails.  Ignore these errors and return exit status 0 to indi‐
-                 cate successful mail delivery.
-
-          <b>--no-hooks</b>
-                 Prevent hooks from being run.
+       <b>--folder=&lt;</b>folder<b>&gt;</b>
+              Deliver  the  message  to  the specified folder, relative to the
+              top-level directory given by the  value  of  <b>database.path</b>.  The
+              default  is  the  empty  string,  which  means delivering to the
+              top-level directory.
+
+       <b>--create-folder</b>
+              Try to create the folder named by the  <b>--folder</b>  option,  if  it
+              does not exist. Otherwise the folder must already exist for mail
+              delivery to succeed.
+
+       <b>--keep</b> Keep the message file if indexing fails, and  keep  the  message
+              indexed  if applying tags or maildir flag synchronization fails.
+              Ignore these errors and return exit status 0  to  indicate  suc‐
+              cessful mail delivery.
+
+       <b>--no-hooks</b>
+              Prevent hooks from being run.
+
+       <b>--decrypt=(true|nostash|auto|false)</b>
+              If <b>true</b> and the message is encrypted, try to decrypt the message
+              while indexing, stashing any session keys discovered.  If  <b>auto</b>,
+              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&apos;s secret keys.  If decryption is successful,
+              index the cleartext itself.  Either way, the message  is  always
+              stored to disk in its original form (ciphertext).
+
+              <b>nostash</b>  is  the  same  as  <b>true</b>  except  that it will not stash
+              newly-discovered session keys in the database.
+
+              Be aware that the index is likely sufficient (and a stashed ses‐
+              sion  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 <b>--decrypt=true</b> or
+              <b>--decrypt=nostash</b>  without  considering  the  security  of  your
+              index.
+
+              See also <b>index.decrypt</b> in <a href='../notmuch-config-1/'>notmuch-config</a>(1).

 </pre>
 
 <h2>EXIT STATUS</h2>
 <pre>
 </pre>
 
 <h2>EXIT STATUS</h2>
 <pre>

-       This command  returns  exit  status  0  on  successful  mail  delivery,
-       non-zero  otherwise. The default is to indicate failed mail delivery on
-       any errors, including message file delivery to the filesystem,  message
-       indexing  to Notmuch database, changing tags, and synchronizing tags to
-       maildir flags. The <b>--keep</b> option may be used to settle  for  successful
+       This  command  returns  exit  status  0  on  successful  mail delivery,
+       non-zero otherwise. The default is to indicate failed mail delivery  on
+       any  errors, including message file delivery to the filesystem, message
+       indexing to Notmuch database, changing tags, and synchronizing tags  to
+       maildir  flags.  The <b>--keep</b> option may be used to settle for successful

        message file delivery.
 
        This command supports the following special exit status code for errors
        message file delivery.
 
        This command supports the following special exit status code for errors

-       most likely to be temporary in nature, e.g. failure to get  a  database
+       most  likely  to be temporary in nature, e.g. failure to get a database

        write lock.
 
        <b>75</b> <b>(EX</b>_<b>TEMPFAIL)</b>
        write lock.
 
        <b>75</b> <b>(EX</b>_<b>TEMPFAIL)</b>

-              A temporary failure occured; the user is invited to retry.
+              A temporary failure occurred; the user is invited to retry.

 
        The exit status of the <b>post-insert</b> hook does not affect the exit status
        of the <b>insert</b> command.
 
        The exit status of the <b>post-insert</b> hook does not affect the exit status
        of the <b>insert</b> command.


@@ -73,7 +95,7 @@
 
 <h2>SEE ALSO</h2>
 <pre>
 
 <h2>SEE ALSO</h2>
 <pre>

-       <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not‐</a>
+       <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not‐</a>

        <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1),
        <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 </pre>
        <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1),
        <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 </pre>


@@ -85,7 +107,7 @@
 
 <h2>COPYRIGHT</h2>
 <pre>
 
 <h2>COPYRIGHT</h2>
 <pre>

-       2009-2017, Carl Worth and many others
+       2009-2018, Carl Worth and many others

 </pre>
 
 </pre>
 

-<h2>0.24</h2>
+<h2>0.26</h2>