[PATCH 15/16] man: document notmuch tag --batch, --input options
From: Jani Nikula --- man/man1/notmuch-tag.1 | 52 +++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1 index 0f86582..751db7b 100644 --- a/man/man1/notmuch-tag.1 +++ b/man/man1/notmuch-tag.1 @@ -4,7 +4,12 @@ notmuch-tag \- add/remove tags for all messages matching the search terms .SH SYNOPSIS .B notmuch tag -.RI "+<" tag> "|\-<" tag "> [...] [\-\-] <" search-term ">..." +.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">" + +.B notmuch tag +.RI "--batch" +.RI "[ --input=<" filename "> ]" + .SH DESCRIPTION @@ -29,6 +34,51 @@ 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 standard input. 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 "T +<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">" + +Each line is interpreted similarly to +.B notmuch tag +command line arguments. The delimiter is one or more spaces ' '. Any +characters in and +.B may +be hex encoded with %NN where NN is the hexadecimal value of the +character. Any ' ' and '%' characters in and +.B must +be hex encoded (using %20 and %25, respectively). Any characters that +are not part of or +.B must not +be hex encoded. + +Leading and trailing space ' ' is ignored. Empty lines and lines +beginning with '#' are ignored. + .SH SEE ALSO \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), -- 1.7.10.4 ___ notmuch mailing list notmuch@notmuchmail.org http://notmuchmail.org/mailman/listinfo/notmuch
[PATCH 15/16] man: document notmuch tag --batch, --input options
From: Jani Nikula --- man/man1/notmuch-tag.1 | 52 +++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1 index 0f86582..751db7b 100644 --- a/man/man1/notmuch-tag.1 +++ b/man/man1/notmuch-tag.1 @@ -4,7 +4,12 @@ notmuch-tag \- add/remove tags for all messages matching the search terms .SH SYNOPSIS .B notmuch tag -.RI "+<" tag> "|\-<" tag "> [...] [\-\-] <" search-term ">..." +.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">" + +.B notmuch tag +.RI "--batch" +.RI "[ --input=<" filename "> ]" + .SH DESCRIPTION @@ -29,6 +34,51 @@ 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 standard input. 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 "T +<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">" + +Each line is interpreted similarly to +.B notmuch tag +command line arguments. The delimiter is one or more spaces ' '. Any +characters in and +.B may +be hex encoded with %NN where NN is the hexadecimal value of the +character. Any ' ' and '%' characters in and +.B must +be hex encoded (using %20 and %25, respectively). Any characters that +are not part of or +.B must not +be hex encoded. + +Leading and trailing space ' ' is ignored. Empty lines and lines +beginning with '#' are ignored. + .SH SEE ALSO \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), -- 1.7.10.4