[PATCH v2 6/6] man: document notmuch tag --stdin option
authorJani Nikula <jani@nikula.org>
Sat, 14 Apr 2012 12:15:31 +0000 (15:15 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:46:21 +0000 (09:46 -0800)
f9/c753636900db373720aa9863541f4a763076fe [new file with mode: 0644]

diff --git a/f9/c753636900db373720aa9863541f4a763076fe b/f9/c753636900db373720aa9863541f4a763076fe
new file mode 100644 (file)
index 0000000..4923bd2
--- /dev/null
@@ -0,0 +1,137 @@
+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 A3981429E28\r
+       for <notmuch@notmuchmail.org>; Sat, 14 Apr 2012 05:16:24 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\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 Cq1lOZiJ75Lt for <notmuch@notmuchmail.org>;\r
+       Sat, 14 Apr 2012 05:16:23 -0700 (PDT)\r
+Received: from mail-lpp01m010-f53.google.com (mail-lpp01m010-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 9E5D7431FD6\r
+       for <notmuch@notmuchmail.org>; Sat, 14 Apr 2012 05:16:00 -0700 (PDT)\r
+Received: by mail-lpp01m010-f53.google.com with SMTP id c1so3043779lah.26\r
+       for <notmuch@notmuchmail.org>; Sat, 14 Apr 2012 05:16:00 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references\r
+       :in-reply-to:references:x-gm-message-state;\r
+       bh=FT5S5LjPivguigI6i9a0sHE9gaModZ1raAl9XQanz1M=;\r
+       b=K8fZZf6zicqeanv7LhjLQLmCPDKPyPmsBuwbxOj+Kwn958tUAXFTROaolVBmIiESAk\r
+       bSZM4qValNQuSHud/69EJATzvPhxAKdbiYLUYApYhjhvKC37uZ+ZyMKMJCOZp9sjW+HE\r
+       Dw7UfkQ0PSgljV9VCXbevw4lgdoNINLB4L4i8MrFO5OlrHE1RMPeIvf7IKgndwdznCsk\r
+       DaEt0rPxllwwqHZBFKlwKUVmqwgwJgNgqcTNuCFosb3GyRwL8s5vVsdpqmyThwGiCYZg\r
+       hKl/6xEzdK2ul5qOrf2fBy0s8SO+WCLkabSc+rfLfRX+UNMvnzeGr1eVd7r/91VYQrpt\r
+       PzXA==\r
+Received: by 10.112.27.136 with SMTP id t8mr2231377lbg.89.1334405760232;\r
+       Sat, 14 Apr 2012 05:16:00 -0700 (PDT)\r
+Received: from localhost (dsl-hkibrasgw4-fe50dc00-68.dhcp.inet.fi.\r
+       [80.220.80.68])\r
+       by mx.google.com with ESMTPS id fe6sm16010016lbb.9.2012.04.14.05.15.58\r
+       (version=SSLv3 cipher=OTHER); Sat, 14 Apr 2012 05:15:59 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 6/6] man: document notmuch tag --stdin option\r
+Date: Sat, 14 Apr 2012 15:15:31 +0300\r
+Message-Id:\r
+ <98c21f1e37b89ee67b441c76825d5f91e4fb5d7d.1334404979.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.7.5.4\r
+In-Reply-To: <cover.1334404979.git.jani@nikula.org>\r
+References: <cover.1334404979.git.jani@nikula.org>\r
+In-Reply-To: <cover.1334404979.git.jani@nikula.org>\r
+References: <cover.1334404979.git.jani@nikula.org>\r
+X-Gm-Message-State:\r
+ ALoCoQmxRKSrbwwvuxXeT8z70gqOkE3UpRoGMczV+IN5bR/55cmFxeYUUeDWwvSC3PhAywXe3q45\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: Sat, 14 Apr 2012 12:16:25 -0000\r
+\r
+---\r
+ man/man1/notmuch-tag.1 |   44 +++++++++++++++++++++++++++++++++++++++++++-\r
+ 1 files changed, 43 insertions(+), 1 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1\r
+index aa4546e..30693cf 100644\r
+--- a/man/man1/notmuch-tag.1\r
++++ b/man/man1/notmuch-tag.1\r
+@@ -4,7 +4,11 @@ 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 "--stdin"\r
++\r
+ \r
+ .SH DESCRIPTION\r
+ \r
+@@ -29,6 +33,44 @@ 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 \-\-stdin\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
++.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
++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
++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.5.4\r
+\r