From c7d08fb81f65a8cab671fc706d33751d6d17f908 Mon Sep 17 00:00:00 2001 From: Peter Wang Date: Sun, 20 Jan 2013 11:50:02 +1100 Subject: [PATCH] [PATCH v3 18/20] man: document 'insert' command --- 80/431a69a0cc0a02a2ba4402efa8f9af92d56d50 | 149 ++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 80/431a69a0cc0a02a2ba4402efa8f9af92d56d50 diff --git a/80/431a69a0cc0a02a2ba4402efa8f9af92d56d50 b/80/431a69a0cc0a02a2ba4402efa8f9af92d56d50 new file mode 100644 index 000000000..238298847 --- /dev/null +++ b/80/431a69a0cc0a02a2ba4402efa8f9af92d56d50 @@ -0,0 +1,149 @@ +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 99B8E429E33 + for ; Sat, 19 Jan 2013 16:52:21 -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 eh6eBAGwhHFl for ; + Sat, 19 Jan 2013 16:52:20 -0800 (PST) +Received: from mail-da0-f47.google.com (mail-da0-f47.google.com + [209.85.210.47]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 8E29A429E3E + for ; Sat, 19 Jan 2013 16:52:01 -0800 (PST) +Received: by mail-da0-f47.google.com with SMTP id s35so2163025dak.34 + for ; Sat, 19 Jan 2013 16:52:00 -0800 (PST) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=x-received:from:to:cc:subject:date:message-id:x-mailer:in-reply-to + :references; bh=FsImLGtllAtJcMDNS1fw4+/a9Ds6Tc+sSpnJlBsUs5Y=; + b=lAeRbzI/ZFg3DfVe/tFyfbHrl0Vzrztprh70edc6HMFq1T4O9nXoEqOMzuD8RfCIjA + 5jMUdSP4wqgBvVYNS1BX4beMZrl6yuXFFnmj0HEIZBLuVg9NBrDyUVBeSO1izDq9SLEz + DUvK60fJ+zpQ4+0vVJoU4Dn/Oo5WbKJPRyU9gP0fuf5u/Hwodx9VBmkJsq3O/jf7mJvj + KW+FRuekQQgzmGzdYXJDT6/oVMdwxgYZ8F3/kqd+VetlYIEYF83cZKb2ym6YVnDGzkmU + oK0/ceXJ5K4OJMUL8kqm+NruMkdGAbholqS6vOmOvUtt3JNVyksWEW/ve1Wl7BEkY56P + eSGQ== +X-Received: by 10.68.244.169 with SMTP id xh9mr18520011pbc.52.1358643120704; + Sat, 19 Jan 2013 16:52:00 -0800 (PST) +Received: from localhost (215.42.233.220.static.exetel.com.au. + [220.233.42.215]) + by mx.google.com with ESMTPS id i5sm6272238pax.13.2013.01.19.16.51.58 + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sat, 19 Jan 2013 16:52:00 -0800 (PST) +From: Peter Wang +To: notmuch@notmuchmail.org +Subject: [PATCH v3 18/20] man: document 'insert' command +Date: Sun, 20 Jan 2013 11:50:02 +1100 +Message-Id: <1358643004-14522-19-git-send-email-novalazy@gmail.com> +X-Mailer: git-send-email 1.7.12.1 +In-Reply-To: <1358643004-14522-1-git-send-email-novalazy@gmail.com> +References: <1358643004-14522-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, 20 Jan 2013 00:52:21 -0000 + +Add initial documentation for notmuch insert command. +--- + man/Makefile.local | 1 + + man/man1/notmuch-insert.1 | 59 +++++++++++++++++++++++++++++++++++++++++++++++ + 2 files changed, 60 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..4a7cbeb +--- /dev/null ++++ b/man/man1/notmuch-insert.1 +@@ -0,0 +1,59 @@ ++.TH NOTMUCH-INSERT 1 2013-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, then by operations 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 + -- 2.26.2