Re: [Patch v2 12/17] man: document notmuch tag --batch, --input options
authorJani Nikula <jani@nikula.org>
Sun, 2 Dec 2012 13:21:51 +0000 (15:21 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:51:19 +0000 (09:51 -0800)
a3/10069aad6adecede2bdc796e36786df1b9c489 [new file with mode: 0644]

diff --git a/a3/10069aad6adecede2bdc796e36786df1b9c489 b/a3/10069aad6adecede2bdc796e36786df1b9c489
new file mode 100644 (file)
index 0000000..d2b38d7
--- /dev/null
@@ -0,0 +1,160 @@
+Return-Path: <jani@nikula.org>\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 252C7431FAF\r
+       for <notmuch@notmuchmail.org>; Sun,  2 Dec 2012 05:22:02 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 vYsMDR6N7BAK for <notmuch@notmuchmail.org>;\r
+       Sun,  2 Dec 2012 05:21:57 -0800 (PST)\r
+Received: from mail-la0-f53.google.com (mail-la0-f53.google.com\r
+       [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 7ED2A431FAE\r
+       for <notmuch@notmuchmail.org>; Sun,  2 Dec 2012 05:21:57 -0800 (PST)\r
+Received: by mail-la0-f53.google.com with SMTP id w12so1639843lag.26\r
+       for <notmuch@notmuchmail.org>; Sun, 02 Dec 2012 05:21:54 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:subject:in-reply-to:references:user-agent:date:message-id\r
+       :mime-version:content-type:x-gm-message-state;\r
+       bh=11uQ54r1cpfNUCO1Mlvw9TcOisMtCt2OqBRmZZ7u8jw=;\r
+       b=Q9Z5fpL6uLsAJ3SJ3fKOOHYEWvFrzkO+trlODOxuXYznWeOsKZXf5iXfAJBBT9im3c\r
+       aqljaV1MXoDVosABquGb+LnyWwKvpL94o7hrmC1i6S5os7yihujKMxAi3aWMYCDfPunM\r
+       0TmDQ818u/dH7GqcL0GvkT4ldoVaFasxEn9gR9wG2PgjS5anAae8DuM0h85nwz7B0i4S\r
+       l7VI06h7QEEFYs0WSTR3QVV8FUiD8fBrmlN9+9RP+F3vXOpT3NHZuPM28RWUwO4xKtcu\r
+       6WnxRHZYU4feAVJ5Wf8uf4haJoLRecyAZBoYn3sTqcRwXKFlvoi5Lp8yRp+inDwJh5tG\r
+       KO4A==\r
+Received: by 10.112.88.7 with SMTP id bc7mr1143102lbb.108.1354454514081;\r
+       Sun, 02 Dec 2012 05:21:54 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi.\r
+       [80.223.81.27])\r
+       by mx.google.com with ESMTPS id fb1sm4132562lbb.15.2012.12.02.05.21.52\r
+       (version=SSLv3 cipher=OTHER); Sun, 02 Dec 2012 05:21:53 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: david@tethera.net, notmuch@notmuchmail.org\r
+Subject: Re: [Patch v2 12/17] man: document notmuch tag --batch,\r
+       --input options\r
+In-Reply-To: <1353792017-31459-13-git-send-email-david@tethera.net>\r
+References: <1353792017-31459-1-git-send-email-david@tethera.net>\r
+       <1353792017-31459-13-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.14+124~g3b17402 (http://notmuchmail.org) Emacs/23.4.1\r
+       (i686-pc-linux-gnu)\r
+Date: Sun, 02 Dec 2012 15:21:51 +0200\r
+Message-ID: <871uf8egi8.fsf@nikula.org>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Gm-Message-State:\r
+ ALoCoQnfGw6hJ0J1/ncrhKxRhmLOA0Mc5Jr2s72I3cF87cOP4wZ2OtNAwLprGsh/NrigJSmp3nnW\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: Sun, 02 Dec 2012 13:22:02 -0000\r
+\r
+On Sat, 24 Nov 2012, david@tethera.net wrote:\r
+> From: Jani Nikula <jani@nikula.org>\r
+>\r
+> ---\r
+>  man/man1/notmuch-tag.1 |   52 +++++++++++++++++++++++++++++++++++++++++++++++-\r
+>  1 file changed, 51 insertions(+), 1 deletion(-)\r
+>\r
+> diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1\r
+> index 0f86582..751db7b 100644\r
+> --- a/man/man1/notmuch-tag.1\r
+> +++ b/man/man1/notmuch-tag.1\r
+> @@ -4,7 +4,12 @@ notmuch-tag \- add/remove tags for all messages matching the search terms\r
+>  \r
+>  .SH SYNOPSIS\r
+>  .B notmuch tag\r
+> -.RI  "+<" tag> "|\-<" tag "> [...] [\-\-] <" search-term ">..."\r
+> +.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">"\r
+> +\r
+> +.B notmuch tag\r
+> +.RI "--batch"\r
+> +.RI "[ --input=<" filename "> ]"\r
+> +\r
+>  \r
+>  .SH DESCRIPTION\r
+>  \r
+> @@ -29,6 +34,51 @@ 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 standard input. 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 "T +<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">"\r
+\r
+I think we should replace "<search-terms>" with "<search-term> [...]",\r
+and ditch the plural below...\r
+\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 <tag> and <search-terms>\r
+> +.B may\r
+> +be hex encoded with %NN where NN is the hexadecimal value of the\r
+> +character. Any ' ' and '%' characters in <tag> and <search-terms>\r
+> +.B must\r
+> +be hex encoded (using %20 and %25, respectively). Any characters that\r
+\r
+...so it would make the above description more accurately depict\r
+reality. We don't care about hex encoding spaces between individual\r
+search terms.\r
+\r
+BR,\r
+Jani.\r
+\r
+> +are not part of <tag> or <search-terms>\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
+>  .SH SEE ALSO\r
+>  \r
+>  \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
+> -- \r
+> 1.7.10.4\r