[PATCH v2 4/8] man: clarify search --exclude documentation

diff --git a/d1/10dfc85acc95113973744c66124d3df665d949 b/d1/10dfc85acc95113973744c66124d3df665d949
new file mode 100644 (file)
index 0000000..3c639ee
--- /dev/null
+++ b/d1/10dfc85acc95113973744c66124d3df665d949
@@ -0,0 +1,103 @@
+Return-Path: <markwalters1009@gmail.com>\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 39D0B431FC9\r
+       for <notmuch@notmuchmail.org>; Sat, 11 May 2013 12:50:39 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       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 4ZfbI-5-MuT5 for <notmuch@notmuchmail.org>;\r
+       Sat, 11 May 2013 12:50:34 -0700 (PDT)\r
+Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com\r
+ [74.125.82.45])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ 351A0431FC7   for <notmuch@notmuchmail.org>; Sat, 11 May 2013 12:50:25 -0700\r
+ (PDT)\r
+Received: by mail-wg0-f45.google.com with SMTP id l18so5281117wgh.24\r
+       for <notmuch@notmuchmail.org>; Sat, 11 May 2013 12:50:24 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=x-received:from:to:cc:subject:date:message-id:x-mailer:in-reply-to\r
+       :references; bh=Jj5IWQfMnFvi1I9BpR+LCYlaQEgb+8RTKMhbFAuRivg=;\r
+       b=AaMmfZuNQbZwwBe0yAF7GYpInZH6qeeKgI01kBHNzIlSPfJj5Tnc+KMwNb3Trnl2lg\r
+       1Op2EDb7cPZaj3KRELp6/v3DqJgMz4zbQ8zgK57catD+Xspd4gQqUTZUEO43L3j8bJBn\r
+       flAYbMP2Kc5hUYT2nvfkNO5VtC48QkK/1JOWQsPGnt5+qKWkPufgGnBJpPVFbqOjAuJv\r
+       zDPEMF65+o7BcdMIXA7YzgrhL2px/gK2CMJv4UVI/JyKCpBdcucL0sYpbdgGFKZi8tBV\r
+       ZmHU5cPu/vbydipND/g/CbJE0FOBwJs5rZ80+x9m8wHMeen3gOyeZ3L15fLVWXT8NCID\r
+       mq4Q==\r
+X-Received: by 10.194.62.233 with SMTP id b9mr31340441wjs.37.1368301824151;\r
+       Sat, 11 May 2013 12:50:24 -0700 (PDT)\r
+Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])\r
+       by mx.google.com with ESMTPSA id dq8sm6258943wib.1.2013.05.11.12.50.23\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 11 May 2013 12:50:23 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 4/8] man: clarify search --exclude documentation\r
+Date: Sat, 11 May 2013 20:50:05 +0100\r
+Message-Id: <1368301809-12532-5-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <1368301809-12532-1-git-send-email-markwalters1009@gmail.com>\r
+References: <1368301809-12532-1-git-send-email-markwalters1009@gmail.com>\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, 11 May 2013 19:50:40 -0000\r
+\r
+From: Peter Wang <novalazy@gmail.com>\r
+\r
+Highlight "excluded messages" as a term with a meaning that\r
+may not be obvious.\r
+\r
+Be explicit about the effects of search --exclude=true and\r
+--exclude=false.\r
+---\r
+ man/man1/notmuch-search.1 |   15 +++++++++++++--\r
+ 1 files changed, 13 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1\r
+index d3391f8..59e8f34 100644\r
+--- a/man/man1/notmuch-search.1\r
++++ b/man/man1/notmuch-search.1\r
+@@ -132,8 +132,19 @@ Limit the number of displayed results to N.\r
+ .TP 4\r
+ .BR \-\-exclude=(true|false|flag)\r
+ \r
+-Specify whether to omit messages matching search.tag_exclude from the\r
+-search results (the default) or not. The extra option\r
++A message is called "excluded" if it matches at least one tag in\r
++search.tag_exclude that does not appear explicitly in the search terms.\r
++This option specifies whether to omit excluded messages in the search\r
++process.\r
++\r
++The default value,\r
++.BR true ,\r
++prevents excluded messages from matching the search terms.\r
++\r
++.B false\r
++allows excluded messages to match search terms and appear in displayed\r
++results. Excluded messages are still marked in the relevant outputs.\r
++\r
+ .B flag\r
+ only has an effect when\r
+ .B --output=summary\r
+-- \r
+1.7.9.1\r
+\r