Add documentation for the recently added folder-based searching.

Augmenting both the builtin help as well as the manual page.
This commit is contained in:
Carl Worth 2011-01-15 14:18:45 -08:00
parent 99cfa27030
commit 3863e88e96
2 changed files with 15 additions and 0 deletions

View file

@ -526,6 +526,8 @@ terms to match against specific portions of an email, (where
thread:<thread-id> thread:<thread-id>
folder:<directory-path>
The The
.B from: .B from:
prefix is used to match the name or address of the sender of an email prefix is used to match the name or address of the sender of an email
@ -569,6 +571,13 @@ internally by notmuch (and do not appear in email messages). These
thread ID values can be seen in the first column of output from thread ID values can be seen in the first column of output from
.B "notmuch search" .B "notmuch search"
The
.B folder:
prefix can be used to search for email message files that are
contained within particular directories within the mail store. Only
the directory components below the top-level mail database path are
available to be searched.
In addition to individual terms, multiple terms can be In addition to individual terms, multiple terms can be
combined with Boolean operators ( combined with Boolean operators (
.BR and ", " or ", " not .BR and ", " or ", " not

View file

@ -58,6 +58,7 @@ static const char search_terms_help[] =
"\t\ttag:<tag> (or is:<tag>)\n" "\t\ttag:<tag> (or is:<tag>)\n"
"\t\tid:<message-id>\n" "\t\tid:<message-id>\n"
"\t\tthread:<thread-id>\n" "\t\tthread:<thread-id>\n"
"\t\tfolder:<directory-path>\n"
"\n" "\n"
"\tThe from: prefix is used to match the name or address of\n" "\tThe from: prefix is used to match the name or address of\n"
"\tthe sender of an email message.\n" "\tthe sender of an email message.\n"
@ -82,6 +83,11 @@ static const char search_terms_help[] =
"\tmessages). These thread ID values can be seen in the first\n" "\tmessages). These thread ID values can be seen in the first\n"
"\tcolumn of output from \"notmuch search\".\n" "\tcolumn of output from \"notmuch search\".\n"
"\n" "\n"
"\tThe folder: prefix can be used to search for email message\n"
"\tfiles that are contained within particular directories within\n"
"\tthe mail store. Only the directory components below the top-level\n"
"\tmail database path are available to be searched.\n"
"\n"
"\tIn addition to individual terms, multiple terms can be\n" "\tIn addition to individual terms, multiple terms can be\n"
"\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n" "\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
"\tEach term in the query will be implicitly connected by a\n" "\tEach term in the query will be implicitly connected by a\n"