notmuch: Add a new "notmuch config" command for querying configuration.

[notmuch] / notmuch.c

diff --git a/notmuch.c b/notmuch.c
index cde3c33b0383df1d675e19f505ba8772bc7e4c4d..f9acfa36aa23ef7dc88abdfdefd577085b792acb 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--format=(json|text)\n"
+      "\t--format=(text|json|mbox)\n"
       "\n"
-      "\t\ttext\t(default)\n"
+      "\t\ttext (default)\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"
@@ -203,9 +203,23 @@ command_t commands[] = {
       "\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"
@@ -219,10 +233,6 @@ command_t commands[] = {
       "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"
       "\tWith no search terms, a count of all messages in the database\n"
       "\twill be displayed.\n"
       "\n"
@@ -311,6 +321,20 @@ command_t commands[] = {
       "\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." },
+    { "config", notmuch_config_command,
+      "get <section>.<item>",
+      "Get settings from the notmuch configuration file.",
+      "\tThe value of the specified configuration item is printed\n"
+      "\tto stdout. If the item has multiple values, each value\n"
+      "\tis separated by a newline character.\n"
+      "\n"
+      "\tAvailable configuration items include at least"
+      "\n"
+      "\t\tdatabase.path\n"
+      "\t\tuser.name\n"
+      "\t\tuser.primary_email\n"
+      "\t\tuser.other_email\n"
+      "\t\tnew.tags\n" },
     { "help", notmuch_help_command,
       "[<command>]",
       "This message, or more detailed help for the named command.",
@@ -478,7 +502,7 @@ main (int argc, char *argv[])
        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;
     }