a3/7f66dc56c560ceb08fac87d86299ed79721fef

   1 Return-Path: <novalazy@gmail.com>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id EB3F1431FAE\r
   6         for <notmuch@notmuchmail.org>; Sat, 22 Jun 2013 21:24:31 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.799\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
  12         tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
  13         FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  14 Received: from olra.theworths.org ([127.0.0.1])\r
  15         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  16         with ESMTP id MzajXNN1hU8o for <notmuch@notmuchmail.org>;\r
  17         Sat, 22 Jun 2013 21:24:25 -0700 (PDT)\r
  18 Received: from mail-pa0-f46.google.com (mail-pa0-f46.google.com\r
  19         [209.85.220.46]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 0EE0E431FC9\r
  22         for <notmuch@notmuchmail.org>; Sat, 22 Jun 2013 21:24:17 -0700 (PDT)\r
  23 Received: by mail-pa0-f46.google.com with SMTP id fa11so9507454pad.5\r
  24         for <notmuch@notmuchmail.org>; Sat, 22 Jun 2013 21:24:16 -0700 (PDT)\r
  25 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
  26         h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
  27         bh=M4rFtmIU9Qt5j82bY8pOtu+2vtZbM6VTXeS4OZ7zcDU=;\r
  28         b=CnM4yhNLYKISOs2NYK1YGwqthWJF1s7sTk3EUejrSpFyPyfA73WYvcAGdjcLHGikJ5\r
  29         YWwDgM2pAHfpikn6bbvw5HeUEapcewgLGKiNYNkO6T/mIec+eDq5NxtnE7MYTUVnSHHI\r
  30         Gbhhd9NWBnW2CbOnyeusy5UC4cFvvvxD6EjhPT50alC7p1alm96yHGR57chsmiLLjydd\r
  31         IHjIQaP8CC6IY9ozRdVSDJSE/dpxc6Qb5L7rlq2NdlSrdibNUXL3Vl6stNfkUKYxdnGN\r
  32         6tdxrDMmc4DmRKdzGvcGVA/Inzzy8FxNNwXtz/eihLhgUmgbLiFVSmhPUVXUXNEMevD4\r
  33         ALFA==\r
  34 X-Received: by 10.68.40.170 with SMTP id y10mr2745480pbk.155.1371961455979;\r
  35         Sat, 22 Jun 2013 21:24:15 -0700 (PDT)\r
  36 Received: from localhost (215.42.233.220.static.exetel.com.au.\r
  37         [220.233.42.215]) by mx.google.com with ESMTPSA id\r
  38         fr1sm11847382pbb.26.2013.06.22.21.24.13 for <multiple recipients>\r
  39         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
  40         Sat, 22 Jun 2013 21:24:15 -0700 (PDT)\r
  41 From: Peter Wang <novalazy@gmail.com>\r
  42 To: notmuch@notmuchmail.org\r
  43 Subject: [PATCH v7 04/12] man: document 'insert' command\r
  44 Date: Sun, 23 Jun 2013 14:23:57 +1000\r
  45 Message-Id: <1371961445-15182-5-git-send-email-novalazy@gmail.com>\r
  46 X-Mailer: git-send-email 1.7.12.1\r
  47 In-Reply-To: <1371961445-15182-1-git-send-email-novalazy@gmail.com>\r
  48 References: <1371961445-15182-1-git-send-email-novalazy@gmail.com>\r
  49 X-BeenThere: notmuch@notmuchmail.org\r
  50 X-Mailman-Version: 2.1.13\r
  51 Precedence: list\r
  52 List-Id: "Use and development of the notmuch mail system."\r
  53         <notmuch.notmuchmail.org>\r
  54 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  55         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  56 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  57 List-Post: <mailto:notmuch@notmuchmail.org>\r
  58 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  59 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  60         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  61 X-List-Received-Date: Sun, 23 Jun 2013 04:24:32 -0000\r
  62 \r
  63 Add initial documentation for notmuch insert command.\r
  64 ---\r
  65  man/Makefile.local        |  1 +\r
  66  man/man1/notmuch-insert.1 | 49 +++++++++++++++++++++++++++++++++++++++++++++++\r
  67  2 files changed, 50 insertions(+)\r
  68  create mode 100644 man/man1/notmuch-insert.1\r
  69 \r
  70 diff --git a/man/Makefile.local b/man/Makefile.local\r
  71 index 72e2a18..216aaa0 100644\r
  72 --- a/man/Makefile.local\r
  73 +++ b/man/Makefile.local\r
  74 @@ -12,6 +12,7 @@ MAN1 := \\r
  75         $(dir)/man1/notmuch-count.1 \\r
  76         $(dir)/man1/notmuch-dump.1 \\r
  77         $(dir)/man1/notmuch-restore.1 \\r
  78 +       $(dir)/man1/notmuch-insert.1 \\r
  79         $(dir)/man1/notmuch-new.1 \\r
  80         $(dir)/man1/notmuch-reply.1 \\r
  81         $(dir)/man1/notmuch-search.1 \\r
  82 diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1\r
  83 new file mode 100644\r
  84 index 0000000..fbf83e0\r
  85 --- /dev/null\r
  86 +++ b/man/man1/notmuch-insert.1\r
  87 @@ -0,0 +1,49 @@\r
  88 +.TH NOTMUCH-INSERT 1 2013-xx-xx "Notmuch 0.xx"\r
  89 +.SH NAME\r
  90 +notmuch-insert \- add a message to the maildir and notmuch database\r
  91 +.SH SYNOPSIS\r
  92 +\r
  93 +.B notmuch insert\r
  94 +.RI "[ +<" tag> "|\-<" tag "> ... ]"\r
  95 +\r
  96 +.SH DESCRIPTION\r
  97 +\r
  98 +.B notmuch insert\r
  99 +reads a message from standard input\r
 100 +and delivers it into the maildir directory given by configuration option\r
 101 +.BR database.path ,\r
 102 +then incorporates the message into the notmuch database.\r
 103 +It is an alternative to using a separate tool to deliver\r
 104 +the message then running\r
 105 +.B notmuch new\r
 106 +afterwards.\r
 107 +\r
 108 +The new message will be tagged with the tags specified by the\r
 109 +.B new.tags\r
 110 +configuration option, then by operations specified on the command-line:\r
 111 +tags prefixed by '+' are added while\r
 112 +those prefixed by '\-' are removed.\r
 113 +\r
 114 +If the new message is a duplicate of an existing message in the database\r
 115 +(it has same Message-ID), it will be added to the maildir folder and\r
 116 +notmuch database, but the tags will not be changed.\r
 117 +\r
 118 +.RE\r
 119 +.SH EXIT STATUS\r
 120 +\r
 121 +This command returns exit status 0 if the message was successfully\r
 122 +added to the mail directory, even if the message could not be indexed\r
 123 +and added to the notmuch database.  In the latter case, a warning will\r
 124 +be printed to standard error but the message file will be left on disk.\r
 125 +\r
 126 +If the message could not be written to disk then a non-zero exit\r
 127 +status is returned.\r
 128 +\r
 129 +.RE\r
 130 +.SH SEE ALSO\r
 131 +\r
 132 +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
 133 +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),\r
 134 +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),\r
 135 +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),\r
 136 +\fBnotmuch-tag\fR(1)\r
 137 -- \r
 138 1.7.12.1\r
 139 \r