From: Jani Nikula Date: Sun, 2 Dec 2012 13:21:51 +0000 (+0200) Subject: Re: [Patch v2 12/17] man: document notmuch tag --batch, --input options X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=621ddcdddd64846d0e296d938baf040ae2e2e20e;p=notmuch-archives.git Re: [Patch v2 12/17] man: document notmuch tag --batch, --input options --- diff --git a/a3/10069aad6adecede2bdc796e36786df1b9c489 b/a3/10069aad6adecede2bdc796e36786df1b9c489 new file mode 100644 index 000000000..d2b38d79c --- /dev/null +++ b/a3/10069aad6adecede2bdc796e36786df1b9c489 @@ -0,0 +1,160 @@ +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 252C7431FAF + for ; Sun, 2 Dec 2012 05:22:02 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 vYsMDR6N7BAK for ; + Sun, 2 Dec 2012 05:21:57 -0800 (PST) +Received: from mail-la0-f53.google.com (mail-la0-f53.google.com + [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 7ED2A431FAE + for ; Sun, 2 Dec 2012 05:21:57 -0800 (PST) +Received: by mail-la0-f53.google.com with SMTP id w12so1639843lag.26 + for ; Sun, 02 Dec 2012 05:21:54 -0800 (PST) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=google.com; s=20120113; + h=from:to:subject:in-reply-to:references:user-agent:date:message-id + :mime-version:content-type:x-gm-message-state; + bh=11uQ54r1cpfNUCO1Mlvw9TcOisMtCt2OqBRmZZ7u8jw=; + b=Q9Z5fpL6uLsAJ3SJ3fKOOHYEWvFrzkO+trlODOxuXYznWeOsKZXf5iXfAJBBT9im3c + aqljaV1MXoDVosABquGb+LnyWwKvpL94o7hrmC1i6S5os7yihujKMxAi3aWMYCDfPunM + 0TmDQ818u/dH7GqcL0GvkT4ldoVaFasxEn9gR9wG2PgjS5anAae8DuM0h85nwz7B0i4S + l7VI06h7QEEFYs0WSTR3QVV8FUiD8fBrmlN9+9RP+F3vXOpT3NHZuPM28RWUwO4xKtcu + 6WnxRHZYU4feAVJ5Wf8uf4haJoLRecyAZBoYn3sTqcRwXKFlvoi5Lp8yRp+inDwJh5tG + KO4A== +Received: by 10.112.88.7 with SMTP id bc7mr1143102lbb.108.1354454514081; + Sun, 02 Dec 2012 05:21:54 -0800 (PST) +Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi. + [80.223.81.27]) + by mx.google.com with ESMTPS id fb1sm4132562lbb.15.2012.12.02.05.21.52 + (version=SSLv3 cipher=OTHER); Sun, 02 Dec 2012 05:21:53 -0800 (PST) +From: Jani Nikula +To: david@tethera.net, notmuch@notmuchmail.org +Subject: Re: [Patch v2 12/17] man: document notmuch tag --batch, + --input options +In-Reply-To: <1353792017-31459-13-git-send-email-david@tethera.net> +References: <1353792017-31459-1-git-send-email-david@tethera.net> + <1353792017-31459-13-git-send-email-david@tethera.net> +User-Agent: Notmuch/0.14+124~g3b17402 (http://notmuchmail.org) Emacs/23.4.1 + (i686-pc-linux-gnu) +Date: Sun, 02 Dec 2012 15:21:51 +0200 +Message-ID: <871uf8egi8.fsf@nikula.org> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Gm-Message-State: + ALoCoQnfGw6hJ0J1/ncrhKxRhmLOA0Mc5Jr2s72I3cF87cOP4wZ2OtNAwLprGsh/NrigJSmp3nnW +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: Sun, 02 Dec 2012 13:22:02 -0000 + +On Sat, 24 Nov 2012, david@tethera.net wrote: +> 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 ">" + +I think we should replace "" with " [...]", +and ditch the plural below... + +> + +> +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 + +...so it would make the above description more accurately depict +reality. We don't care about hex encoding spaces between individual +search terms. + +BR, +Jani. + +> +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