Re: [feature request] emacs: use `notmuch insert` for FCC
[notmuch-archives.git] / bc / 0c6eb202b23ff7e239223bb9f4f086d746f0d2
1 Return-Path: <m.walters@qmul.ac.uk>\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 3C424431FB6\r
6         for <notmuch@notmuchmail.org>; Sun, 18 Nov 2012 09:13:42 -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: -1.098\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
12         tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
13         NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 lajPfCizhmN4 for <notmuch@notmuchmail.org>;\r
17         Sun, 18 Nov 2012 09:13:41 -0800 (PST)\r
18 Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
20         (No client certificate requested)\r
21         by olra.theworths.org (Postfix) with ESMTPS id 47922431FAF\r
22         for <notmuch@notmuchmail.org>; Sun, 18 Nov 2012 09:13:41 -0800 (PST)\r
23 Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
24         by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
25         (envelope-from <m.walters@qmul.ac.uk>)\r
26         id 1Ta8R9-0008RP-HW; Sun, 18 Nov 2012 17:13:40 +0000\r
27 Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
28         by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
29         (envelope-from <m.walters@qmul.ac.uk>)\r
30         id 1Ta8R9-0003aa-64; Sun, 18 Nov 2012 17:13:39 +0000\r
31 From: Mark Walters <markwalters1009@gmail.com>\r
32 To: Peter Wang <novalazy@gmail.com>, notmuch@notmuchmail.org\r
33 Subject: Re: [PATCH 14/18] man: document 'insert' command\r
34 In-Reply-To: <1343223767-9812-14-git-send-email-novalazy@gmail.com>\r
35 References: <1343223767-9812-1-git-send-email-novalazy@gmail.com>\r
36         <1343223767-9812-14-git-send-email-novalazy@gmail.com>\r
37 User-Agent: Notmuch/0.14+81~g9730584 (http://notmuchmail.org) Emacs/23.4.1\r
38         (x86_64-pc-linux-gnu)\r
39 Date: Sun, 18 Nov 2012 17:13:38 +0000\r
40 Message-ID: <87obiuq1fh.fsf@qmul.ac.uk>\r
41 MIME-Version: 1.0\r
42 Content-Type: text/plain; charset=us-ascii\r
43 X-Sender-Host-Address: 93.97.24.31\r
44 X-QM-SPAM-Info: Sender has good ham record.  :)\r
45 X-QM-Body-MD5: 3908b197edef21d25ad5cc13265f9c78 (of first 20000 bytes)\r
46 X-SpamAssassin-Score: -1.8\r
47 X-SpamAssassin-SpamBar: -\r
48 X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
49         determine if it is\r
50         spam. We require at least 5.0 points to mark a message as spam.\r
51         This message scored -1.8 points.\r
52         Summary of the scoring: \r
53         * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
54         *      medium trust\r
55         *      [138.37.6.40 listed in list.dnswl.org]\r
56         * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
57         provider *      (markwalters1009[at]gmail.com)\r
58         *  0.5 AWL AWL: From: address is in the auto white-list\r
59 X-QM-Scan-Virus: ClamAV says the message is clean\r
60 X-BeenThere: notmuch@notmuchmail.org\r
61 X-Mailman-Version: 2.1.13\r
62 Precedence: list\r
63 List-Id: "Use and development of the notmuch mail system."\r
64         <notmuch.notmuchmail.org>\r
65 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
66         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
67 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
68 List-Post: <mailto:notmuch@notmuchmail.org>\r
69 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
70 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
71         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
72 X-List-Received-Date: Sun, 18 Nov 2012 17:13:42 -0000\r
73 \r
74 On Wed, 25 Jul 2012, Peter Wang <novalazy@gmail.com> wrote:\r
75 > Add initial documentation for notmuch insert command.\r
76 > ---\r
77 >  man/Makefile.local        |    1 +\r
78 >  man/man1/notmuch-insert.1 |   50 +++++++++++++++++++++++++++++++++++++++++++++\r
79 >  2 files changed, 51 insertions(+), 0 deletions(-)\r
80 >  create mode 100644 man/man1/notmuch-insert.1\r
81 >\r
82 > diff --git a/man/Makefile.local b/man/Makefile.local\r
83 > index d43a949..f91bfd4 100644\r
84 > --- a/man/Makefile.local\r
85 > +++ b/man/Makefile.local\r
86 > @@ -12,6 +12,7 @@ MAN1 := \\r
87 >       $(dir)/man1/notmuch-count.1 \\r
88 >       $(dir)/man1/notmuch-dump.1 \\r
89 >       $(dir)/man1/notmuch-restore.1 \\r
90 > +     $(dir)/man1/notmuch-insert.1 \\r
91 >       $(dir)/man1/notmuch-new.1 \\r
92 >       $(dir)/man1/notmuch-reply.1 \\r
93 >       $(dir)/man1/notmuch-search.1 \\r
94 > diff --git a/man/man1/notmuch-insert.1 b/man/man1/notmuch-insert.1\r
95 > new file mode 100644\r
96 > index 0000000..7d281b5\r
97 > --- /dev/null\r
98 > +++ b/man/man1/notmuch-insert.1\r
99 > @@ -0,0 +1,50 @@\r
100 > +.TH NOTMUCH-INSERT 1 2012-xx-xx "Notmuch 0.xx"\r
101 > +.SH NAME\r
102 > +notmuch-insert \- add a message to the maildir and notmuch database\r
103 > +.SH SYNOPSIS\r
104 > +\r
105 > +.B notmuch insert\r
106 > +.RI "[" options "]"\r
107 > +.RI "--"\r
108 > +.RI "[ +<" tag> "|\-<" tag "> ... ]"\r
109 > +\r
110 > +.SH DESCRIPTION\r
111 > +\r
112 > +.B notmuch insert\r
113 > +reads a message from standard input and delivers it to the specified\r
114 > +maildir folder, then incorporates the message into the notmuch\r
115 > +database.  It is an alternative to using a separate tool to deliver\r
116 > +the message then running\r
117 > +.B notmuch new\r
118 > +afterwards.\r
119 > +\r
120 > +The new message will be tagged with the tags specified by the\r
121 > +.B new.tags\r
122 > +configuration option.\r
123 > +Additional tagging operations may be specified on the command-line.\r
124 > +Tags prefixed by '+' are added while those prefixed by '\-' are\r
125 > +removed.  notmuch will warn about ambiguous tag removal arguments\r
126 > +which may be confused with option arguments.  It is recommended to use\r
127 > +the option list terminator "--" to avoid ambiguity.\r
128 > +\r
129 > +Supported options for\r
130 > +.B insert\r
131 > +include\r
132 > +.RS 4\r
133 > +.TP 4\r
134 > +.BI "--folder=<" folder ">"\r
135 > +\r
136 > +Deliver the message to the\r
137 > +.RI Maildir/ folder\r
138 > +directory, which must already exist.\r
139 > +The default is to deliver to the top-level directory.\r
140 \r
141 I think this should say something about notmuch database root: so that\r
142 by default it delivers to the top-level directory of the notmuch\r
143 database, and otherwise is relative to that. Maybe just replace Maildir\r
144 by something like "<notmuch-database-root>" or something?\r
145 \r
146 Best wishes\r
147 \r
148 Mark\r
149 \r
150 \r
151 \r
152 > +\r
153 > +.RE\r
154 > +.RE\r
155 > +.SH SEE ALSO\r
156 > +\r
157 > +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
158 > +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-reply\fR(1),\r
159 > +\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),\r
160 > +\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),\r
161 > +\fBnotmuch-tag\fR(1)\r
162 > -- \r
163 > 1.7.4.4\r
164 >\r
165 > _______________________________________________\r
166 > notmuch mailing list\r
167 > notmuch@notmuchmail.org\r
168 > http://notmuchmail.org/mailman/listinfo/notmuch\r