Return-Path: <markwalters1009@gmail.com>
X-Original-To: notmuch@notmuchmail.org
Delivered-To: notmuch@notmuchmail.org
Received: from localhost (localhost [127.0.0.1])
	by olra.theworths.org (Postfix) with ESMTP id 39D0B431FC9
	for <notmuch@notmuchmail.org>; Sat, 11 May 2013 12:50:39 -0700 (PDT)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Spam-Flag: NO
X-Spam-Score: 0.201
X-Spam-Level: 
X-Spam-Status: No, score=0.201 tagged_above=-999 required=5
	tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,
	FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,
	RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled
Received: from olra.theworths.org ([127.0.0.1])
	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
	with ESMTP id 4ZfbI-5-MuT5 for <notmuch@notmuchmail.org>;
	Sat, 11 May 2013 12:50:34 -0700 (PDT)
Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com
 [74.125.82.45])	(using TLSv1 with cipher RC4-SHA (128/128 bits))	(No client
 certificate requested)	by olra.theworths.org (Postfix) with ESMTPS id
 351A0431FC7	for <notmuch@notmuchmail.org>; Sat, 11 May 2013 12:50:25 -0700
 (PDT)
Received: by mail-wg0-f45.google.com with SMTP id l18so5281117wgh.24
	for <notmuch@notmuchmail.org>; Sat, 11 May 2013 12:50:24 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
	h=x-received:from:to:cc:subject:date:message-id:x-mailer:in-reply-to
	:references; bh=Jj5IWQfMnFvi1I9BpR+LCYlaQEgb+8RTKMhbFAuRivg=;
	b=AaMmfZuNQbZwwBe0yAF7GYpInZH6qeeKgI01kBHNzIlSPfJj5Tnc+KMwNb3Trnl2lg
	1Op2EDb7cPZaj3KRELp6/v3DqJgMz4zbQ8zgK57catD+Xspd4gQqUTZUEO43L3j8bJBn
	flAYbMP2Kc5hUYT2nvfkNO5VtC48QkK/1JOWQsPGnt5+qKWkPufgGnBJpPVFbqOjAuJv
	zDPEMF65+o7BcdMIXA7YzgrhL2px/gK2CMJv4UVI/JyKCpBdcucL0sYpbdgGFKZi8tBV
	ZmHU5cPu/vbydipND/g/CbJE0FOBwJs5rZ80+x9m8wHMeen3gOyeZ3L15fLVWXT8NCID
	mq4Q==
X-Received: by 10.194.62.233 with SMTP id b9mr31340441wjs.37.1368301824151;
	Sat, 11 May 2013 12:50:24 -0700 (PDT)
Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31])
	by mx.google.com with ESMTPSA id dq8sm6258943wib.1.2013.05.11.12.50.23
	for <multiple recipients>
	(version=TLSv1.2 cipher=RC4-SHA bits=128/128);
	Sat, 11 May 2013 12:50:23 -0700 (PDT)
From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 4/8] man: clarify search --exclude documentation
Date: Sat, 11 May 2013 20:50:05 +0100
Message-Id: <1368301809-12532-5-git-send-email-markwalters1009@gmail.com>
X-Mailer: git-send-email 1.7.9.1
In-Reply-To: <1368301809-12532-1-git-send-email-markwalters1009@gmail.com>
References: <1368301809-12532-1-git-send-email-markwalters1009@gmail.com>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sat, 11 May 2013 19:50:40 -0000

From: Peter Wang <novalazy@gmail.com>

Highlight "excluded messages" as a term with a meaning that
may not be obvious.

Be explicit about the effects of search --exclude=true and
--exclude=false.
---
 man/man1/notmuch-search.1 |   15 +++++++++++++--
 1 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1
index d3391f8..59e8f34 100644
--- a/man/man1/notmuch-search.1
+++ b/man/man1/notmuch-search.1
@@ -132,8 +132,19 @@ Limit the number of displayed results to N.
 .TP 4
 .BR \-\-exclude=(true|false|flag)
 
-Specify whether to omit messages matching search.tag_exclude from the
-search results (the default) or not. The extra option
+A message is called "excluded" if it matches at least one tag in
+search.tag_exclude that does not appear explicitly in the search terms.
+This option specifies whether to omit excluded messages in the search
+process.
+
+The default value,
+.BR true ,
+prevents excluded messages from matching the search terms.
+
+.B false
+allows excluded messages to match search terms and appear in displayed
+results. Excluded messages are still marked in the relevant outputs.
+
 .B flag
 only has an effect when
 .B --output=summary
-- 
1.7.9.1