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

diff --git a/0f/1163778c1d2780914cd0baa844b6eea746dfd8 b/0f/1163778c1d2780914cd0baa844b6eea746dfd8
new file mode 100644 (file)
index 0000000..44ac24c
--- /dev/null
+++ b/0f/1163778c1d2780914cd0baa844b6eea746dfd8
@@ -0,0 +1,99 @@
+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 12F28431FD4\r
+       for <notmuch@notmuchmail.org>; Wed, 20 Jun 2012 06:29:54 -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 zY76t7m2Q9Fs for <notmuch@notmuchmail.org>;\r
+       Wed, 20 Jun 2012 06:29:53 -0700 (PDT)\r
+Received: from mail-pz0-f53.google.com (mail-pz0-f53.google.com\r
+       [209.85.210.53]) (using TLSv1 with cipher RC4-MD5 (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id D6F26431FC0\r
+       for <notmuch@notmuchmail.org>; Wed, 20 Jun 2012 06:29:49 -0700 (PDT)\r
+Received: by mail-pz0-f53.google.com with SMTP id g9so12291942dad.26\r
+       for <notmuch@notmuchmail.org>; Wed, 20 Jun 2012 06:29:49 -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=TTJhlYdPM1MqjSiviwqFAiBru8irZ+2C0XT4xWG2yzc=;\r
+       b=oEDufKv2YslXwezsCTJ+n47mvxnrGAzy6gJ1jZo0SpgnGrWF17uwX+sEg2KoAWhm7n\r
+       4PbnubY5Kin7VSDbNr/ebEMXwNgqQ5Ld+Fy1C7kOENREnhORbg9A5yj9qzrIdmZdJDQM\r
+       b7rmsPFBWwYD2KsyXnpP42b//1mL1xV4TpTOSmFZmTTOIkisYeAlP3hq6AbIlJqFGb7O\r
+       i5XSKHrAaLvw2J6QEAYVChcpcezFj6OaAUZLMUHLoYrwZcUyqGE7PWpaSnK9kmEXTS4D\r
+       80B4c8LGS4PR9R4yGn8YcE5i+t1Wy0M7poaR7wERhirYQr8+E+rUA7PFD3UMRBMB6GTo\r
+       mnMA==\r
+Received: by 10.68.219.166 with SMTP id pp6mr76233599pbc.35.1340198989738;\r
+       Wed, 20 Jun 2012 06:29:49 -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 tk1sm31954773pbc.8.2012.06.20.06.29.47\r
+       (version=TLSv1/SSLv3 cipher=OTHER);\r
+       Wed, 20 Jun 2012 06:29:48 -0700 (PDT)\r
+From: Peter Wang <novalazy@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 4/8] man: clarify search --exclude documentation\r
+Date: Wed, 20 Jun 2012 23:29:03 +1000\r
+Message-Id: <1340198947-29370-5-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: Wed, 20 Jun 2012 13:29:54 -0000\r
+\r
+Highlight "excluded messages" as a piece of jargon with\r
+a meaning that 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 |   14 ++++++++++++--\r
+ 1 files changed, 12 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1\r
+index 5c72c4b..003b742 100644\r
+--- a/man/man1/notmuch-search.1\r
++++ b/man/man1/notmuch-search.1\r
+@@ -116,8 +116,18 @@ 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
++Messages matching search.tag_exclude are called "excluded messages".\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