"\n"
"\t\t$(date +%%s -d 2009-10-01)..$(date +%%s)\n\n";
+static const char hooks_help[] =
+ "\tHooks are scripts (or arbitrary executables or symlinks to such) that\n"
+ "\tnotmuch invokes before and after certain actions. These scripts reside\n"
+ "\tin the .notmuch/hooks directory within the database directory and must\n"
+ "\thave executable permissions.\n"
+ "\n"
+ "\tThe currently available hooks are described below.\n"
+ "\n"
+ "\tpre-new\n"
+ "\t\tThis hook is invoked by the new command before scanning or\n"
+ "\t\timporting new messages into the database. If this hook exits\n"
+ "\t\twith a non-zero status, notmuch will abort further processing\n"
+ "\t\tof the new command.\n"
+ "\n"
+ "\t\tTypically this hook is used for fetching or delivering new\n"
+ "\t\tmail to be imported into the database.\n"
+ "\n"
+ "\tpost-new\n"
+ "\t\tThis hook is invoked by the new command after new messages\n"
+ "\t\thave been imported into the database and initial tags have\n"
+ "\t\tbeen applied. The hook will not be run if there have been any\n"
+ "\t\terrors during the scan or import.\n"
+ "\n"
+ "\t\tTypically this hook is used to perform additional query-based\n"
+ "\t\ttagging on the imported messages.\n\n";
+
static command_t commands[] = {
{ "setup", notmuch_setup_command,
NULL,
"\tInvoking notmuch with no command argument will run setup if\n"
"\tthe setup command has not previously been completed." },
{ "new", notmuch_new_command,
- "[--verbose]",
+ "[options...]",
"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"
"\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"
+ "\tThe new command supports hooks. See \"notmuch help hooks\" for\n"
+ "\tmore details on hooks.\n"
+ "\n"
"\tSupported options for new include:\n"
"\n"
+ "\t--no-hooks\n"
+ "\n"
+ "\t\tPrevent hooks from being run.\n"
+ "\n"
"\t--verbose\n"
"\n"
"\t\tVerbose operation. Shows paths of message files as\n"
"\t\t(oldest-first) or reverse chronological order\n"
"\t\t(newest-first), which is the default.\n"
"\n"
+ "\t--offset=[-]N\n"
+ "\n"
+ "\t\tSkip displaying the first N results. With the leading '-',\n"
+ "\t\tstart at the Nth result from the end.\n"
+ "\n"
+ "\t--limit=N\n"
+ "\n"
+ "\t\tLimit the number of displayed results to N.\n"
+ "\n"
"\tSee \"notmuch help search-terms\" for details of the search\n"
"\tterms syntax." },
{ "show", notmuch_show_command,
"\tSee \"notmuch help search-terms\" for details of the search\n"
"\tterms syntax." },
{ "count", notmuch_count_command,
- "<search-terms> [...]",
+ "[options...] <search-terms> [...]",
"Count messages matching the search terms.",
- "\tThe number of matching messages is output to stdout.\n"
+ "\tThe number of matching messages (or threads) is output to stdout.\n"
+ "\n"
+ "\tWith no search terms, a count of all messages (or threads) in\n"
+ "\tthe database will be displayed.\n"
+ "\n"
+ "\tSupported options for count include:\n"
+ "\n"
+ "\t--output=(messages|threads)\n"
+ "\n"
+ "\t\tmessages (default)\n"
"\n"
- "\tWith no search terms, a count of all messages in the database\n"
- "\twill be displayed.\n"
+ "\t\tOutput the number of matching messages.\n"
+ "\n"
+ "\t\tthreads\n"
+ "\n"
+ "\t\tOutput the number of matching threads.\n"
"\n"
"\tSee \"notmuch help search-terms\" for details of the search\n"
"\tterms syntax." },
"\tSee \"notmuch help search-terms\" for the search-term syntax.\n"
},
{ "restore", notmuch_restore_command,
- "<filename>",
+ "[--accumulate] [<filename>]",
"Restore the tags from the given dump file (see 'dump').",
+ "\tInput is read from the given filename, if any, or from stdin.\n"
"\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)." },
+ "\tall of your tags (or labels as sup calls them).\n"
+ "\tThe --accumulate switch causes the union of the existing and new\n"
+ "\ttags to be applied, instead of replacing each message's tags as\n"
+ "\tthey are read in from the dump file."},
{ "config", notmuch_config_command,
"[get|set] <section>.<item> [value ...]",
"Get or set settings in the notmuch configuration file.",
command_t *command;
unsigned int i;
+ argc--; argv++; /* Ignore "help" */
+
if (argc == 0) {
printf ("The notmuch mail system.\n\n");
usage (stdout);
printf ("\n");
printf (search_terms_help);
return 0;
+ } else if (strcmp (argv[0], "hooks") == 0) {
+ printf ("Help for <%s>\n\n", argv[0]);
+ printf (hooks_help);
+ return 0;
}
fprintf (stderr,
return notmuch (local);
if (STRNCMP_LITERAL (argv[1], "--help") == 0)
- return notmuch_help_command (NULL, 0, NULL);
+ return notmuch_help_command (NULL, argc - 1, &argv[1]);
if (STRNCMP_LITERAL (argv[1], "--version") == 0) {
printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n");
command = &commands[i];
if (strcmp (argv[1], command->name) == 0)
- return (command->function) (local, argc - 2, &argv[2]);
+ return (command->function) (local, argc - 1, &argv[1]);
}
fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n",
projects / notmuch / blobdiff