From: Peter Wang Date: Tue, 2 Apr 2013 22:41:49 +0000 (+1100) Subject: [PATCH v5 04/12] man: document 'insert' command X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=dd0f8aad6c44fc6284d4c8ef3255d169004c5ea9;p=notmuch-archives.git [PATCH v5 04/12] man: document 'insert' command --- diff --git a/de/cdc8d1a5f54febad215b1030404ebf7e7a0990 b/de/cdc8d1a5f54febad215b1030404ebf7e7a0990 new file mode 100644 index 000000000..a5b4ed6a9 --- /dev/null +++ b/de/cdc8d1a5f54febad215b1030404ebf7e7a0990 @@ -0,0 +1,128 @@ +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 91C8D431E62 + for ; Tue, 2 Apr 2013 15:42:35 -0700 (PDT) +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 hjVIK84BwsCL for ; + Tue, 2 Apr 2013 15:42:34 -0700 (PDT) +Received: from mail-da0-f44.google.com (mail-da0-f44.google.com + [209.85.210.44]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 6DC66431FBC + for ; Tue, 2 Apr 2013 15:42:34 -0700 (PDT) +Received: by mail-da0-f44.google.com with SMTP id z20so383594dae.3 + for ; Tue, 02 Apr 2013 15:42:32 -0700 (PDT) +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=V68SnRsEsnvtx6xX4kedeK4l3cgvfjou0Xc3V59AapE=; + b=h95G5nD6asbHxehTKCf+qPlyWWOMYLAB/WpqAVpxDIG7u4hrJz7sydueZfU7lyIeBJ + moVRK7PYRUqvb7Q2dJWQHn9jRB1pGCiJL3VLKOFc4UJxQlLeuopOZpsmfEFJB3wH+D/C + Y1Y6Hi3fwZZuQqn/Kb6uBEjf5oF5k3ln7JCMhtabdDJUGdVJ/Y4D7+lt2DttlD5ORsVU + X5mk4EcIWu/wN4RgyosOi+DLgts+/9jhNpflAxvZclBGweo9MW+BYYI9G8ivDRQ9xCee + L6g3dojJUNqWmf0YnIDQEp05KuwVQhhirAq57RKAEZArePfq9AqB8cKiCayXpAkE7nG0 + vZvw== +X-Received: by 10.66.146.232 with SMTP id tf8mr28158268pab.32.1364942552564; + Tue, 02 Apr 2013 15:42:32 -0700 (PDT) +Received: from localhost (215.42.233.220.static.exetel.com.au. + [220.233.42.215]) + by mx.google.com with ESMTPS id ux10sm4059901pab.1.2013.04.02.15.42.29 + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Tue, 02 Apr 2013 15:42:31 -0700 (PDT) +From: Peter Wang +To: notmuch@notmuchmail.org +Subject: [PATCH v5 04/12] man: document 'insert' command +Date: Wed, 3 Apr 2013 09:41:49 +1100 +Message-Id: <1364942517-6982-5-git-send-email-novalazy@gmail.com> +X-Mailer: git-send-email 1.7.12.1 +In-Reply-To: <1364942517-6982-1-git-send-email-novalazy@gmail.com> +References: <1364942517-6982-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: Tue, 02 Apr 2013 22:42:36 -0000 + +Add initial documentation for notmuch insert command. +--- + man/Makefile.local | 1 + + man/man1/notmuch-insert.1 | 38 ++++++++++++++++++++++++++++++++++++++ + 2 files changed, 39 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..870e1bc +--- /dev/null ++++ b/man/man1/notmuch-insert.1 +@@ -0,0 +1,38 @@ ++.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 "[ +<" tag> "|\-<" tag "> ... ]" ++ ++.SH DESCRIPTION ++ ++.B notmuch insert ++reads a message from standard input ++and delivers it into the maildir directory given by configuration option ++.BR database.path , ++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. ++ ++If the new message is a duplicate of an existing message in the database ++(it has same Message-ID), it will be added to the maildir folder and ++notmuch database, but the tags will not be changed. ++ ++.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 +