Update news & manpages to notmuch version 0.16

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

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn
new file mode 100644 (file)
index 0000000..8ccfda1
--- /dev/null
+++ b/manpages/notmuch-insert-1.mdwn
@@ -0,0 +1,63 @@
+<h1>NOTMUCH-INSERT(1)</h1>
+
+<h2>NAME</h2>
+<pre>
+       notmuch-insert - add a message to the maildir and notmuch database
+</pre>
+
+<h2>SYNOPSIS</h2>
+<pre>
+       <b>notmuch</b> <b>insert</b> [<u>options</u>] [ +&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-
+       tive to using a separate tool to deliver the message then running  <b>not-</b>
+       <b>much</b> <b>new</b> afterwards.
+
+       The  new message will be tagged with the tags specified by the <b>new.tags</b>
+       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-
+       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-
+       ported options for <b>insert</b> include
+
+           <b>--folder=</b>&lt<b>&</b>lt;<u>folder</u>&gt<b>&</b>gt;
+
+               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.
+</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.
+
+       If the message could not be written to disk then a non-zero exit status
+       is returned.
+</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-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>