Re: [PATCH] emacs: wash: make word-wrap bound message width

[notmuch-archives.git] / 46 / 3c0b3d180423cbb12d5bc91c928c0c7034bc85

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 B3D23431FC2\r
        for <notmuch@notmuchmail.org>; Fri, 21 Dec 2012 05:08:52 -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 QQIg0jpmlh1Z for <notmuch@notmuchmail.org>;\r
        Fri, 21 Dec 2012 05:08:50 -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 C613A431FDB\r
        for <notmuch@notmuchmail.org>; Fri, 21 Dec 2012 05:08:40 -0800 (PST)\r
Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net\r
        ([156.34.82.78] 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 1Tm2L8-0005dm-3e; Fri, 21 Dec 2012 09:08:38 -0400\r
Received: from bremner by zancas.localnet with local (Exim 4.80)\r
        (envelope-from <bremner@tethera.net>)\r
        id 1Tm2L2-0005zv-Jh; Fri, 21 Dec 2012 09:08:32 -0400\r
From: david@tethera.net\r
To: notmuch@notmuchmail.org\r
Subject: [Patch v8 16/18] man: document notmuch tag --batch, --input options\r
Date: Fri, 21 Dec 2012 09:08:25 -0400\r
Message-Id: <1356095307-22895-16-git-send-email-david@tethera.net>\r
X-Mailer: git-send-email 1.7.10.4\r
In-Reply-To: <1356095307-22895-1-git-send-email-david@tethera.net>\r
References: <1356095307-22895-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: Fri, 21 Dec 2012 13:08:53 -0000\r
\r
From: Jani Nikula <jani@nikula.org>\r
\r
---\r
 man/man1/notmuch-tag.1 |   76 ++++++++++++++++++++++++++++++++++++++++++++++++\r
 1 file changed, 76 insertions(+)\r
\r
diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1\r
index 9444aa4..2459740 100644\r
--- a/man/man1/notmuch-tag.1\r
+++ b/man/man1/notmuch-tag.1\r
@@ -6,6 +6,11 @@ notmuch-tag \- add/remove tags for all messages matching the search terms\r
 .B notmuch tag\r
 .RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-term "> [...]"\r
 \r
+.B notmuch tag\r
+.RI "--batch"\r
+.RI "[ --input=<" filename "> ]"\r
+\r
+\r
 .SH DESCRIPTION\r
 \r
 Add/remove tags for all messages matching the search terms.\r
@@ -30,6 +35,77 @@ 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 a file (stdin by default). 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 "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-term "> [...]"\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\r
+.RI < tag >\r
+and\r
+.RI < search-term >\r
+.B may\r
+be hex-encoded with %NN where NN is the hexadecimal value of the\r
+character. To hex-encode a character with a multi-byte UTF-8 encoding,\r
+hex-encode each byte.\r
+Any spaces in <tag> and <search-term>\r
+.B must\r
+be hex-encoded as %20.  The ':' indicating a prefix like 'id:' or 'tag:',\r
+the '*' wildcard for all messages, and any characters that are not\r
+part of\r
+.RI  < tag >\r
+or\r
+.RI < search-term >\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
+.SS EXAMPLE\r
+\r
+The following shows a valid input to batch tagging.\r
+\r
+.RS\r
+.nf\r
++winner *\r
++foo::bar -- One\r
++found::it -- tag:foo::bar\r
+# ignore this line and the next\r
+\r
++space%20in%20tags -- Two\r
++crazy( +tags\ +&are +#possible -- tag:space%20in%20tags\r
++match*crazy -- tag:crazy(\r
+.fi\r
+.RE\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