manpages updates for release 0.29

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

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn
index 329ebc2faafba5bd5a697f901286ca4a2c61fe58..85695d78f47e14f3278814af35f29db32b0c066c 100644 (file)
--- a/manpages/notmuch-insert-1.mdwn
+++ b/manpages/notmuch-insert-1.mdwn
@@ -32,23 +32,51 @@
        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>--world-readable</b>
+              When  writing  mail to the mailbox, allow it to be read by users
+              other than the current user.  Note that this does  not  override
+              umask.   By default, delivered mail is only readable by the cur‐
+              rent user.
+
+       <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>
@@ -65,7 +93,7 @@
        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.
@@ -85,7 +113,7 @@
 
 <h2>COPYRIGHT</h2>
 <pre>
-       2009-2017, Carl Worth and many others
+       2009-2019, Carl Worth and many others
 </pre>
 
-<h2>0.24</h2>
+<h2>0.29</h2>