From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 2CF48431FBF for ; Sun, 9 Mar 2014 23:25:53 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -0.7 X-Spam-Level: X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 tests=[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 oV3xokSFmfHC for ; Sun, 9 Mar 2014 23:25:47 -0700 (PDT) Received: from mail-ee0-f48.google.com (mail-ee0-f48.google.com [74.125.83.48]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 7CAEC431FBD for ; Sun, 9 Mar 2014 23:25:47 -0700 (PDT) Received: by mail-ee0-f48.google.com with SMTP id e51so2880414eek.7 for ; Sun, 09 Mar 2014 23:25:46 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=HygLmH+8KJLELkTShvSszvxOEyRKq+mIMLehAMe0at8=; b=gzvk5XJlvGB4DFzOZ8iZpoBEwyf/KsFYA/9+W0i6Cs4WR/oLKMWXsJnUUYuvP2sRF/ Rb92MT5vaOHpnLSo6wE30MGSwgztEP7JziyerJ+1Y8/SJntZ2FHFZZjs0SCb3Zdxmkd/ AVaDqLZCeFtLVMFD0zMLRUzSHPyWSgyAue+eackeNf0Z/Y98Iu9uC276TEgfFDyp5Fkv 9vbOhvt+nj7oRWEWHC8TlGqZbKViK64/kNSWbW9bzBqNM5iIH7ygQhypdxSfo5aWM8dI 0rLrgN7eCuPAhjhJnlVLQw2pzQHmbiEAsPT+pnj5ygSQGsQs+S81JNY8VHwTXKHPKcG/ aH9w== X-Gm-Message-State: ALoCoQnSG3DraDLnmGDCE0mmNRMnmVyjfcELblPBEJMdOR0jC1UFvzIxVC0Vnk98wzVH9S7FKJhU X-Received: by 10.14.251.5 with SMTP id a5mr115131ees.108.1394432746271; Sun, 09 Mar 2014 23:25:46 -0700 (PDT) Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. [88.195.111.91]) by mx.google.com with ESMTPSA id m8sm41198444eef.14.2014.03.09.23.25.44 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Sun, 09 Mar 2014 23:25:45 -0700 (PDT) From: Jani Nikula To: notmuch@notmuchmail.org Subject: [PATCH v5] man: update man pages for folder: and path: search terms Date: Mon, 10 Mar 2014 08:25:44 +0200 Message-Id: <1394432744-3404-1-git-send-email-jani@nikula.org> X-Mailer: git-send-email 1.9.0 In-Reply-To: References: 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: Mon, 10 Mar 2014 06:25:53 -0000 Text from review by Austin Clements . --- doc/man7/notmuch-search-terms.rst | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst index 20bc6f1e1488..1acdaa0b38de 100644 --- a/doc/man7/notmuch-search-terms.rst +++ b/doc/man7/notmuch-search-terms.rst @@ -46,7 +46,9 @@ indicate user-supplied values): - thread: -- folder: +- folder: + +- path: or path:/** - date:.. @@ -77,12 +79,28 @@ generated internally by notmuch (and do not appear in email messages). These thread ID values can be seen in the first column of output from **notmuch search** -The **folder:** prefix can be used to search for email message files -that are contained within particular directories within the mail store. -If the same email message has multiple message files associated with it, -it's sufficient for a match that at least one of the files is contained -within a matching directory. Only the directory components below the -top-level mail database path are available to be searched. +The **path:** prefix searches for email messages that are in +particular directories within the mail store. The directory must be +specified relative to the top-level maildir (and without the leading +slash). By default, **path:** matches messages in the specified +directory only. The "/\*\*" suffix can be used to match messages in +the specified directory and all its subdirectories recursively. +**path:""** matches messages in the root of the mail store and, +likewise, **path:\*\*** matches all messages. + +The **folder:** prefix searches for email messages by maildir or MH +folder. For MH-style folders, this is equivalent to **path:**. For +maildir, this includes messages in the "new" and "cur" +subdirectories. The exact syntax for maildir folders depends on your +mail configuration. For maildir++, **folder:""** matches the inbox +folder (which is the root in maildir++), other folder names always +start with ".", and nested folders are separated by "."s, such as +**folder:.classes.topology**. For "file system" maildir, the inbox is +typically **folder:INBOX** and nested folders are separated by +slashes, such as **folder:classes/topology**. + +Both **path:** and **folder:** will find a message if *any* copy of +that message is in the specific directory/folder. The **date:** prefix can be used to restrict the results to only messages within a particular time range (based on the Date: header) with -- 1.9.0