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