[PATCH v7 04/12] man: document 'insert' command
authorPeter Wang <novalazy@gmail.com>
Sun, 23 Jun 2013 04:23:57 +0000 (14:23 +1000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:55:39 +0000 (09:55 -0800)
a3/7f66dc56c560ceb08fac87d86299ed79721fef [new file with mode: 0644]

diff --git a/a3/7f66dc56c560ceb08fac87d86299ed79721fef b/a3/7f66dc56c560ceb08fac87d86299ed79721fef
new file mode 100644 (file)
index 0000000..8d00341
--- /dev/null
@@ -0,0 +1,139 @@
+Return-Path: <novalazy@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id EB3F1431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 22 Jun 2013 21:24:31 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id MzajXNN1hU8o for <notmuch@notmuchmail.org>;\r
+       Sat, 22 Jun 2013 21:24:25 -0700 (PDT)\r
+Received: from mail-pa0-f46.google.com (mail-pa0-f46.google.com\r
+       [209.85.220.46]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 0EE0E431FC9\r
+       for <notmuch@notmuchmail.org>; Sat, 22 Jun 2013 21:24:17 -0700 (PDT)\r
+Received: by mail-pa0-f46.google.com with SMTP id fa11so9507454pad.5\r
+       for <notmuch@notmuchmail.org>; Sat, 22 Jun 2013 21:24:16 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=M4rFtmIU9Qt5j82bY8pOtu+2vtZbM6VTXeS4OZ7zcDU=;\r
+       b=CnM4yhNLYKISOs2NYK1YGwqthWJF1s7sTk3EUejrSpFyPyfA73WYvcAGdjcLHGikJ5\r
+       YWwDgM2pAHfpikn6bbvw5HeUEapcewgLGKiNYNkO6T/mIec+eDq5NxtnE7MYTUVnSHHI\r
+       Gbhhd9NWBnW2CbOnyeusy5UC4cFvvvxD6EjhPT50alC7p1alm96yHGR57chsmiLLjydd\r
+       IHjIQaP8CC6IY9ozRdVSDJSE/dpxc6Qb5L7rlq2NdlSrdibNUXL3Vl6stNfkUKYxdnGN\r
+       6tdxrDMmc4DmRKdzGvcGVA/Inzzy8FxNNwXtz/eihLhgUmgbLiFVSmhPUVXUXNEMevD4\r
+       ALFA==\r
+X-Received: by 10.68.40.170 with SMTP id y10mr2745480pbk.155.1371961455979;\r
+       Sat, 22 Jun 2013 21:24:15 -0700 (PDT)\r
+Received: from localhost (215.42.233.220.static.exetel.com.au.\r
+       [220.233.42.215]) by mx.google.com with ESMTPSA id\r
+       fr1sm11847382pbb.26.2013.06.22.21.24.13 for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 22 Jun 2013 21:24:15 -0700 (PDT)\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v7 04/12] man: document 'insert' command\r
+Date: Sun, 23 Jun 2013 14:23:57 +1000\r
+Message-Id: <1371961445-15182-5-git-send-email-novalazy@gmail.com>\r
+X-Mailer: git-send-email 1.7.12.1\r
+In-Reply-To: <1371961445-15182-1-git-send-email-novalazy@gmail.com>\r
+References: <1371961445-15182-1-git-send-email-novalazy@gmail.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 23 Jun 2013 04:24:32 -0000\r
+\r
+Add initial documentation for notmuch insert command.\r
+---\r
+ man/Makefile.local        |  1 +\r
+ man/man1/notmuch-insert.1 | 49 +++++++++++++++++++++++++++++++++++++++++++++++\r
+ 2 files changed, 50 insertions(+)\r
+ create mode 100644 man/man1/notmuch-insert.1\r
+\r
+diff --git a/man/Makefile.local b/man/Makefile.local\r
+index 72e2a18..216aaa0 100644\r
+--- a/man/Makefile.local\r
++++ b/man/Makefile.local\r
+@@ -12,6 +12,7 @@ MAN1 := \\r
+       $(dir)/man1/notmuch-count.1 \\r
+       $(dir)/man1/notmuch-dump.1 \\r
+       $(dir)/man1/notmuch-restore.1 \\r
++      $(dir)/man1/notmuch-insert.1 \\r
+       $(dir)/man1/notmuch-new.1 \\r
+       $(dir)/man1/notmuch-reply.1 \\r
+       $(dir)/man1/notmuch-search.1 \\r
+diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1\r
+new file mode 100644\r
+index 0000000..fbf83e0\r
+--- /dev/null\r
++++ b/man/man1/notmuch-insert.1\r
+@@ -0,0 +1,49 @@\r
++.TH NOTMUCH-INSERT 1 2013-xx-xx "Notmuch 0.xx"\r
++.SH NAME\r
++notmuch-insert \- add a message to the maildir and notmuch database\r
++.SH SYNOPSIS\r
++\r
++.B notmuch insert\r
++.RI "[ +<" tag> "|\-<" tag "> ... ]"\r
++\r
++.SH DESCRIPTION\r
++\r
++.B notmuch insert\r
++reads a message from standard input\r
++and delivers it into the maildir directory given by configuration option\r
++.BR database.path ,\r
++then incorporates the message into the notmuch database.\r
++It is an alternative to using a separate tool to deliver\r
++the message then running\r
++.B notmuch new\r
++afterwards.\r
++\r
++The new message will be tagged with the tags specified by the\r
++.B new.tags\r
++configuration option, then by operations specified on the command-line:\r
++tags prefixed by '+' are added while\r
++those prefixed by '\-' are removed.\r
++\r
++If the new message is a duplicate of an existing message in the database\r
++(it has same Message-ID), it will be added to the maildir folder and\r
++notmuch database, but the tags will not be changed.\r
++\r
++.RE\r
++.SH EXIT STATUS\r
++\r
++This command returns exit status 0 if the message was successfully\r
++added to the mail directory, even if the message could not be indexed\r
++and added to the notmuch database.  In the latter case, a warning will\r
++be printed to standard error but the message file will be left on disk.\r
++\r
++If the message could not be written to disk then a non-zero exit\r
++status is returned.\r
++\r
++.RE\r
++.SH SEE ALSO\r
++\r
++\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
++\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),\r
++\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),\r
++\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),\r
++\fBnotmuch-tag\fR(1)\r
+-- \r
+1.7.12.1\r
+\r