/* notmuch - Not much of an email program, (just index and search) * * Copyright © 2009 Carl Worth * Copyright © 2009 Keith Packard * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see http://www.gnu.org/licenses/ . * * Authors: Carl Worth * Keith Packard */ #include "notmuch-client.h" #include "notmuch-help.h" typedef int (*command_function_t) (void *ctx, int argc, char *argv[]); typedef struct command { const char *name; command_function_t function; const char *arguments; const char *summary; const char *documentation; } command_t; static int notmuch_help_command (void *ctx, int argc, char *argv[]); static const char search_terms_help[] = HELP_search_syntax_text; command_t commands[] = { { "setup", notmuch_setup_command, HELP_setup_args, HELP_setup_desc, HELP_setup_text }, { "new", notmuch_new_command, HELP_new_args, HELP_new_desc, HELP_new_text }, { "search", notmuch_search_command, HELP_search_args, HELP_search_desc, HELP_search_text }, { "show", notmuch_show_command, HELP_show_args, HELP_show_desc, HELP_show_text }, { "count", notmuch_count_command, HELP_count_args, HELP_count_desc, HELP_count_text }, { "reply", notmuch_reply_command, HELP_reply_args, HELP_reply_desc, HELP_reply_text }, { "tag", notmuch_tag_command, HELP_tag_args, HELP_tag_desc, HELP_tag_text }, { "dump", notmuch_dump_command, HELP_dump_args, HELP_dump_desc, HELP_dump_text }, { "restore", notmuch_restore_command, HELP_restore_args, HELP_restore_desc, HELP_restore_text }, { "search-tags", notmuch_search_tags_command, HELP_search_tags_args, HELP_search_tags_desc, HELP_search_tags_text }, { "part", notmuch_part_command, HELP_part_args, HELP_part_desc, HELP_part_text }, { "config", notmuch_config_command, HELP_config_args, HELP_config_desc, HELP_config_text }, { "help", notmuch_help_command, HELP_help_args, HELP_help_desc, HELP_help_text } }; static void usage (FILE *out) { command_t *command; unsigned int i; fprintf (out, "Usage: notmuch --help\n" " notmuch --version\n" " notmuch [args...]\n"); fprintf (out, "\n"); fprintf (out, "The available commands are as follows:\n"); fprintf (out, "\n"); for (i = 0; i < ARRAY_SIZE (commands); i++) { command = &commands[i]; fprintf (out, " %-11s %s\n", command->name, command->summary); } fprintf (out, "\n"); fprintf (out, "Use \"notmuch help \" for more details on each command\n" "and \"notmuch help search-terms\" for the common search-terms syntax.\n\n"); } static int notmuch_help_command (unused (void *ctx), int argc, char *argv[]) { command_t *command; unsigned int i; if (argc == 0) { printf ("The notmuch mail system.\n\n"); usage (stdout); return 0; } for (i = 0; i < ARRAY_SIZE (commands); i++) { command = &commands[i]; if (strcmp (argv[0], command->name) == 0) { printf ("Help for \"notmuch %s\":\n\n", argv[0]); if (command->arguments) printf ("%s %s\n\n\t%s\n\n%s\n\n", command->name, command->arguments, command->summary, command->documentation); else printf ("%s\t%s\n\n%s\n\n", command->name, command->summary, command->documentation); return 0; } } if (strcmp (argv[0], "search-terms") == 0) { printf ("Help for <%s>\n\n", argv[0]); for (i = 0; i < ARRAY_SIZE (commands); i++) { command = &commands[i]; if (command->arguments && strstr (command->arguments, "search-terms")) { printf ("\t%s\t%s\n", command->name, command->arguments); } } printf ("\n"); fputs (search_terms_help, stdout); return 0; } fprintf (stderr, "\nSorry, %s is not a known command. There's not much I can do to help.\n\n", argv[0]); return 1; } /* Handle the case of "notmuch" being invoked with no command * argument. For now we just call notmuch_setup_command, but we plan * to be more clever about this in the future. */ static int notmuch (void *ctx) { notmuch_config_t *config; notmuch_bool_t is_new; char *db_path; struct stat st; config = notmuch_config_open (ctx, NULL, &is_new); /* If the user has never configured notmuch, then run * notmuch_setup_command which will give a nice welcome message, * and interactively guide the user through the configuration. */ if (is_new) { notmuch_config_close (config); return notmuch_setup_command (ctx, 0, NULL); } /* Notmuch is already configured, but is there a database? */ db_path = talloc_asprintf (ctx, "%s/%s", notmuch_config_get_database_path (config), ".notmuch"); if (stat (db_path, &st)) { notmuch_config_close (config); if (errno != ENOENT) { fprintf (stderr, "Error looking for notmuch database at %s: %s\n", db_path, strerror (errno)); return 1; } printf ("Notmuch is configured, but there's not yet a database at\n\n\t%s\n\n", db_path); printf ("You probably want to run \"notmuch new\" now to create that database.\n\n" "Note that the first run of \"notmuch new\" can take a very long time\n" "and that the resulting database will use roughly the same amount of\n" "storage space as the email being indexed.\n\n"); return 0; } printf ("Notmuch is configured and appears to have a database. Excellent!\n\n" "At this point you can start exploring the functionality of notmuch by\n" "using commands such as:\n\n" "\tnotmuch search tag:inbox\n\n" "\tnotmuch search to:\"%s\"\n\n" "\tnotmuch search from:\"%s\"\n\n" "\tnotmuch search subject:\"my favorite things\"\n\n" "See \"notmuch help search\" for more details.\n\n" "You can also use \"notmuch show\" with any of the thread IDs resulting\n" "from a search. Finally, you may want to explore using a more sophisticated\n" "interface to notmuch such as the emacs interface implemented in notmuch.el\n" "or any other interface described at http://notmuchmail.org\n\n" "And don't forget to run \"notmuch new\" whenever new mail arrives.\n\n" "Have fun, and may your inbox never have much mail.\n\n", notmuch_config_get_user_name (config), notmuch_config_get_user_primary_email (config)); notmuch_config_close (config); return 0; } int main (int argc, char *argv[]) { void *local; command_t *command; unsigned int i; local = talloc_new (NULL); g_mime_init (0); if (argc == 1) return notmuch (local); if (STRNCMP_LITERAL (argv[1], "--help") == 0) return notmuch_help_command (NULL, 0, NULL); if (STRNCMP_LITERAL (argv[1], "--version") == 0) { printf ("notmuch " STRINGIFY(NOTMUCH_VERSION) "\n"); return 0; } for (i = 0; i < ARRAY_SIZE (commands); i++) { command = &commands[i]; if (strcmp (argv[1], command->name) == 0) return (command->function) (local, argc - 2, &argv[2]); } fprintf (stderr, "Error: Unknown command '%s' (see \"notmuch help\")\n", argv[1]); talloc_free (local); return 1; }