From 86747b8da75be8b3cbe61210442d2a676fd6407f Mon Sep 17 00:00:00 2001 From: david Date: Mon, 24 Dec 2012 21:39:41 +2000 Subject: [PATCH] [Patch v9 15/17] man: document notmuch tag --batch, --input options --- ff/5b656bb8941699df48d99ecd7eeb7487e24c6d | 159 ++++++++++++++++++++++ 1 file changed, 159 insertions(+) create mode 100644 ff/5b656bb8941699df48d99ecd7eeb7487e24c6d diff --git a/ff/5b656bb8941699df48d99ecd7eeb7487e24c6d b/ff/5b656bb8941699df48d99ecd7eeb7487e24c6d new file mode 100644 index 000000000..af2232ef5 --- /dev/null +++ b/ff/5b656bb8941699df48d99ecd7eeb7487e24c6d @@ -0,0 +1,159 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 7D635431FC0 + for ; Sun, 23 Dec 2012 17:40:17 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id QTAisPmmIefy for ; + Sun, 23 Dec 2012 17:40:16 -0800 (PST) +Received: from tesseract.cs.unb.ca (tesseract.cs.unb.ca [131.202.240.238]) + (using TLSv1 with cipher AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id E0830431FD7 + for ; Sun, 23 Dec 2012 17:40:02 -0800 (PST) +Received: from fctnnbsc30w-156034082078.dhcp-dynamic.fibreop.nb.bellaliant.net + ([156.34.82.78] helo=zancas.localnet) + by tesseract.cs.unb.ca with esmtpsa + (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) + (envelope-from ) + id 1Tmx1N-0008Ky-SN; Sun, 23 Dec 2012 21:40:02 -0400 +Received: from bremner by zancas.localnet with local (Exim 4.80) + (envelope-from ) + id 1Tmx1I-0002oT-Bv; Sun, 23 Dec 2012 21:39:56 -0400 +From: david@tethera.net +To: notmuch@notmuchmail.org +Subject: [Patch v9 15/17] man: document notmuch tag --batch, --input options +Date: Sun, 23 Dec 2012 21:39:41 -0400 +Message-Id: <1356313183-9266-16-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: <1356313183-9266-1-git-send-email-david@tethera.net> +References: <1356313183-9266-1-git-send-email-david@tethera.net> +X-Spam_bar: - +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Mon, 24 Dec 2012 01:40:17 -0000 + +From: Jani Nikula + +--- + man/man1/notmuch-tag.1 | 79 ++++++++++++++++++++++++++++++++++++++++++++++++ + 1 file changed, 79 insertions(+) + +diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1 +index 9444aa4..19ccf7e 100644 +--- a/man/man1/notmuch-tag.1 ++++ b/man/man1/notmuch-tag.1 +@@ -6,6 +6,11 @@ notmuch-tag \- add/remove tags for all messages matching the search terms + .B notmuch tag + .RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-term "> [...]" + ++.B notmuch tag ++.RI "--batch" ++.RI "[ --input=<" filename "> ]" ++ ++ + .SH DESCRIPTION + + Add/remove tags for all messages matching the search terms. +@@ -30,6 +35,80 @@ updates the maildir flags according to tag changes if the + configuration option is enabled. See \fBnotmuch-config\fR(1) for + details. + ++Supported options for ++.B tag ++include ++.RS 4 ++.TP 4 ++.BR \-\-batch ++ ++Read batch tagging operations from a file (stdin by default). This is more ++efficient than repeated ++.B notmuch tag ++invocations. See ++.B TAG FILE FORMAT ++below for the input format. This option is not compatible with ++specifying tagging on the command line. ++.RE ++ ++.RS 4 ++.TP 4 ++.BR "\-\-input=" ++ ++Read input from given file, instead of from stdin. Implies ++.BR --batch . ++ ++.SH TAG FILE FORMAT ++ ++The input must consist of lines of the format: ++ ++.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-term "> [...]" ++ ++Each line is interpreted similarly to ++.B notmuch tag ++command line arguments. The delimiter is one or more spaces ' '. Any ++characters in ++.RI < tag > ++and ++.RI < search-term > ++.B may ++be hex-encoded with %NN where NN is the hexadecimal value of the ++character. To hex-encode a character with a multi-byte UTF-8 encoding, ++hex-encode each byte. ++Any spaces in and ++.B must ++be hex-encoded as %20. The ':' indicating a prefix like 'id:' or 'tag:', ++the '*' wildcard for all messages, and any characters that are not ++part of ++.RI < tag > ++or ++.RI < search-term > ++.B must not ++be hex-encoded. In particular parentheses used to bracket ++sub-expressions must not be encoded. ++ ++Leading and trailing space ' ' is ignored. Empty lines and lines ++beginning with '#' are ignored. ++ ++.SS EXAMPLE ++ ++The following shows a valid input to batch tagging. Note that only the ++isolated '*' acts as a wildcard. ++ ++.RS ++.nf +++winner * +++foo::bar -- (One and Two) or (One and tag:winner) +++found::it -- tag:foo::bar ++# ignore this line and the next ++ +++space%20in%20tags -- Two ++# hex encode tag '(tags)', among other stunts. +++crazy{ +%28tags%29 +&are +#possible\ -- tag:space%20in%20tags +++match*crazy -- tag:crazy{ ++.fi ++.RE ++ + .SH SEE ALSO + + \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +-- +1.7.10.4 + -- 2.26.2