Re: [PATCH v5 04/12] man: document 'insert' command
authorJani Nikula <jani@nikula.org>
Sat, 27 Apr 2013 21:27:57 +0000 (00:27 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:54:29 +0000 (09:54 -0800)
da/a4ed46b48fe35e54e31bda52aa4b3f49e08917 [new file with mode: 0644]

diff --git a/da/a4ed46b48fe35e54e31bda52aa4b3f49e08917 b/da/a4ed46b48fe35e54e31bda52aa4b3f49e08917
new file mode 100644 (file)
index 0000000..545e5a9
--- /dev/null
@@ -0,0 +1,149 @@
+Return-Path: <jani@nikula.org>\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 6F7BA431FC3\r
+       for <notmuch@notmuchmail.org>; Sat, 27 Apr 2013 14:28:11 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 QMXgLmr0JWNa for <notmuch@notmuchmail.org>;\r
+       Sat, 27 Apr 2013 14:28:11 -0700 (PDT)\r
+Received: from mail-lb0-f169.google.com (mail-lb0-f169.google.com\r
+       [209.85.217.169]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id B2994431FC2\r
+       for <notmuch@notmuchmail.org>; Sat, 27 Apr 2013 14:28:10 -0700 (PDT)\r
+Received: by mail-lb0-f169.google.com with SMTP id z5so1727lbh.14\r
+       for <notmuch@notmuchmail.org>; Sat, 27 Apr 2013 14:28:09 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=x-received:from:to:subject:in-reply-to:references:user-agent:date\r
+       :message-id:mime-version:content-type:x-gm-message-state;\r
+       bh=f0M2Vo4HQRPoKGMMdBqb5xv9Bc3mXF/ouhEaW/UISaE=;\r
+       b=FfgLCrXEX4Oob0spq8QBn4hyScKafXV+xwiAzQ9ZnZrSLjlTqv+0Hf/M70Lc0BBFcv\r
+       4LRuiF/vi6AqmvO0E7OoCmgaAhmoXbfKuQEr6AM2MT1rxJjzNvQyfvbzp7MrheFPWb+p\r
+       Y5KJ/KQSHts11Tg91QdaLxZm5P6bT9G20WdYFseYc9z13DZmvcJCedwkkWLaLXOibusZ\r
+       KddL9SNmLa7tj41m9cSBtbKg6ocMWoybQWMhUE0dfKfFcVKJYqqLitPVK9H7tZ0w3YCv\r
+       FwvvyVQChHOHojyk/DS90novfZCjKirqQtaQSpalLmH8GDVpDOMbAMTd5PXHeXxZM1gD\r
+       9OHA==\r
+X-Received: by 10.112.168.97 with SMTP id zv1mr24114537lbb.25.1367098089290;\r
+       Sat, 27 Apr 2013 14:28:09 -0700 (PDT)\r
+Received: from localhost (dsl-hkibrasgw2-58c376-211.dhcp.inet.fi.\r
+       [88.195.118.211])\r
+       by mx.google.com with ESMTPSA id e2sm2448758lag.5.2013.04.27.14.28.08\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 27 Apr 2013 14:28:08 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: Peter Wang <novalazy@gmail.com>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v5 04/12] man: document 'insert' command\r
+In-Reply-To: <1364942517-6982-5-git-send-email-novalazy@gmail.com>\r
+References: <1364942517-6982-1-git-send-email-novalazy@gmail.com>\r
+       <1364942517-6982-5-git-send-email-novalazy@gmail.com>\r
+User-Agent: Notmuch/0.15.2+70~g2eeb96a (http://notmuchmail.org) Emacs/24.2.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sun, 28 Apr 2013 00:27:57 +0300\r
+Message-ID: <8738ubr7du.fsf@nikula.org>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-Gm-Message-State:\r
+ ALoCoQnPXqZUpHjuzratpVi7esDU8eziwkykMb2os708XShDL1cpUMvh5D9fryalaihzCycSCI/m\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: Sat, 27 Apr 2013 21:28:11 -0000\r
+\r
+On Wed, 03 Apr 2013, Peter Wang <novalazy@gmail.com> wrote:\r
+> Add initial documentation for notmuch insert command.\r
+\r
+Of all commands, this man page begs more discussion about the failure\r
+modes and exit status.\r
+\r
+BR,\r
+Jani.\r
+\r
+\r
+> ---\r
+>  man/Makefile.local        |  1 +\r
+>  man/man1/notmuch-insert.1 | 38 ++++++++++++++++++++++++++++++++++++++\r
+>  2 files changed, 39 insertions(+)\r
+>  create mode 100644 man/man1/notmuch-insert.1\r
+>\r
+> diff --git a/man/Makefile.local b/man/Makefile.local\r
+> index 72e2a18..216aaa0 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..870e1bc\r
+> --- /dev/null\r
+> +++ b/man/man1/notmuch-insert.1\r
+> @@ -0,0 +1,38 @@\r
+> +.TH NOTMUCH-INSERT 1 2013-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 "[ +<" tag> "|\-<" tag "> ... ]"\r
+> +\r
+> +.SH DESCRIPTION\r
+> +\r
+> +.B notmuch insert\r
+> +reads a message from standard input\r
+> +and delivers it into the maildir directory given by configuration option\r
+> +.BR database.path ,\r
+> +then incorporates the message into the notmuch database.\r
+> +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, then by operations specified on the command-line:\r
+> +tags prefixed by '+' are added while\r
+> +those prefixed by '\-' are removed.\r
+> +\r
+> +If the new message is a duplicate of an existing message in the database\r
+> +(it has same Message-ID), it will be added to the maildir folder and\r
+> +notmuch database, but the tags will not be changed.\r
+> +\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.12.1\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r