0.20.1 manpages update

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

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn
index 8ccfda193c2cf576b93d398b383ef887d8d19f2d..dbbd46598354dea5319bb8ff83532e97d5ae9ee3 100644 (file)
--- a/manpages/notmuch-insert-1.mdwn
+++ b/manpages/notmuch-insert-1.mdwn
@@ -7,14 +7,14 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>insert</b> [<u>options</u>] [ +&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; ... ]
+       <b>notmuch</b> <b>insert</b> [option ...] [+&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; ...]
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>
        <b>notmuch</b> <b>insert</b> reads a message from standard input and delivers it into
        the maildir directory given by configuration option <b>database.path</b>, then
-       incorporates  the message into the notmuch database.  It is an alterna-
+       incorporates  the  message into the notmuch database. It is an alterna‐
        tive to using a separate tool to deliver the message then running  <b>not-</b>
        <b>much</b> <b>new</b> afterwards.
 
@@ -22,42 +22,63 @@
        configuration option, then by operations specified on the command-line:
        tags prefixed by &apos;+&apos; are added while those prefixed by &apos;-&apos; are removed.
 
-       If  the  new message is a duplicate of an existing message in the data-
+       If  the  new message is a duplicate of an existing message in the data‐
        base (it has same Message-ID), it will be added to the  maildir  folder
        and notmuch database, but the tags will not be changed.
 
-       Option  arguments must appear before any tag operation arguments.  Sup-
+       The  <b>insert</b>  command  supports  hooks.  See  <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5)  for more
+       details on hooks.
+
+       Option arguments must appear before any tag operation arguments.   Sup‐
        ported options for <b>insert</b> include
 
-           <b>--folder=</b>&lt<b>&</b>lt;<u>folder</u>&gt<b>&</b>gt;
+          <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.
 
-               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>--create-folder</b>
+          <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 succesful mail delivery.
 
-               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>--no-hooks</b>
+                 Prevent hooks from being run.
 </pre>
 
 <h2>EXIT STATUS</h2>
 <pre>
-       This command returns exit status 0  if  the  message  was  successfully
-       added  to  the mail directory, even if the message could not be indexed
-       and added to the notmuch database.  In the latter case, a warning  will
-       be printed to standard error but the message file will be left on disk.
+       This command returns exit status 0 on succesful 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.
 
-       If the message could not be written to disk then a non-zero exit status
-       is returned.
+       The exit status of the <b>post-insert</b> hook does not affect the exit status
+       of the <b>insert</b> command.
 </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>
 
-<h2>Notmuch 0.16</h2>
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
+</pre>
+
+<h2>0.20.1</h2>