[Patch v2 12/17] man: document notmuch tag --batch, --input options
authordavid <david@tethera.net>
Sat, 24 Nov 2012 21:20:12 +0000 (17:20 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:50:51 +0000 (09:50 -0800)
de/42502edc04386e5b71f4eaae31c6ec53df3c9f [new file with mode: 0644]

diff --git a/de/42502edc04386e5b71f4eaae31c6ec53df3c9f b/de/42502edc04386e5b71f4eaae31c6ec53df3c9f
new file mode 100644 (file)
index 0000000..981e71a
--- /dev/null
@@ -0,0 +1,132 @@
+Return-Path: <bremner@tethera.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id C3703431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 13:20:48 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id HsKOsfgvZFGZ for <notmuch@notmuchmail.org>;\r
+       Sat, 24 Nov 2012 13:20:47 -0800 (PST)\r
+Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238])\r
+       (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 4597F431E82\r
+       for <notmuch@notmuchmail.org>; Sat, 24 Nov 2012 13:20:34 -0800 (PST)\r
+Received: from fctnnbsc30w-156034089108.dhcp-dynamic.fibreop.nb.bellaliant.net\r
+       ([156.34.89.108] helo=zancas.localnet)\r
+       by tesseract.cs.unb.ca with esmtpsa\r
+       (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1TcN9M-0006SS-UV; Sat, 24 Nov 2012 17:20:33 -0400\r
+Received: from bremner by zancas.localnet with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1TcN9H-0008DI-HM; Sat, 24 Nov 2012 17:20:27 -0400\r
+From: david@tethera.net\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v2 12/17] man: document notmuch tag --batch, --input options\r
+Date: Sat, 24 Nov 2012 17:20:12 -0400\r
+Message-Id: <1353792017-31459-13-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1353792017-31459-1-git-send-email-david@tethera.net>\r
+References: <1353792017-31459-1-git-send-email-david@tethera.net>\r
+X-Spam_bar: -\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 24 Nov 2012 21:20:49 -0000\r
+\r
+From: Jani Nikula <jani@nikula.org>\r
+\r
+---\r
+ man/man1/notmuch-tag.1 |   52 +++++++++++++++++++++++++++++++++++++++++++++++-\r
+ 1 file changed, 51 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1\r
+index 0f86582..751db7b 100644\r
+--- a/man/man1/notmuch-tag.1\r
++++ b/man/man1/notmuch-tag.1\r
+@@ -4,7 +4,12 @@ notmuch-tag \- add/remove tags for all messages matching the search terms\r
\r
+ .SH SYNOPSIS\r
+ .B notmuch tag\r
+-.RI  "+<" tag> "|\-<" tag "> [...] [\-\-] <" search-term ">..."\r
++.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">"\r
++\r
++.B notmuch tag\r
++.RI "--batch"\r
++.RI "[ --input=<" filename "> ]"\r
++\r
\r
+ .SH DESCRIPTION\r
\r
+@@ -29,6 +34,51 @@ updates the maildir flags according to tag changes if the\r
+ configuration option is enabled. See \fBnotmuch-config\fR(1) for\r
+ details.\r
\r
++Supported options for\r
++.B tag\r
++include\r
++.RS 4\r
++.TP 4\r
++.BR \-\-batch\r
++\r
++Read batch tagging operations from standard input. This is more\r
++efficient than repeated\r
++.B notmuch tag\r
++invocations. See\r
++.B TAG FILE FORMAT\r
++below for the input format. This option is not compatible with\r
++specifying tagging on the command line.\r
++.RE\r
++\r
++.RS 4\r
++.TP 4\r
++.BR "\-\-input=" <filename>\r
++\r
++Read input from given file, instead of from stdin. Implies\r
++.BR --batch .\r
++\r
++.SH TAG FILE FORMAT\r
++\r
++The input must consist of lines of the format:\r
++\r
++.RI "T +<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">"\r
++\r
++Each line is interpreted similarly to\r
++.B notmuch tag\r
++command line arguments. The delimiter is one or more spaces ' '. Any\r
++characters in <tag> and <search-terms>\r
++.B may\r
++be hex encoded with %NN where NN is the hexadecimal value of the\r
++character. Any ' ' and '%' characters in <tag> and <search-terms>\r
++.B must\r
++be hex encoded (using %20 and %25, respectively). Any characters that\r
++are not part of <tag> or <search-terms>\r
++.B must not\r
++be hex encoded.\r
++\r
++Leading and trailing space ' ' is ignored. Empty lines and lines\r
++beginning with '#' are ignored.\r
++\r
+ .SH SEE ALSO\r
\r
+ \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
+-- \r
+1.7.10.4\r
+\r