notmuch: Document the new special-case syntax of "*".

[notmuch] / notmuch.c

diff --git a/notmuch.c b/notmuch.c
index b392c1c207833bc98d60499896a4b57eb162c559..7e595e247e9f41960df94e01f027110b24859a91 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
@@ -44,6 +44,9 @@ static const char search_terms_help[] =
     "\tthe given terms/phrases in the body, the subject, or any of\n"
     "\tthe sender or recipient headers.\n"
     "\n"
+    "\tAs a special case, a search string consisting of exactly a\n"
+    "\tsingle asterisk (\"*\") will match all messages.\n"
+    "\n"
     "\tIn addition to free text, the following prefixes can be used\n"
     "\tto force terms to match against specific portions of an email,\n"
     "\t(where <brackets> indicate user-supplied values):\n"
@@ -220,6 +223,10 @@ command_t commands[] = {
       "\tof messages matching both a specific tag and either inbox\n"
       "\tor unread\n"
       "\n"
+      "\tIf no parameters are given, or the special search terms '' or\n"
+      "\t'*' are given, it will display the total number of messages in\n"
+      "\tthe database.\n"
+      "\n"
       "\tSee \"notmuch help search-terms\" for details of the search\n"
       "\t\tterms syntax." },
     { "reply", notmuch_reply_command,
@@ -294,6 +301,17 @@ command_t commands[] = {
       "\tcontain tags only from messages that match the search-term(s).\n"
       "\n"
       "\tIn both cases the list will be alphabetically sorted." },
+    { "part", notmuch_part_command,
+      "--part=<num> <search-terms>",
+      "Output a single MIME part of a message.",
+      "\tA single decoded MIME part, with no encoding or framing,\n"
+      "\tis output to stdout. The search terms must match only a single\n"
+      "\tmessage, otherwise this command will fail.\n"
+      "\n"
+      "\tThe part number should match the part \"id\" field output\n"
+      "\tby the \"--format=json\" option of \"notmuch show\". If the\n"
+      "\tmessage specified by the search terms does not include a\n"
+      "\tpart with the specified \"id\" there will be no output." },
     { "help", notmuch_help_command,
       "[<command>]",
       "This message, or more detailed help for the named command.",