From: Peter Wang Date: Sun, 25 Nov 2012 01:16:45 +0000 (+1100) Subject: [PATCH v2 19/20] man: document 'insert' command X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=9b4f4411c37a97658a0291f89961ad08c8460edd;p=notmuch-archives.git [PATCH v2 19/20] man: document 'insert' command --- diff --git a/9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75 b/9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75 new file mode 100644 index 000000000..a852e1b63 --- /dev/null +++ b/9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75 @@ -0,0 +1,150 @@ +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 1EF5C431FAF + for ; Sat, 24 Nov 2012 17:18:53 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.799 +X-Spam-Level: +X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] 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 jmDBsCtXFcUo for ; + Sat, 24 Nov 2012 17:18:52 -0800 (PST) +Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com + [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 90073431FAE + for ; Sat, 24 Nov 2012 17:18:52 -0800 (PST) +Received: by mail-pb0-f53.google.com with SMTP id jt11so7944513pbb.26 + for ; Sat, 24 Nov 2012 17:18:52 -0800 (PST) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; + bh=5vez5E23kkchBqmsb4bZmai/sZK7Z8IW+op5PxyaiVE=; + b=m+4crNXirT0JWzM7PKjbybvNQXSNg0wDZy2159iKh/1RD4BSctS8qFLX94/Z1powPH + c1KPrlU+N1JqmM3vjW1zGFeGTX/1Lq/WLfOofG/wdC8dqTxXc5w0OhclJpQidjjL8S6Y + 0PAGbV+sD5Q3kH9+0ts1AUjc7VIu1XbwgFLu7B8/Z08D3A33nU+TtDEr81T49kKTBNbl + 9LGiAGi/4INZZH7O7NEsyjpwvaOgXwi9CSJPzzPx97WoO039N3zeMTLNdcntxWuBSYDp + +TGeXnJp5l7/ZWyFAr7vSA4iyQrMmbKoBtjIL0358GUIjFQ6bBZhl8y3q5AbYVBZVDxG + a4Xg== +Received: by 10.66.85.195 with SMTP id j3mr22239316paz.1.1353806332326; + Sat, 24 Nov 2012 17:18:52 -0800 (PST) +Received: from localhost (215.42.233.220.static.exetel.com.au. + [220.233.42.215]) + by mx.google.com with ESMTPS id sy1sm6220028pbc.66.2012.11.24.17.18.49 + (version=TLSv1/SSLv3 cipher=OTHER); + Sat, 24 Nov 2012 17:18:51 -0800 (PST) +From: Peter Wang +To: notmuch@notmuchmail.org +Subject: [PATCH v2 19/20] man: document 'insert' command +Date: Sun, 25 Nov 2012 12:16:45 +1100 +Message-Id: <1353806206-29133-20-git-send-email-novalazy@gmail.com> +X-Mailer: git-send-email 1.7.12.1 +In-Reply-To: <1353806206-29133-1-git-send-email-novalazy@gmail.com> +References: <1353806206-29133-1-git-send-email-novalazy@gmail.com> +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 01:18:53 -0000 + +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. ++ ++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 +