Re: [PATCH] emacs: remove hardcoded defaults values from docstrings
[notmuch-archives.git] / f9 / c753636900db373720aa9863541f4a763076fe
1 Return-Path: <jani@nikula.org>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5         by olra.theworths.org (Postfix) with ESMTP id A3981429E28\r
6         for <notmuch@notmuchmail.org>; Sat, 14 Apr 2012 05:16:24 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
9 X-Spam-Flag: NO\r
10 X-Spam-Score: -0.7\r
11 X-Spam-Level: \r
12 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
13         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
14 Received: from olra.theworths.org ([127.0.0.1])\r
15         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
16         with ESMTP id Cq1lOZiJ75Lt for <notmuch@notmuchmail.org>;\r
17         Sat, 14 Apr 2012 05:16:23 -0700 (PDT)\r
18 Received: from mail-lpp01m010-f53.google.com (mail-lpp01m010-f53.google.com\r
19         [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
20         (No client certificate requested)\r
21         by olra.theworths.org (Postfix) with ESMTPS id 9E5D7431FD6\r
22         for <notmuch@notmuchmail.org>; Sat, 14 Apr 2012 05:16:00 -0700 (PDT)\r
23 Received: by mail-lpp01m010-f53.google.com with SMTP id c1so3043779lah.26\r
24         for <notmuch@notmuchmail.org>; Sat, 14 Apr 2012 05:16:00 -0700 (PDT)\r
25 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
26         d=google.com; s=20120113;\r
27         h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references\r
28         :in-reply-to:references:x-gm-message-state;\r
29         bh=FT5S5LjPivguigI6i9a0sHE9gaModZ1raAl9XQanz1M=;\r
30         b=K8fZZf6zicqeanv7LhjLQLmCPDKPyPmsBuwbxOj+Kwn958tUAXFTROaolVBmIiESAk\r
31         bSZM4qValNQuSHud/69EJATzvPhxAKdbiYLUYApYhjhvKC37uZ+ZyMKMJCOZp9sjW+HE\r
32         Dw7UfkQ0PSgljV9VCXbevw4lgdoNINLB4L4i8MrFO5OlrHE1RMPeIvf7IKgndwdznCsk\r
33         DaEt0rPxllwwqHZBFKlwKUVmqwgwJgNgqcTNuCFosb3GyRwL8s5vVsdpqmyThwGiCYZg\r
34         hKl/6xEzdK2ul5qOrf2fBy0s8SO+WCLkabSc+rfLfRX+UNMvnzeGr1eVd7r/91VYQrpt\r
35         PzXA==\r
36 Received: by 10.112.27.136 with SMTP id t8mr2231377lbg.89.1334405760232;\r
37         Sat, 14 Apr 2012 05:16:00 -0700 (PDT)\r
38 Received: from localhost (dsl-hkibrasgw4-fe50dc00-68.dhcp.inet.fi.\r
39         [80.220.80.68])\r
40         by mx.google.com with ESMTPS id fe6sm16010016lbb.9.2012.04.14.05.15.58\r
41         (version=SSLv3 cipher=OTHER); Sat, 14 Apr 2012 05:15:59 -0700 (PDT)\r
42 From: Jani Nikula <jani@nikula.org>\r
43 To: notmuch@notmuchmail.org\r
44 Subject: [PATCH v2 6/6] man: document notmuch tag --stdin option\r
45 Date: Sat, 14 Apr 2012 15:15:31 +0300\r
46 Message-Id:\r
47  <98c21f1e37b89ee67b441c76825d5f91e4fb5d7d.1334404979.git.jani@nikula.org>\r
48 X-Mailer: git-send-email 1.7.5.4\r
49 In-Reply-To: <cover.1334404979.git.jani@nikula.org>\r
50 References: <cover.1334404979.git.jani@nikula.org>\r
51 In-Reply-To: <cover.1334404979.git.jani@nikula.org>\r
52 References: <cover.1334404979.git.jani@nikula.org>\r
53 X-Gm-Message-State:\r
54  ALoCoQmxRKSrbwwvuxXeT8z70gqOkE3UpRoGMczV+IN5bR/55cmFxeYUUeDWwvSC3PhAywXe3q45\r
55 X-BeenThere: notmuch@notmuchmail.org\r
56 X-Mailman-Version: 2.1.13\r
57 Precedence: list\r
58 List-Id: "Use and development of the notmuch mail system."\r
59         <notmuch.notmuchmail.org>\r
60 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
61         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
62 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
63 List-Post: <mailto:notmuch@notmuchmail.org>\r
64 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
65 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
66         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
67 X-List-Received-Date: Sat, 14 Apr 2012 12:16:25 -0000\r
68 \r
69 ---\r
70  man/man1/notmuch-tag.1 |   44 +++++++++++++++++++++++++++++++++++++++++++-\r
71  1 files changed, 43 insertions(+), 1 deletions(-)\r
72 \r
73 diff --git a/man/man1/notmuch-tag.1 b/man/man1/notmuch-tag.1\r
74 index aa4546e..30693cf 100644\r
75 --- a/man/man1/notmuch-tag.1\r
76 +++ b/man/man1/notmuch-tag.1\r
77 @@ -4,7 +4,11 @@ notmuch-tag \- Add/remove tags for all messages matching the search terms.\r
78  \r
79  .SH SYNOPSIS\r
80  .B notmuch tag\r
81 -.RI  "+<" tag> "|\-<" tag "> [...] [\-\-] <" search-term ">..."\r
82 +.RI "+<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">"\r
83 +\r
84 +.B notmuch tag\r
85 +.RI "--stdin"\r
86 +\r
87  \r
88  .SH DESCRIPTION\r
89  \r
90 @@ -29,6 +33,44 @@ updates the maildir flags according to tag changes if the\r
91  configuration option is enabled. See \fBnotmuch-config\fR(1) for\r
92  details.\r
93  \r
94 +Supported options for\r
95 +.B tag\r
96 +include\r
97 +.RS 4\r
98 +.TP 4\r
99 +.BR \-\-stdin\r
100 +\r
101 +Read batch tagging operations from standard input. This is more\r
102 +efficient than repeated\r
103 +.B notmuch tag\r
104 +invocations. See\r
105 +.B TAG FILE FORMAT\r
106 +below for the input format. This option is not compatible with\r
107 +specifying tagging on the command line.\r
108 +.RE\r
109 +\r
110 +.SH TAG FILE FORMAT\r
111 +\r
112 +The input must consist of lines of the format:\r
113 +\r
114 +.RI "T +<" tag ">|\-<" tag "> [...] [\-\-] <" search-terms ">"\r
115 +\r
116 +Each line is interpreted similarly to\r
117 +.B notmuch tag\r
118 +command line arguments. The delimiter is one or more spaces ' '. Any\r
119 +characters in <tag> and <search-terms>\r
120 +.B may\r
121 +be hex encoded with %NN where NN is the hexadecimal value of the\r
122 +character. Any ' ' and '%' characters in <tag> and <search-terms>\r
123 +.B must\r
124 +be hex encoded (using %20 and %25, respectively). Any characters that\r
125 +are not part of <tag> or <search-terms>\r
126 +.B must not\r
127 +be hex encoded.\r
128 +\r
129 +Leading and trailing space ' ' is ignored. Empty lines and lines\r
130 +beginning with '#' are ignored.\r
131 +\r
132  .SH SEE ALSO\r
133  \r
134  \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),\r
135 -- \r
136 1.7.5.4\r
137 \r