From: david@tethera.net
To: notmuch@notmuchmail.org
Subject: [Patch v8 16/18] man: document notmuch tag --batch, --input options
Date: Fri, 21 Dec 2012 09:08:25 -0400 [thread overview]
Message-ID: <1356095307-22895-16-git-send-email-david@tethera.net> (raw)
In-Reply-To: <1356095307-22895-1-git-send-email-david@tethera.net>
From: Jani Nikula <jani@nikula.org>
---
man/man1/notmuch-tag.1 | 76 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 76 insertions(+)
diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1
index 9444aa4..2459740 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,77 @@ 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=" <filename>
+
+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 <tag> and <search-term>
+.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.
+
+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.
+
+.RS
+.nf
++winner *
++foo::bar -- One
++found::it -- tag:foo::bar
+# ignore this line and the next
+
++space%20in%20tags -- Two
++crazy( +tags\ +&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
next prev parent reply other threads:[~2012-12-21 13:08 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-12-21 13:08 [Patch v8 01/18] parse_tag_line: use enum for return value david
2012-12-21 13:08 ` [Patch v8 02/18] tag-util: factor out rules for illegal tags, use in parse_tag_line david
2012-12-21 13:08 ` [Patch v8 03/18] notmuch-tag.c: convert to use tag-utils david
2012-12-21 13:08 ` [Patch v8 04/18] notmuch-tag: factor out double quoting routine david
2012-12-21 13:08 ` [Patch v8 05/18] util/string-util: add strnspn david
2012-12-21 13:08 ` [Patch v8 06/18] util/hex-escape: add a function to check strings unchanged by hex encoding david
2012-12-21 13:08 ` [Patch v8 07/18] unhex_and_quote: new function to quote hex-decoded queries david
2012-12-22 23:36 ` Jani Nikula
2012-12-23 2:59 ` [PATCH] simplify unhex_and_quote david
2012-12-23 8:19 ` Mark Walters
2012-12-21 13:08 ` [Patch v8 08/18] notmuch-restore: move query handling for batch restore to parser david
2012-12-21 13:08 ` [Patch v8 09/18] cli: add support for batch tagging operations to "notmuch tag" david
2012-12-22 22:51 ` Jani Nikula
2012-12-21 13:08 ` [Patch v8 10/18] test/tagging: add test for error messages of tag --batch david
2012-12-21 13:08 ` [Patch v8 11/18] test/tagging: add basic tests for batch tagging functionality david
2012-12-21 13:08 ` [Patch v8 12/18] test/tagging: add tests for exotic tags david
2012-12-21 13:08 ` [Patch v8 13/18] test/tagging: add test for exotic message-ids and batch tagging david
2012-12-21 13:08 ` [Patch v8 14/18] test/tagging: add test for compound queries with " david
2012-12-21 13:08 ` [Patch v8 15/18] notmuch-tag.1: tidy synopsis formatting, reference david
2012-12-21 13:08 ` david [this message]
2012-12-21 13:08 ` [Patch v8 17/18] test/tagging: add test for naked punctuation in tags; compare with quoting spaces david
2012-12-21 13:08 ` [Patch v8 18/18] more man fixup david
2012-12-21 13:29 ` [Patch v8 01/18] parse_tag_line: use enum for return value David Bremner
2012-12-22 23:47 ` Jani Nikula
2012-12-22 21:48 ` Jani Nikula
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1356095307-22895-16-git-send-email-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).