]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch.c
test: Fix notmuch-test to pass command-line arguments to sub-scripts.
[notmuch] / notmuch.c
index 7e595e247e9f41960df94e01f027110b24859a91..f6b8c139bb76439de298b5ed50bfe9c36e6f3903 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
@@ -189,12 +189,12 @@ command_t commands[] = {
       "\t\tall messages in the same thread as any matched\n"
       "\t\tmessage will be displayed.\n"
       "\n"
       "\t\tall messages in the same thread as any matched\n"
       "\t\tmessage will be displayed.\n"
       "\n"
-      "\t--format=(json|text)\n"
+      "\t--format=(text|json|mbox)\n"
       "\n"
       "\n"
-      "\t\ttext\t(default)\n"
+      "\t\ttext (default)\n"
       "\n"
       "\n"
-      "\t\tThe plain-text has all text-content MIME parts decoded.\n"
-      "\t\tVarious components in the output, ('message', 'header',\n"
+      "\t\tThe default plain-text format has all text-content MIME parts\n"
+      "\t\tdecoded. Various components in the output, ('message', 'header',\n"
       "\t\t'body', 'attachment', and MIME 'part') are delimited by\n"
       "\t\teasily-parsed markers. Each marker consists of a Control-L\n"
       "\t\tcharacter (ASCII decimal 12), the name of the marker, and\n"
       "\t\t'body', 'attachment', and MIME 'part') are delimited by\n"
       "\t\teasily-parsed markers. Each marker consists of a Control-L\n"
       "\t\tcharacter (ASCII decimal 12), the name of the marker, and\n"
@@ -203,9 +203,23 @@ command_t commands[] = {
       "\n"
       "\t\tjson\n"
       "\n"
       "\n"
       "\t\tjson\n"
       "\n"
-      "\t\tFormat output as Javascript Object Notation (JSON).\n"
-      "\t\tJSON output always includes all messages in a matching,\n"
-      "\t\tthread i.e. '--output=json' implies '--entire-thread'\n"
+      "\t\tThe output is formatted with Javascript Object Notation\n"
+      "\t\t(JSON). This format is more robust than the text format\n"
+      "\t\tfor automated processing. JSON output always includes all\n"
+      "\t\tmessages in a matching thread; in effect '--format=json'\n"
+      "\t\timplies '--entire-thread'\n"
+      "\n"
+      "\t\tmbox\n"
+      "\n"
+      "\t\tAll matching messages are output in the traditional, Unix\n"
+      "\t\tmbox format with each message being prefixed by a line\n"
+      "\t\tbeginning with 'From ' and a blank line separating each\n"
+      "\t\tmessage. Lines in the message content beginning with 'From '\n"
+      "\t\t(preceded by zero or more '>' characters) have an additional\n"
+      "\t\t'>' character added. This reversible escaping is termed\n"
+      "\t\t\"mboxrd\" format and described in detail here:\n"
+      "\n"
+      "\t\thttp://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html\n"
       "\n"
       "\tA common use of \"notmuch show\" is to display a single\n"
       "\tthread of email messages. For this, use a search term of\n"
       "\n"
       "\tA common use of \"notmuch show\" is to display a single\n"
       "\tthread of email messages. For this, use a search term of\n"
@@ -219,16 +233,11 @@ command_t commands[] = {
       "Count messages matching the search terms.",
       "\tThe number of matching messages is output to stdout.\n"
       "\n"
       "Count messages matching the search terms.",
       "\tThe number of matching messages is output to stdout.\n"
       "\n"
-      "\tA common use of \"notmuch count\" is to display the count\n"
-      "\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"
+      "\tWith no search terms, a count of all messages in the database\n"
+      "\twill be displayed.\n"
       "\n"
       "\tSee \"notmuch help search-terms\" for details of the search\n"
       "\n"
       "\tSee \"notmuch help search-terms\" for details of the search\n"
-      "\t\tterms syntax." },
+      "\tterms syntax." },
     { "reply", notmuch_reply_command,
       "[options...] <search-terms> [...]",
       "Construct a reply template for a set of messages.",
     { "reply", notmuch_reply_command,
       "[options...] <search-terms> [...]",
       "Construct a reply template for a set of messages.",
@@ -479,7 +488,7 @@ main (int argc, char *argv[])
        return notmuch_help_command (NULL, 0, NULL);
 
     if (STRNCMP_LITERAL (argv[1], "--version") == 0) {
        return notmuch_help_command (NULL, 0, NULL);
 
     if (STRNCMP_LITERAL (argv[1], "--version") == 0) {
-       printf ("notmuch version " STRINGIFY(NOTMUCH_VERSION) "\n");
+       printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
        return 0;
     }
 
        return 0;
     }