notmuch search: Document the from, to, and subject prefixes.
authorCarl Worth <cworth@cworth.org>
Thu, 5 Nov 2009 18:33:37 +0000 (10:33 -0800)
committerCarl Worth <cworth@cworth.org>
Thu, 5 Nov 2009 18:33:37 +0000 (10:33 -0800)
I've been using these for a long time, but I had neglected to document
them until now.

notmuch.c

index c5a913cdec7329f71813ec1dc03d1135bcc39c27..b6fbef41b1e2738069a7d7964bc3d4592592be29 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
@@ -1467,11 +1467,22 @@ command_t commands[] = {
       "\t\tNote that the individual mail messages will be matched\n"
       "\t\tagainst the search terms, but the results will be the\n"
       "\t\tthreads containing the matched messages.\n\n"
-      "\t\tCurrently, the supported search terms are as follows, (where\n"
+      "\t\tCurrently, in addition to free text (and quoted phrases\n"
+      "\t\tthe following prefixed search terms are supported, (where\n"
       "\t\t<brackets> indicate user-supplied values):\n\n"
+      "\t\t\tfrom:<name-or-address>\n"
+      "\t\t\tto:<name-or-address>\n"
+      "\t\t\tsubject:<word-or-quoted-phrase>\n"
       "\t\t\ttag:<tag>\n"
       "\t\t\tid:<message-id>\n"
       "\t\t\tthread:<thread-id>\n\n"
+      "\t\tThe from: prefix is used to match the name or address of\n"
+      "\t\tthe sender of an email message.\n\n"
+      "\t\tThe to: prefix is used to match the names or addresses of\n"
+      "\t\tany recipient of an email message, (whether To, Cc, or Bcc).\n\n"
+      "\t\tAny term prefixed with subject: will match only text from\n"
+      "\t\tthe subject of an email. Quoted phrases are supported when\n"
+      "\t\tsearching with: subject:\"this is a phrase\".\n\n"
       "\t\tValid tag values include \"inbox\" and \"unread\" by default\n"
       "\t\tfor new messages added by \"notmuch new\" as well as any other\n"
       "\t\ttag values added manually with \"notmuch tag\".\n\n"