Re: [PATCH 14/18] man: document 'insert' command
authorMark Walters <markwalters1009@gmail.com>
Sun, 18 Nov 2012 17:13:38 +0000 (17:13 +0000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:50:40 +0000 (09:50 -0800)
bc/0c6eb202b23ff7e239223bb9f4f086d746f0d2 [new file with mode: 0644]

diff --git a/bc/0c6eb202b23ff7e239223bb9f4f086d746f0d2 b/bc/0c6eb202b23ff7e239223bb9f4f086d746f0d2
new file mode 100644 (file)
index 0000000..3426887
--- /dev/null
@@ -0,0 +1,168 @@
+Return-Path: <m.walters@qmul.ac.uk>\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 3C424431FB6\r
+       for <notmuch@notmuchmail.org>; Sun, 18 Nov 2012 09:13:42 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+       tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+       NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 lajPfCizhmN4 for <notmuch@notmuchmail.org>;\r
+       Sun, 18 Nov 2012 09:13:41 -0800 (PST)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 47922431FAF\r
+       for <notmuch@notmuchmail.org>; Sun, 18 Nov 2012 09:13:41 -0800 (PST)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+       by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1Ta8R9-0008RP-HW; Sun, 18 Nov 2012 17:13:40 +0000\r
+Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
+       by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1Ta8R9-0003aa-64; Sun, 18 Nov 2012 17:13:39 +0000\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Peter Wang <novalazy@gmail.com>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 14/18] man: document 'insert' command\r
+In-Reply-To: <1343223767-9812-14-git-send-email-novalazy@gmail.com>\r
+References: <1343223767-9812-1-git-send-email-novalazy@gmail.com>\r
+       <1343223767-9812-14-git-send-email-novalazy@gmail.com>\r
+User-Agent: Notmuch/0.14+81~g9730584 (http://notmuchmail.org) Emacs/23.4.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sun, 18 Nov 2012 17:13:38 +0000\r
+Message-ID: <87obiuq1fh.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 93.97.24.31\r
+X-QM-SPAM-Info: Sender has good ham record.  :)\r
+X-QM-Body-MD5: 3908b197edef21d25ad5cc13265f9c78 (of first 20000 bytes)\r
+X-SpamAssassin-Score: -1.8\r
+X-SpamAssassin-SpamBar: -\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+       determine if it is\r
+       spam. We require at least 5.0 points to mark a message as spam.\r
+       This message scored -1.8 points.\r
+       Summary of the scoring: \r
+       * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
+       *      medium trust\r
+       *      [138.37.6.40 listed in list.dnswl.org]\r
+       * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+       provider *      (markwalters1009[at]gmail.com)\r
+       *  0.5 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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, 18 Nov 2012 17:13:42 -0000\r
+\r
+On Wed, 25 Jul 2012, Peter Wang <novalazy@gmail.com> wrote:\r
+> Add initial documentation for notmuch insert command.\r
+> ---\r
+>  man/Makefile.local        |    1 +\r
+>  man/man1/notmuch-insert.1 |   50 +++++++++++++++++++++++++++++++++++++++++++++\r
+>  2 files changed, 51 insertions(+), 0 deletions(-)\r
+>  create mode 100644 man/man1/notmuch-insert.1\r
+>\r
+> diff --git a/man/Makefile.local b/man/Makefile.local\r
+> index d43a949..f91bfd4 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..7d281b5\r
+> --- /dev/null\r
+> +++ b/man/man1/notmuch-insert.1\r
+> @@ -0,0 +1,50 @@\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 "--"\r
+> +.RI "[ +<" tag> "|\-<" tag "> ... ]"\r
+> +\r
+> +.SH DESCRIPTION\r
+> +\r
+> +.B notmuch insert\r
+> +reads a message from standard input and delivers it to the specified\r
+> +maildir folder, then incorporates the message into the notmuch\r
+> +database.  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 those prefixed by '\-' are\r
+> +removed.  notmuch will warn about ambiguous tag removal arguments\r
+> +which may be confused with option arguments.  It is recommended to use\r
+> +the option list terminator "--" to avoid ambiguity.\r
+> +\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\r
+> +.RI Maildir/ folder\r
+> +directory, which must already exist.\r
+> +The default is to deliver to the top-level directory.\r
+\r
+I think this should say something about notmuch database root: so that\r
+by default it delivers to the top-level directory of the notmuch\r
+database, and otherwise is relative to that. Maybe just replace Maildir\r
+by something like "<notmuch-database-root>" or something?\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+> +\r
+> +.RE\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.4.4\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r