+command_t commands[] = {
+ { "setup", notmuch_setup_command,
+ NULL,
+ "Interactively setup notmuch for first use.",
+ "\tThe setup command will prompt for your full name, your primary\n"
+ "\temail address, any alternate email addresses you use, and the\n"
+ "\tdirectory containing your email archives. Your answers will be\n"
+ "\twritten to a configuration file in ${NOTMUCH_CONFIG} (if set)\n"
+ "\tor ${HOME}/.notmuch-config.\n"
+ "\n"
+ "\tThis configuration file will be created with descriptive\n"
+ "\tcomments, making it easy to edit by hand later to change the\n"
+ "\tconfiguration. Or you can run \"notmuch setup\" again.\n"
+ "\n"
+ "\tInvoking notmuch with no command argument will run setup if\n"
+ "\tthe setup command has not previously been completed." },
+ { "new", notmuch_new_command,
+ "[--verbose]",
+ "Find and import new messages to the notmuch database.",
+ "\tScans all sub-directories of the mail directory, performing\n"
+ "\tfull-text indexing on new messages that are found. Each new\n"
+ "\tmessage will be tagged as both \"inbox\" and \"unread\".\n"
+ "\n"
+ "\tYou should run \"notmuch new\" once after first running\n"
+ "\t\"notmuch setup\" to create the initial database. The first\n"
+ "\trun may take a long time if you have a significant amount of\n"
+ "\tmail (several hundred thousand messages or more).\n"
+ "\n"
+ "\tSubsequently, you should run \"notmuch new\" whenever new mail\n"
+ "\tis delivered and you wish to incorporate it into the database.\n"
+ "\tThese subsequent runs will be much quicker than the initial run.\n"
+ "\n"
+ "\tSupported options for new include:\n"
+ "\n"
+ "\t--verbose\n"
+ "\n"
+ "\t\tVerbose operation. Shows paths of message files as\n"
+ "\t\tthey are being indexed.\n"
+ "\n"
+ "\tInvoking notmuch with no command argument will run new if\n"
+ "\tthe setup command has previously been completed, but new has\n"
+ "\tnot previously been run." },
+ { "search", notmuch_search_command,
+ "[options...] <search-terms> [...]",
+ "Search for messages matching the given search terms.",
+ "\tNote that the individual mail messages will be matched\n"
+ "\tagainst the search terms, but the results will be the\n"
+ "\tthreads (one per line) containing the matched messages.\n"
+ "\n"
+ "\tSupported options for search include:\n"
+ "\n"
+ "\t--format=(json|text)\n"
+ "\n"
+ "\t\tPresents the results in either JSON or\n"
+ "\t\tplain-text (default)\n"
+ "\n"
+ "\t--sort=(newest-first|oldest-first)\n"
+ "\n"
+ "\t\tPresent results in either chronological order\n"
+ "\t\t(oldest-first) or reverse chronological order\n"
+ "\t\t(newest-first), which is the default.\n"
+ "\n"
+ "\tSee \"notmuch help search-terms\" for details of the search\n"
+ "\tterms syntax." },
+ { "show", notmuch_show_command,
+ "<search-terms> [...]",
+ "Show all messages matching the search terms.",
+ "\tThe messages are grouped and sorted based on the threading\n"
+ "\t(all replies to a particular message appear immediately\n"
+ "\tafter that message in date order).\n"
+ "\n"
+ "\tSupported options for show include:\n"
+ "\n"
+ "\t--entire-thread\n"
+ "\n"
+ "\t\tBy default only those messages that match the\n"
+ "\t\tsearch terms will be displayed. With this option,\n"
+ "\t\tall messages in the same thread as any matched\n"
+ "\t\tmessage will be displayed.\n"
+ "\n"
+ "\t--format=(text|json|mbox)\n"
+ "\n"
+ "\t\ttext (default)\n"
+ "\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\tthen either an opening or closing brace, '{' or '}' to\n"
+ "\t\teither open or close the component.\n"
+ "\n"
+ "\t\tjson\n"
+ "\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"
+ "\t\"thread:<thread-id>\" as can be seen in the first column\n"
+ "\tof output from the \"notmuch search\" command.\n"
+ "\n"
+ "\tSee \"notmuch help search-terms\" for details of the search\n"
+ "\tterms syntax." },
+ { "count", notmuch_count_command,
+ "<search-terms> [...]",
+ "Count messages matching the search terms.",
+ "\tThe number of matching messages is output to stdout.\n"
+ "\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"
+ "\tterms syntax." },
+ { "reply", notmuch_reply_command,
+ "[options...] <search-terms> [...]",
+ "Construct a reply template for a set of messages.",
+ "\tConstructs a new message as a reply to a set of existing\n"
+ "\tmessages. The Reply-To: header (if any, otherwise From:) is\n"
+ "\tused for the To: address. The To: and Cc: headers are copied,\n"
+ "\tbut not including any of the user's configured addresses.\n"
+ "\n"
+ "\tA suitable subject is constructed. The In-Reply-to: and\n"
+ "\tReferences: headers are set appropriately, and the content\n"
+ "\tof the original messages is quoted and included in the body\n"
+ "\t(unless --format=headers-only is given).\n"
+ "\n"
+ "\tThe resulting message template is output to stdout.\n"
+ "\n"
+ "\tSupported options for reply include:\n"
+ "\n"
+ "\t--format=(default|headers-only)\n"
+ "\n"
+ "\t\tdefault:\n"
+ "\t\t\tIncludes subject and quoted message body.\n"
+ "\n"
+ "\t\theaders-only:\n"
+ "\t\t\tOnly produces In-Reply-To, References, To\n"
+ "\t\t\tCc, and Bcc headers.\n"
+ "\n"
+ "\tSee \"notmuch help search-terms\" for details of the search\n"
+ "\tterms syntax." },
+ { "tag", notmuch_tag_command,
+ "+<tag>|-<tag> [...] [--] <search-terms> [...]",
+ "Add/remove tags for all messages matching the search terms.",
+ "\tThe search terms are handled exactly as in 'search' so one\n"
+ "\tcan use that command first to see what will be modified.\n"
+ "\n"
+ "\tTags prefixed by '+' are added while those prefixed by\n"
+ "\t'-' are removed. For each message, tag removal is performed\n"
+ "\tbefore tag addition.\n"
+ "\n"
+ "\tThe beginning of <search-terms> is recognized by the first\n"
+ "\targument that begins with neither '+' nor '-'. Support for\n"
+ "\tan initial search term beginning with '+' or '-' is provided\n"
+ "\tby allowing the user to specify a \"--\" argument to separate\n"
+ "\tthe tags from the search terms.\n"
+ "\n"
+ "\tSee \"notmuch help search-terms\" for details of the search\n"
+ "\tterms syntax." },
+ { "dump", notmuch_dump_command,
+ "[<filename>]",
+ "Create a plain-text dump of the tags for each message.",
+ "\tOutput is to the given filename, if any, or to stdout.\n"
+ "\tThese tags are the only data in the notmuch database\n"
+ "\tthat can't be recreated from the messages themselves.\n"
+ "\tThe output of notmuch dump is therefore the only\n"
+ "\tcritical thing to backup (and much more friendly to\n"
+ "\tincremental backup than the native database files.)" },
+ { "restore", notmuch_restore_command,
+ "<filename>",
+ "Restore the tags from the given dump file (see 'dump').",
+ "\tNote: The dump file format is specifically chosen to be\n"
+ "\tcompatible with the format of files produced by sup-dump.\n"
+ "\tSo if you've previously been using sup for mail, then the\n"
+ "\t\"notmuch restore\" command provides you a way to import\n"
+ "\tall of your tags (or labels as sup calls them)." },
+ { "search-tags", notmuch_search_tags_command,
+ "[<search-terms> [...] ]",
+ "List all tags found in the database or matching messages.",
+ "\tRun this command without any search-term(s) to obtain a list\n"
+ "\tof all tags found in the database. If you provide one or more\n"
+ "\tsearch-terms as argument(s) then the resulting list will\n"
+ "\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.",
+ "\tExcept in this case, where there's not much more detailed\n"
+ "\thelp available." }
+};