Re: [feature request] emacs: use `notmuch insert` for FCC
[notmuch-archives.git] / 80 / 431a69a0cc0a02a2ba4402efa8f9af92d56d50
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 99B8E429E33\r
6         for <notmuch@notmuchmail.org>; Sat, 19 Jan 2013 16:52:21 -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 eh6eBAGwhHFl for <notmuch@notmuchmail.org>;\r
17         Sat, 19 Jan 2013 16:52:20 -0800 (PST)\r
18 Received: from mail-da0-f47.google.com (mail-da0-f47.google.com\r
19         [209.85.210.47]) (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 8E29A429E3E\r
22         for <notmuch@notmuchmail.org>; Sat, 19 Jan 2013 16:52:01 -0800 (PST)\r
23 Received: by mail-da0-f47.google.com with SMTP id s35so2163025dak.34\r
24         for <notmuch@notmuchmail.org>; Sat, 19 Jan 2013 16:52:00 -0800 (PST)\r
25 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
26         h=x-received:from:to:cc:subject:date:message-id:x-mailer:in-reply-to\r
27         :references; bh=FsImLGtllAtJcMDNS1fw4+/a9Ds6Tc+sSpnJlBsUs5Y=;\r
28         b=lAeRbzI/ZFg3DfVe/tFyfbHrl0Vzrztprh70edc6HMFq1T4O9nXoEqOMzuD8RfCIjA\r
29         5jMUdSP4wqgBvVYNS1BX4beMZrl6yuXFFnmj0HEIZBLuVg9NBrDyUVBeSO1izDq9SLEz\r
30         DUvK60fJ+zpQ4+0vVJoU4Dn/Oo5WbKJPRyU9gP0fuf5u/Hwodx9VBmkJsq3O/jf7mJvj\r
31         KW+FRuekQQgzmGzdYXJDT6/oVMdwxgYZ8F3/kqd+VetlYIEYF83cZKb2ym6YVnDGzkmU\r
32         oK0/ceXJ5K4OJMUL8kqm+NruMkdGAbholqS6vOmOvUtt3JNVyksWEW/ve1Wl7BEkY56P\r
33         eSGQ==\r
34 X-Received: by 10.68.244.169 with SMTP id xh9mr18520011pbc.52.1358643120704;\r
35         Sat, 19 Jan 2013 16:52:00 -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 i5sm6272238pax.13.2013.01.19.16.51.58\r
39         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
40         Sat, 19 Jan 2013 16:52:00 -0800 (PST)\r
41 From: Peter Wang <novalazy@gmail.com>\r
42 To: notmuch@notmuchmail.org\r
43 Subject: [PATCH v3 18/20] man: document 'insert' command\r
44 Date: Sun, 20 Jan 2013 11:50:02 +1100\r
45 Message-Id: <1358643004-14522-19-git-send-email-novalazy@gmail.com>\r
46 X-Mailer: git-send-email 1.7.12.1\r
47 In-Reply-To: <1358643004-14522-1-git-send-email-novalazy@gmail.com>\r
48 References: <1358643004-14522-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, 20 Jan 2013 00:52:21 -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 | 59 +++++++++++++++++++++++++++++++++++++++++++++++\r
67  2 files changed, 60 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..4a7cbeb\r
85 --- /dev/null\r
86 +++ b/man/man1/notmuch-insert.1\r
87 @@ -0,0 +1,59 @@\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 "[" 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, 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 +Option arguments must appear before any tag operation arguments.\r
115 +Supported options for\r
116 +.B insert\r
117 +include\r
118 +.RS 4\r
119 +.TP 4\r
120 +.BI "--folder=<" folder ">"\r
121 +\r
122 +Deliver the message to the specified folder,\r
123 +relative to the top-level directory given by the value of\r
124 +\fBdatabase.path\fR.\r
125 +The default is to deliver to the top-level directory.\r
126 +\r
127 +.RE\r
128 +\r
129 +.RS 4\r
130 +.TP 4\r
131 +.B "--create-folder"\r
132 +\r
133 +Try to create the folder named by the\r
134 +.B "--folder"\r
135 +option, if it does not exist.\r
136 +Otherwise the folder must already exist for mail\r
137 +delivery to succeed.\r
138 +\r
139 +.RE\r
140 +.SH SEE ALSO\r
141 +\r
142 +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
143 +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),\r
144 +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),\r
145 +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),\r
146 +\fBnotmuch-tag\fR(1)\r
147 -- \r
148 1.7.12.1\r
149 \r