[PATCH v2 19/20] man: document 'insert' command
authorPeter Wang <novalazy@gmail.com>
Sun, 25 Nov 2012 01:16:45 +0000 (12:16 +1100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:50:55 +0000 (09:50 -0800)
9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75 [new file with mode: 0644]

diff --git a/9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75 b/9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75
new file mode 100644 (file)
index 0000000..a852e1b
--- /dev/null
@@ -0,0 +1,150 @@
+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 1EF5C431FAF\r
+       for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 17:18:53 -0800 (PST)\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 jmDBsCtXFcUo for <notmuch@notmuchmail.org>;\r
+       Sat, 24 Nov 2012 17:18:52 -0800 (PST)\r
+Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com\r
+       [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 90073431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 17:18:52 -0800 (PST)\r
+Received: by mail-pb0-f53.google.com with SMTP id jt11so7944513pbb.26\r
+       for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 17:18:52 -0800 (PST)\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=5vez5E23kkchBqmsb4bZmai/sZK7Z8IW+op5PxyaiVE=;\r
+       b=m+4crNXirT0JWzM7PKjbybvNQXSNg0wDZy2159iKh/1RD4BSctS8qFLX94/Z1powPH\r
+       c1KPrlU+N1JqmM3vjW1zGFeGTX/1Lq/WLfOofG/wdC8dqTxXc5w0OhclJpQidjjL8S6Y\r
+       0PAGbV+sD5Q3kH9+0ts1AUjc7VIu1XbwgFLu7B8/Z08D3A33nU+TtDEr81T49kKTBNbl\r
+       9LGiAGi/4INZZH7O7NEsyjpwvaOgXwi9CSJPzzPx97WoO039N3zeMTLNdcntxWuBSYDp\r
+       +TGeXnJp5l7/ZWyFAr7vSA4iyQrMmbKoBtjIL0358GUIjFQ6bBZhl8y3q5AbYVBZVDxG\r
+       a4Xg==\r
+Received: by 10.66.85.195 with SMTP id j3mr22239316paz.1.1353806332326;\r
+       Sat, 24 Nov 2012 17:18:52 -0800 (PST)\r
+Received: from localhost (215.42.233.220.static.exetel.com.au.\r
+       [220.233.42.215])\r
+       by mx.google.com with ESMTPS id sy1sm6220028pbc.66.2012.11.24.17.18.49\r
+       (version=TLSv1/SSLv3 cipher=OTHER);\r
+       Sat, 24 Nov 2012 17:18:51 -0800 (PST)\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 19/20] man: document 'insert' command\r
+Date: Sun, 25 Nov 2012 12:16:45 +1100\r
+Message-Id: <1353806206-29133-20-git-send-email-novalazy@gmail.com>\r
+X-Mailer: git-send-email 1.7.12.1\r
+In-Reply-To: <1353806206-29133-1-git-send-email-novalazy@gmail.com>\r
+References: <1353806206-29133-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, 25 Nov 2012 01:18:53 -0000\r
+\r
+Add initial documentation for notmuch insert command.\r
+---\r
+ man/Makefile.local        |  1 +\r
+ man/man1/notmuch-insert.1 | 60 +++++++++++++++++++++++++++++++++++++++++++++++\r
+ 2 files changed, 61 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..8b1c4e9\r
+--- /dev/null\r
++++ b/man/man1/notmuch-insert.1\r
+@@ -0,0 +1,60 @@\r
++.TH NOTMUCH-INSERT 1 2012-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 "[" options "]"\r
++.RI "[ +<" tag> "|\-<" tag "> ... ]"\r
++\r
++.SH DESCRIPTION\r
++\r
++.B notmuch insert\r
++reads a message from standard input\r
++and delivers it to the specified maildir folder,\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.\r
++Additional tagging operations may be specified on the command-line:\r
++tags prefixed by '+' are added while\r
++those prefixed by '\-' are removed.\r
++\r
++Option arguments must appear before any tag operation arguments.\r
++Supported options for\r
++.B insert\r
++include\r
++.RS 4\r
++.TP 4\r
++.BI "--folder=<" folder ">"\r
++\r
++Deliver the message to the specified folder,\r
++relative to the top-level directory given by the value of\r
++\fBdatabase.path\fR.\r
++The default is to deliver to the top-level directory.\r
++\r
++.RE\r
++\r
++.RS 4\r
++.TP 4\r
++.B "--create-folder"\r
++\r
++Try to create the folder named by the\r
++.B "--folder"\r
++option, if it does not exist.\r
++Otherwise the folder must already exist for mail\r
++delivery to succeed.\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