From: Peter Wang Date: Sat, 22 Jun 2013 05:46:40 +0000 (+1000) Subject: [PATCH v6 04/12] man: document 'insert' command X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=10cb6ad502760b4ca75d621366ab596622e58f0d;p=notmuch-archives.git [PATCH v6 04/12] man: document 'insert' command --- diff --git a/78/d531c30da30fa78663dd4559570a896284e1d9 b/78/d531c30da30fa78663dd4559570a896284e1d9 new file mode 100644 index 000000000..e87681ec0 --- /dev/null +++ b/78/d531c30da30fa78663dd4559570a896284e1d9 @@ -0,0 +1,140 @@ +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 1D32B431FBD + for ; Fri, 21 Jun 2013 22:47:44 -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 PxRZa+XqDyJM for ; + Fri, 21 Jun 2013 22:47:37 -0700 (PDT) +Received: from mail-pb0-f54.google.com (mail-pb0-f54.google.com + [209.85.160.54]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 2BBC2431FD5 + for ; Fri, 21 Jun 2013 22:47:16 -0700 (PDT) +Received: by mail-pb0-f54.google.com with SMTP id ro2so8722137pbb.13 + for ; Fri, 21 Jun 2013 22:47:15 -0700 (PDT) +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=M4rFtmIU9Qt5j82bY8pOtu+2vtZbM6VTXeS4OZ7zcDU=; + b=JzqUxTqglLZ3A5JslPnic76ODNOBn/tfQpQLD4trNd64fSXvGnBk2yHZ+rDgE42EMn + 0LXOjRdqgOXd5eNiT5+hHJqJfD6k+ZBLFxdJgU+xWJrjTjCJ8wzZw3cZZsLp0+PCfYxk + ba8QljAw5yEPeUpL8lB0wktvBdskVI781jnjiKT1RJapmL/E0wNBOEdOTKJXHqwUnF++ + TnRxJyeEbw3noWKYIIQCH5SOk0lzw40UYGfzUfNj/BXYeU9bCGr+Nvt67IFJ1rj5bTyQ + 5sOdmL6lsaZ4Q7gcA9P9or+Ng6xLV2ueXNlW+cjL5r2M51PyhQldnBVjGza0rbkQTIBZ + Fu6w== +X-Received: by 10.66.141.80 with SMTP id rm16mr19445273pab.90.1371880035316; + Fri, 21 Jun 2013 22:47:15 -0700 (PDT) +Received: from localhost (215.42.233.220.static.exetel.com.au. + [220.233.42.215]) + by mx.google.com with ESMTPSA id cq1sm7901215pbc.13.2013.06.21.22.47.12 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Fri, 21 Jun 2013 22:47:14 -0700 (PDT) +From: Peter Wang +To: notmuch@notmuchmail.org +Subject: [PATCH v6 04/12] man: document 'insert' command +Date: Sat, 22 Jun 2013 15:46:40 +1000 +Message-Id: <1371880008-18312-5-git-send-email-novalazy@gmail.com> +X-Mailer: git-send-email 1.7.12.1 +In-Reply-To: <1371880008-18312-1-git-send-email-novalazy@gmail.com> +References: <1371880008-18312-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: Sat, 22 Jun 2013 05:47:44 -0000 + +Add initial documentation for notmuch insert command. +--- + man/Makefile.local | 1 + + man/man1/notmuch-insert.1 | 49 +++++++++++++++++++++++++++++++++++++++++++++++ + 2 files changed, 50 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..fbf83e0 +--- /dev/null ++++ b/man/man1/notmuch-insert.1 +@@ -0,0 +1,49 @@ ++.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 EXIT STATUS ++ ++This command returns exit status 0 if the message was successfully ++added to the mail directory, even if the message could not be indexed ++and added to the notmuch database. In the latter case, a warning will ++be printed to standard error but the message file will be left on disk. ++ ++If the message could not be written to disk then a non-zero exit ++status is returned. ++ ++.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 +