From: Mark Walters Date: Sun, 25 Nov 2012 16:17:10 +0000 (+0000) Subject: Re: [PATCH v2 19/20] man: document 'insert' command X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=5d3daf961043784065c4bc43f02d0e35048e967e;p=notmuch-archives.git Re: [PATCH v2 19/20] man: document 'insert' command --- diff --git a/7c/e8c0c1b874bbdead101c6d7ce5cb25de3889b2 b/7c/e8c0c1b874bbdead101c6d7ce5cb25de3889b2 new file mode 100644 index 000000000..486723bed --- /dev/null +++ b/7c/e8c0c1b874bbdead101c6d7ce5cb25de3889b2 @@ -0,0 +1,173 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 77C07431FAF + for ; Sun, 25 Nov 2012 08:17:10 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -1.098 +X-Spam-Level: +X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5 + tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001, + NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id o4uGknE9uKyG for ; + Sun, 25 Nov 2012 08:17:09 -0800 (PST) +Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 9E5C3431FAE + for ; Sun, 25 Nov 2012 08:17:09 -0800 (PST) +Received: from smtp.qmul.ac.uk ([138.37.6.40]) + by mail2.qmul.ac.uk with esmtp (Exim 4.71) + (envelope-from ) + id 1TcetI-000699-4k; Sun, 25 Nov 2012 16:17:08 +0000 +Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost) + by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69) + (envelope-from ) + id 1TcetH-0001XW-NC; Sun, 25 Nov 2012 16:17:07 +0000 +From: Mark Walters +To: Peter Wang , notmuch@notmuchmail.org +Subject: Re: [PATCH v2 19/20] man: document 'insert' command +In-Reply-To: <1353806206-29133-20-git-send-email-novalazy@gmail.com> +References: <1353806206-29133-1-git-send-email-novalazy@gmail.com> + <1353806206-29133-20-git-send-email-novalazy@gmail.com> +User-Agent: Notmuch/0.14+81~g9730584 (http://notmuchmail.org) Emacs/23.4.1 + (x86_64-pc-linux-gnu) +Date: Sun, 25 Nov 2012 16:17:10 +0000 +Message-ID: <8738zxk67t.fsf@qmul.ac.uk> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Sender-Host-Address: 93.97.24.31 +X-QM-SPAM-Info: Sender has good ham record. :) +X-QM-Body-MD5: ee7de07219567c631fef3a5ab54f1681 (of first 20000 bytes) +X-SpamAssassin-Score: -1.8 +X-SpamAssassin-SpamBar: - +X-SpamAssassin-Report: The QM spam filters have analysed this message to + determine if it is + spam. We require at least 5.0 points to mark a message as spam. + This message scored -1.8 points. + Summary of the scoring: + * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/, + * medium trust + * [138.37.6.40 listed in list.dnswl.org] + * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail + provider * (markwalters1009[at]gmail.com) + * 0.5 AWL AWL: From: address is in the auto white-list +X-QM-Scan-Virus: ClamAV says the message is clean +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 25 Nov 2012 16:17:10 -0000 + +On Sun, 25 Nov 2012, Peter Wang wrote: +> Add initial documentation for notmuch insert command. +> --- +> man/Makefile.local | 1 + +> man/man1/notmuch-insert.1 | 60 +++++++++++++++++++++++++++++++++++++++++++++++ +> 2 files changed, 61 insertions(+) +> create mode 100644 man/man1/notmuch-insert.1 +> +> diff --git a/man/Makefile.local b/man/Makefile.local +> index 72e2a18..216aaa0 100644 +> --- a/man/Makefile.local +> +++ b/man/Makefile.local +> @@ -12,6 +12,7 @@ MAN1 := \ +> $(dir)/man1/notmuch-count.1 \ +> $(dir)/man1/notmuch-dump.1 \ +> $(dir)/man1/notmuch-restore.1 \ +> + $(dir)/man1/notmuch-insert.1 \ +> $(dir)/man1/notmuch-new.1 \ +> $(dir)/man1/notmuch-reply.1 \ +> $(dir)/man1/notmuch-search.1 \ +> diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1 +> new file mode 100644 +> index 0000000..8b1c4e9 +> --- /dev/null +> +++ b/man/man1/notmuch-insert.1 +> @@ -0,0 +1,60 @@ +> +.TH NOTMUCH-INSERT 1 2012-xx-xx "Notmuch 0.xx" +> +.SH NAME +> +notmuch-insert \- add a message to the maildir and notmuch database +> +.SH SYNOPSIS +> + +> +.B notmuch insert +> +.RI "[" options "]" +> +.RI "[ +<" tag> "|\-<" tag "> ... ]" +> + +> +.SH DESCRIPTION +> + +> +.B notmuch insert +> +reads a message from standard input +> +and delivers it to the specified maildir folder, +> +then incorporates the message into the notmuch database. +> +It is an alternative to using a separate tool to deliver +> +the message then running +> +.B notmuch new +> +afterwards. +> + +> +The new message will be tagged with the tags specified by the +> +.B new.tags +> +configuration option. +> +Additional tagging operations may be specified on the command-line: +> +tags prefixed by '+' are added while +> +those prefixed by '\-' are removed. + +Is it worth emphasising that the command line tags are applied after the +new tags so can be used to remove the new tags? + +Best wishes + +Mark + +> +Option arguments must appear before any tag operation arguments. +> +Supported options for +> +.B insert +> +include +> +.RS 4 +> +.TP 4 +> +.BI "--folder=<" folder ">" +> + +> +Deliver the message to the specified folder, +> +relative to the top-level directory given by the value of +> +\fBdatabase.path\fR. +> +The default is to deliver to the top-level directory. +> + +> +.RE +> + +> +.RS 4 +> +.TP 4 +> +.B "--create-folder" +> + +> +Try to create the folder named by the +> +.B "--folder" +> +option, if it does not exist. +> +Otherwise the folder must already exist for mail +> +delivery to succeed. +> + +> +.RE +> +.SH SEE ALSO +> + +> +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +> +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1), +> +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), +> +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1), +> +\fBnotmuch-tag\fR(1) +> -- +> 1.7.12.1 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch