From: Jani Nikula Date: Sat, 27 Apr 2013 21:27:57 +0000 (+0300) Subject: Re: [PATCH v5 04/12] man: document 'insert' command X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=d71498a621acf5a21cb009b9057b190a05214c2a;p=notmuch-archives.git Re: [PATCH v5 04/12] man: document 'insert' command --- diff --git a/da/a4ed46b48fe35e54e31bda52aa4b3f49e08917 b/da/a4ed46b48fe35e54e31bda52aa4b3f49e08917 new file mode 100644 index 000000000..545e5a91c --- /dev/null +++ b/da/a4ed46b48fe35e54e31bda52aa4b3f49e08917 @@ -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 6F7BA431FC3 + for ; Sat, 27 Apr 2013 14:28:11 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[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 QMXgLmr0JWNa for ; + Sat, 27 Apr 2013 14:28:11 -0700 (PDT) +Received: from mail-lb0-f169.google.com (mail-lb0-f169.google.com + [209.85.217.169]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id B2994431FC2 + for ; Sat, 27 Apr 2013 14:28:10 -0700 (PDT) +Received: by mail-lb0-f169.google.com with SMTP id z5so1727lbh.14 + for ; Sat, 27 Apr 2013 14:28:09 -0700 (PDT) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=google.com; s=20120113; + h=x-received:from:to:subject:in-reply-to:references:user-agent:date + :message-id:mime-version:content-type:x-gm-message-state; + bh=f0M2Vo4HQRPoKGMMdBqb5xv9Bc3mXF/ouhEaW/UISaE=; + b=FfgLCrXEX4Oob0spq8QBn4hyScKafXV+xwiAzQ9ZnZrSLjlTqv+0Hf/M70Lc0BBFcv + 4LRuiF/vi6AqmvO0E7OoCmgaAhmoXbfKuQEr6AM2MT1rxJjzNvQyfvbzp7MrheFPWb+p + Y5KJ/KQSHts11Tg91QdaLxZm5P6bT9G20WdYFseYc9z13DZmvcJCedwkkWLaLXOibusZ + KddL9SNmLa7tj41m9cSBtbKg6ocMWoybQWMhUE0dfKfFcVKJYqqLitPVK9H7tZ0w3YCv + FwvvyVQChHOHojyk/DS90novfZCjKirqQtaQSpalLmH8GDVpDOMbAMTd5PXHeXxZM1gD + 9OHA== +X-Received: by 10.112.168.97 with SMTP id zv1mr24114537lbb.25.1367098089290; + Sat, 27 Apr 2013 14:28:09 -0700 (PDT) +Received: from localhost (dsl-hkibrasgw2-58c376-211.dhcp.inet.fi. + [88.195.118.211]) + by mx.google.com with ESMTPSA id e2sm2448758lag.5.2013.04.27.14.28.08 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Sat, 27 Apr 2013 14:28:08 -0700 (PDT) +From: Jani Nikula +To: Peter Wang , notmuch@notmuchmail.org +Subject: Re: [PATCH v5 04/12] man: document 'insert' command +In-Reply-To: <1364942517-6982-5-git-send-email-novalazy@gmail.com> +References: <1364942517-6982-1-git-send-email-novalazy@gmail.com> + <1364942517-6982-5-git-send-email-novalazy@gmail.com> +User-Agent: Notmuch/0.15.2+70~g2eeb96a (http://notmuchmail.org) Emacs/24.2.1 + (x86_64-pc-linux-gnu) +Date: Sun, 28 Apr 2013 00:27:57 +0300 +Message-ID: <8738ubr7du.fsf@nikula.org> +MIME-Version: 1.0 +Content-Type: text/plain +X-Gm-Message-State: + ALoCoQnPXqZUpHjuzratpVi7esDU8eziwkykMb2os708XShDL1cpUMvh5D9fryalaihzCycSCI/m +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: Sat, 27 Apr 2013 21:28:11 -0000 + +On Wed, 03 Apr 2013, Peter Wang wrote: +> Add initial documentation for notmuch insert command. + +Of all commands, this man page begs more discussion about the failure +modes and exit status. + +BR, +Jani. + + +> --- +> 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 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch