9f/8fab9d512bf4bcca4f61e4f991efdb41f67d75

   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 1EF5C431FAF\r
   6         for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 17:18:53 -0800 (PST)\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 jmDBsCtXFcUo for <notmuch@notmuchmail.org>;\r
  17         Sat, 24 Nov 2012 17:18:52 -0800 (PST)\r
  18 Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com\r
  19         [209.85.160.53]) (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 90073431FAE\r
  22         for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 17:18:52 -0800 (PST)\r
  23 Received: by mail-pb0-f53.google.com with SMTP id jt11so7944513pbb.26\r
  24         for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 17:18:52 -0800 (PST)\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=5vez5E23kkchBqmsb4bZmai/sZK7Z8IW+op5PxyaiVE=;\r
  28         b=m+4crNXirT0JWzM7PKjbybvNQXSNg0wDZy2159iKh/1RD4BSctS8qFLX94/Z1powPH\r
  29         c1KPrlU+N1JqmM3vjW1zGFeGTX/1Lq/WLfOofG/wdC8dqTxXc5w0OhclJpQidjjL8S6Y\r
  30         0PAGbV+sD5Q3kH9+0ts1AUjc7VIu1XbwgFLu7B8/Z08D3A33nU+TtDEr81T49kKTBNbl\r
  31         9LGiAGi/4INZZH7O7NEsyjpwvaOgXwi9CSJPzzPx97WoO039N3zeMTLNdcntxWuBSYDp\r
  32         +TGeXnJp5l7/ZWyFAr7vSA4iyQrMmbKoBtjIL0358GUIjFQ6bBZhl8y3q5AbYVBZVDxG\r
  33         a4Xg==\r
  34 Received: by 10.66.85.195 with SMTP id j3mr22239316paz.1.1353806332326;\r
  35         Sat, 24 Nov 2012 17:18:52 -0800 (PST)\r
  36 Received: from localhost (215.42.233.220.static.exetel.com.au.\r
  37         [220.233.42.215])\r
  38         by mx.google.com with ESMTPS id sy1sm6220028pbc.66.2012.11.24.17.18.49\r
  39         (version=TLSv1/SSLv3 cipher=OTHER);\r
  40         Sat, 24 Nov 2012 17:18:51 -0800 (PST)\r
  41 From: Peter Wang <novalazy@gmail.com>\r
  42 To: notmuch@notmuchmail.org\r
  43 Subject: [PATCH v2 19/20] man: document 'insert' command\r
  44 Date: Sun, 25 Nov 2012 12:16:45 +1100\r
  45 Message-Id: <1353806206-29133-20-git-send-email-novalazy@gmail.com>\r
  46 X-Mailer: git-send-email 1.7.12.1\r
  47 In-Reply-To: <1353806206-29133-1-git-send-email-novalazy@gmail.com>\r
  48 References: <1353806206-29133-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, 25 Nov 2012 01:18:53 -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 | 60 +++++++++++++++++++++++++++++++++++++++++++++++\r
  67  2 files changed, 61 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..8b1c4e9\r
  85 --- /dev/null\r
  86 +++ b/man/man1/notmuch-insert.1\r
  87 @@ -0,0 +1,60 @@\r
  88 +.TH NOTMUCH-INSERT 1 2012-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 "[" options "]"\r
  95 +.RI "[ +<" tag> "|\-<" tag "> ... ]"\r
  96 +\r
  97 +.SH DESCRIPTION\r
  98 +\r
  99 +.B notmuch insert\r
 100 +reads a message from standard input\r
 101 +and delivers it to the specified maildir folder,\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.\r
 111 +Additional tagging operations may be specified on the command-line:\r
 112 +tags prefixed by '+' are added while\r
 113 +those prefixed by '\-' are removed.\r
 114 +\r
 115 +Option arguments must appear before any tag operation arguments.\r
 116 +Supported options for\r
 117 +.B insert\r
 118 +include\r
 119 +.RS 4\r
 120 +.TP 4\r
 121 +.BI "--folder=<" folder ">"\r
 122 +\r
 123 +Deliver the message to the specified folder,\r
 124 +relative to the top-level directory given by the value of\r
 125 +\fBdatabase.path\fR.\r
 126 +The default is to deliver to the top-level directory.\r
 127 +\r
 128 +.RE\r
 129 +\r
 130 +.RS 4\r
 131 +.TP 4\r
 132 +.B "--create-folder"\r
 133 +\r
 134 +Try to create the folder named by the\r
 135 +.B "--folder"\r
 136 +option, if it does not exist.\r
 137 +Otherwise the folder must already exist for mail\r
 138 +delivery to succeed.\r
 139 +\r
 140 +.RE\r
 141 +.SH SEE ALSO\r
 142 +\r
 143 +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
 144 +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),\r
 145 +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),\r
 146 +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),\r
 147 +\fBnotmuch-tag\fR(1)\r
 148 -- \r
 149 1.7.12.1\r
 150 \r