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

diff --git a/76/938f0ac4ab9f68267a2c09da40e5f31f226621 b/76/938f0ac4ab9f68267a2c09da40e5f31f226621
new file mode 100644 (file)
index 0000000..4f9c42f
--- /dev/null
+++ b/76/938f0ac4ab9f68267a2c09da40e5f31f226621
@@ -0,0 +1,100 @@
+Return-Path: <novalazy@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 CD9CB431FAF\r
+       for <notmuch@notmuchmail.org>; Sat, 21 Jul 2012 18:19:34 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_FROM=0.001, 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 XepuLD3AHu9D for <notmuch@notmuchmail.org>;\r
+       Sat, 21 Jul 2012 18:19:34 -0700 (PDT)\r
+Received: from mail-pb0-f53.google.com (mail-pb0-f53.google.com\r
+       [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 2E74C431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 21 Jul 2012 18:19:34 -0700 (PDT)\r
+Received: by pbbrr13 with SMTP id rr13so10376029pbb.26\r
+       for <notmuch@notmuchmail.org>; Sat, 21 Jul 2012 18:19:32 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=uCXq+Q60/VZ+wsY3UUxJjjGCHeslECL7fLw1g8MOnX0=;\r
+       b=I+fn+riTlSlpiV2cnQdWbcdzHUitRPEdPkJzSHndAKYMQr4hXLo0SEqRa1nhQ0z1zg\r
+       V+PK8yFmsDVRqkG63CdPJmmwZvmJkI3W9VZ2HYsimWYsbvNmH5E5tiM7dGLZfvngn2SP\r
+       8ozAZslazrbtbh/rH7tb5K3FdHiPcpjUOJYK1PulUmLPWPGyC4U2m4/ykJVQdP9JaAdj\r
+       vVJdfLNhczJiWz1GyXA5Fz5BtdgeAEieegP3pPE/365wy2ila/1oIFO+mU12RXBY0MDJ\r
+       ieapQ3MhEV9Lco7cD//n2ekHNT/qBmimr2szGhw4BQRtX6Lq90kU+TN15AVru1lWc3eF\r
+       rh0g==\r
+Received: by 10.66.77.7 with SMTP id o7mr21350823paw.37.1342919972324;\r
+       Sat, 21 Jul 2012 18:19:32 -0700 (PDT)\r
+Received: from localhost (215.42.233.220.static.exetel.com.au.\r
+       [220.233.42.215])\r
+       by mx.google.com with ESMTPS id rs4sm6953447pbc.0.2012.07.21.18.19.28\r
+       (version=TLSv1/SSLv3 cipher=OTHER);\r
+       Sat, 21 Jul 2012 18:19:30 -0700 (PDT)\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 4/8] man: clarify search --exclude documentation\r
+Date: Sun, 22 Jul 2012 11:18:59 +1000\r
+Message-Id: <1342919939-16929-1-git-send-email-novalazy@gmail.com>\r
+X-Mailer: git-send-email 1.7.4.4\r
+In-Reply-To: <1340198947-29370-1-git-send-email-novalazy@gmail.com>\r
+References: <1340198947-29370-1-git-send-email-novalazy@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: Sun, 22 Jul 2012 01:19:34 -0000\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 5c72c4b..52782c7 100644\r
+--- a/man/man1/notmuch-search.1\r
++++ b/man/man1/notmuch-search.1\r
+@@ -116,8 +116,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.4.4\r
+\r