notmuch_help_command (void *ctx, int argc, char *argv[]);
static const char search_terms_help[] =
- "\t\tSeveral notmuch commands accept a comman syntax for search\n"
- "\t\tterms.\n"
+ "\tSeveral notmuch commands accept a comman syntax for search\n"
+ "\tterms.\n"
"\n"
- "\t\tThe search terms can consist of free-form text (and quoted\n"
- "\t\tphrases) which will match all messages that contain all of\n"
- "\t\tthe given terms/phrases in the body, the subject, or any of\n"
- "\t\tthe sender or recipient headers.\n"
+ "\tThe search terms can consist of free-form text (and quoted\n"
+ "\tphrases) which will match all messages that contain all of\n"
+ "\tthe given terms/phrases in the body, the subject, or any of\n"
+ "\tthe sender or recipient headers.\n"
"\n"
- "\t\tIn addition to free text, the following prefixes can be used\n"
- "\t\tto force terms to match against specific portions of an email,\n"
- "\t\t(where <brackets> indicate user-supplied values):\n"
+ "\tIn addition to free text, the following prefixes can be used\n"
+ "\tto force terms to match against specific portions of an email,\n"
+ "\t(where <brackets> indicate user-supplied values):\n"
"\n"
- "\t\t\tfrom:<name-or-address>\n"
- "\t\t\tto:<name-or-address>\n"
- "\t\t\tsubject:<word-or-quoted-phrase>\n"
- "\t\t\tattachment:<word>\n"
- "\t\t\ttag:<tag> (or is:<tag>)\n"
- "\t\t\tid:<message-id>\n"
- "\t\t\tthread:<thread-id>\n"
+ "\t\tfrom:<name-or-address>\n"
+ "\t\tto:<name-or-address>\n"
+ "\t\tsubject:<word-or-quoted-phrase>\n"
+ "\t\tattachment:<word>\n"
+ "\t\ttag:<tag> (or is:<tag>)\n"
+ "\t\tid:<message-id>\n"
+ "\t\tthread:<thread-id>\n"
"\n"
- "\t\tThe from: prefix is used to match the name or address of\n"
- "\t\tthe sender of an email message.\n"
+ "\tThe from: prefix is used to match the name or address of\n"
+ "\tthe sender of an email message.\n"
"\n"
- "\t\tThe to: prefix is used to match the names or addresses of\n"
- "\t\tany recipient of an email message, (whether To, Cc, or Bcc).\n"
+ "\tThe to: prefix is used to match the names or addresses of\n"
+ "\tany recipient of an email message, (whether To, Cc, or Bcc).\n"
"\n"
- "\t\tAny term prefixed with subject: will match only text from\n"
- "\t\tthe subject of an email. Quoted phrases are supported when\n"
- "\t\tsearching with: subject:\"this is a phrase\".\n"
+ "\tAny term prefixed with subject: will match only text from\n"
+ "\tthe subject of an email. Quoted phrases are supported when\n"
+ "\tsearching with: subject:\"this is a phrase\".\n"
"\n"
- "\t\tFor tag: and is:, valid tag values include \"inbox\" and \"unread\"\n"
- "\t\tby default for new messages added by \"notmuch new\" as well\n"
- "\t\tas any other tag values added manually with \"notmuch tag\".\n"
+ "\tFor tag: and is:, valid tag values include \"inbox\" and \"unread\"\n"
+ "\tby default for new messages added by \"notmuch new\" as well\n"
+ "\tas any other tag values added manually with \"notmuch tag\".\n"
"\n"
- "\t\tFor id:, message ID values are the literal contents of the\n"
- "\t\tMessage-ID: header of email messages, but without the '<','>'\n"
- "\t\tdelimiters.\n"
+ "\tFor id:, message ID values are the literal contents of the\n"
+ "\tMessage-ID: header of email messages, but without the '<','>'\n"
+ "\tdelimiters.\n"
"\n"
- "\t\tThe thread: prefix can be used with the thread ID values that\n"
- "\t\tare generated internally by notmuch (and do not appear in email\n"
- "\t\tmessages). These thread ID values can be seen in the first\n"
- "\t\tcolumn of output from \"notmuch search\".\n"
+ "\tThe thread: prefix can be used with the thread ID values that\n"
+ "\tare generated internally by notmuch (and do not appear in email\n"
+ "\tmessages). These thread ID values can be seen in the first\n"
+ "\tcolumn of output from \"notmuch search\".\n"
"\n"
- "\t\tIn addition to individual terms, multiple terms can be\n"
- "\t\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
- "\t\tEach term in the query will be implicitly connected by a\n"
- "\t\tlogical AND if no explicit operator is provided, (except\n"
- "\t\tthat terms with a common prefix will be implicitly combined\n"
- "\t\twith OR until we get Xapian defect #402 fixed).\n"
+ "\tIn addition to individual terms, multiple terms can be\n"
+ "\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n"
+ "\tEach term in the query will be implicitly connected by a\n"
+ "\tlogical AND if no explicit operator is provided, (except\n"
+ "\tthat terms with a common prefix will be implicitly combined\n"
+ "\twith OR until we get Xapian defect #402 fixed).\n"
"\n"
- "\t\tParentheses can also be used to control the combination of\n"
- "\t\tthe Boolean operators, but will have to be protected from\n"
- "\t\tinterpretation by the shell, (such as by putting quotation\n"
- "\t\tmarks around any parenthesized expression).\n"
+ "\tParentheses can also be used to control the combination of\n"
+ "\tthe Boolean operators, but will have to be protected from\n"
+ "\tinterpretation by the shell, (such as by putting quotation\n"
+ "\tmarks around any parenthesized expression).\n"
"\n"
- "\t\tFinally, results can be restricted to only messages within a\n"
- "\t\tparticular time range, (based on the Date: header) with:\n"
+ "\tFinally, results can be restricted to only messages within a\n"
+ "\tparticular time range, (based on the Date: header) with:\n"
"\n"
- "\t\t\t<intial-timestamp>..<final-timestamp>\n"
+ "\t\t<intial-timestamp>..<final-timestamp>\n"
"\n"
- "\t\tEach timestamp is a number representing the number of seconds\n"
- "\t\tsince 1970-01-01 00:00:00 UTC. This is not the most convenient\n"
- "\t\tmeans of expressing date ranges, but until notmuch is fixed to\n"
- "\t\taccept a more convenient form, one can use the date program to\n"
- "\t\tconstruct timestamps. For example, with the bash shell the\n"
- "\t\tfollowing syntax would specify a date range to return messages\n"
- "\t\tfrom 2009-10-01 until the current time:\n"
+ "\tEach timestamp is a number representing the number of seconds\n"
+ "\tsince 1970-01-01 00:00:00 UTC. This is not the most convenient\n"
+ "\tmeans of expressing date ranges, but until notmuch is fixed to\n"
+ "\taccept a more convenient form, one can use the date program to\n"
+ "\tconstruct timestamps. For example, with the bash shell the\n"
+ "\tfollowing syntax would specify a date range to return messages\n"
+ "\tfrom 2009-10-01 until the current time:\n"
"\n"
- "\t\t\t$(date +%%s -d 2009-10-01)..$(date +%%s)\n\n";
+ "\t\t$(date +%%s -d 2009-10-01)..$(date +%%s)\n\n";
command_t commands[] = {
{ "setup", notmuch_setup_command,
NULL,
"Interactively setup notmuch for first use.",
- "\t\tThe setup command will prompt for your full name, your primary\n"
- "\t\temail address, any alternate email addresses you use, and the\n"
- "\t\tdirectory containing your email archives. Your answers will be\n"
- "\t\twritten to a configuration file in ${NOTMUCH_CONFIG} (if set)\n"
- "\t\tor ${HOME}/.notmuch-config.\n"
- "\n"
- "\t\tThis configuration file will be created with descriptive\n"
- "\t\tcomments, making it easy to edit by hand later to change the\n"
- "\t\tconfiguration. Or you can run \"notmuch setup\" again.\n"
- "\n"
- "\t\tInvoking notmuch with no command argument will run setup if\n"
- "\t\tthe setup command has not previously been completed." },
+ "\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.",
- "\t\tScans all sub-directories of the mail directory, performing\n"
- "\t\tfull-text indexing on new messages that are found. Each new\n"
- "\t\tmessage will be tagged as both \"inbox\" and \"unread\".\n"
+ "\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"
- "\t\tYou should run \"notmuch new\" once after first running\n"
- "\t\t\"notmuch setup\" to create the initial database. The first\n"
- "\t\trun may take a long time if you have a significant amount of\n"
- "\t\tmail (several hundred thousand messages or more).\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"
- "\t\tSubsequently, you should run \"notmuch new\" whenever new mail\n"
- "\t\tis delivered and you wish to incorporate it into the database.\n"
- "\t\tThese subsequent runs will be much quicker than the initial run.\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"
- "\t\tSupported options for new include:\n"
+ "\tSupported options for new include:\n"
"\n"
- "\t\t--verbose\n"
+ "\t--verbose\n"
"\n"
- "\t\t\tVerbose operation. Shows paths of message files as\n"
- "\t\t\tthey are being indexed.\n"
+ "\t\tVerbose operation. Shows paths of message files as\n"
+ "\t\tthey are being indexed.\n"
"\n"
- "\t\tInvoking notmuch with no command argument will run new if\n"
- "\t\tthe setup command has previously been completed, but new has\n"
- "\t\tnot previously been run." },
+ "\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.",
- "\t\tNote that the individual mail messages will be matched\n"
- "\t\tagainst the search terms, but the results will be the\n"
- "\t\tthreads (one per line) containing the matched messages.\n"
+ "\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"
- "\t\tSupported options for search include:\n"
+ "\tSupported options for search include:\n"
"\n"
- "\t\t--format=(json|text)\n"
+ "\t--format=(json|text)\n"
"\n"
- "\t\t\tPresents the results in either JSON or\n"
- "\t\t\tplain-text (default)\n"
+ "\t\tPresents the results in either JSON or\n"
+ "\t\tplain-text (default)\n"
"\n"
- "\t\t--sort=(newest-first|oldest-first)\n"
+ "\t--sort=(newest-first|oldest-first)\n"
"\n"
- "\t\t\tPresent results in either chronological order\n"
- "\t\t\t(oldest-first) or reverse chronological order\n"
- "\t\t\t(newest-first), which is the default.\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"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
+ "\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.",
- "\t\tThe messages are grouped and sorted based on the threading\n"
- "\t\t(all replies to a particular message appear immediately\n"
- "\t\tafter that message in date order).\n"
+ "\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"
- "\t\tSupported options for show include:\n"
+ "\tSupported options for show include:\n"
"\n"
- "\t\t--entire-thread\n"
+ "\t--entire-thread\n"
"\n"
- "\t\t\tBy default only those messages that match the\n"
- "\t\t\tsearch terms will be displayed. With this option,\n"
- "\t\t\tall messages in the same thread as any matched\n"
- "\t\t\tmessage will be displayed.\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\t--format=(json|text)\n"
+ "\t--format=(json|text)\n"
"\n"
- "\t\t\ttext\t(default)\n"
+ "\t\ttext\t(default)\n"
"\n"
- "\t\t\tThe plain-text has all text-content MIME parts decoded.\n"
- "\t\t\tVarious components in the output, ('message', 'header',\n"
- "\t\t\t'body', 'attachment', and MIME 'part') are delimited by\n"
- "\t\t\teasily-parsed markers. Each marker consists of a Control-L\n"
- "\t\t\tcharacter (ASCII decimal 12), the name of the marker, and\n"
- "\t\t\tthen either an opening or closing brace, '{' or '}' to\n"
- "\t\t\teither open or close the component.\n"
+ "\t\tThe plain-text has all text-content MIME parts decoded.\n"
+ "\t\tVarious 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\t\tjson\n"
+ "\t\tjson\n"
"\n"
- "\t\t\tFormat output as Javascript Object Notation (JSON).\n"
- "\t\t\tJSON output always includes all messages in a matching,\n"
- "\t\t\tthread i.e. '--output=json' implies '--entire-thread'\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"
"\n"
- "\t\tA common use of \"notmuch show\" is to display a single\n"
- "\t\tthread of email messages. For this, use a search term of\n"
- "\t\t\"thread:<thread-id>\" as can be seen in the first column\n"
- "\t\tof output from the \"notmuch search\" command.\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"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
+ "\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.",
- "\t\tThe number of matching messages is output to stdout.\n"
+ "\tThe number of matching messages is output to stdout.\n"
"\n"
- "\t\tA common use of \"notmuch count\" is to display the count\n"
- "\t\tof messages matching both a specific tag and either inbox\n"
- "\t\tor unread\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"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
+ "\tSee \"notmuch help search-terms\" for details of the search\n"
"\t\tterms syntax." },
{ "reply", notmuch_reply_command,
"[options...] <search-terms> [...]",
"Construct a reply template for a set of messages.",
- "\t\tConstructs a new message as a reply to a set of existing\n"
- "\t\tmessages. The Reply-To: header (if any, otherwise From:) is\n"
- "\t\tused for the To: address. The To: and Cc: headers are copied,\n"
- "\t\tbut not including any of the user's configured addresses.\n"
+ "\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"
- "\t\tA suitable subject is constructed. The In-Reply-to: and\n"
- "\t\tReferences: headers are set appropriately, and the content\n"
- "\t\tof the original messages is quoted and included in the body\n"
- "\t\t(unless --format=headers-only is given).\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"
- "\t\tThe resulting message template is output to stdout.\n"
+ "\tThe resulting message template is output to stdout.\n"
"\n"
- "\t\tSupported options for reply include:\n"
+ "\tSupported options for reply include:\n"
"\n"
- "\t\t--format=(default|headers-only)\n"
+ "\t--format=(default|headers-only)\n"
"\n"
- "\t\t\tdefault:\n"
- "\t\t\t\tIncludes subject and quoted message body.\n"
+ "\t\tdefault:\n"
+ "\t\t\tIncludes subject and quoted message body.\n"
"\n"
- "\t\t\theaders-only:\n"
- "\t\t\t\tOnly produces In-Reply-To, References, To\n"
- "\t\t\t\tCc, and Bcc headers.\n"
+ "\t\theaders-only:\n"
+ "\t\t\tOnly produces In-Reply-To, References, To\n"
+ "\t\t\tCc, and Bcc headers.\n"
"\n"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
+ "\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.",
- "\t\tThe search terms are handled exactly as in 'search' so one\n"
- "\t\tcan use that command first to see what will be modified.\n"
+ "\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"
- "\t\tTags prefixed by '+' are added while those prefixed by\n"
- "\t\t'-' are removed. For each message, tag removal is performed\n"
- "\t\tbefore tag addition.\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"
- "\t\tThe beginning of <search-terms> is recognized by the first\n"
- "\t\targument that begins with neither '+' nor '-'. Support for\n"
- "\t\tan initial search term beginning with '+' or '-' is provided\n"
- "\t\tby allowing the user to specify a \"--\" argument to separate\n"
- "\t\tthe tags from the search terms.\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"
- "\t\tSee \"notmuch help search-terms\" for details of the search\n"
- "\t\tterms syntax." },
+ "\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.",
- "\t\tOutput is to the given filename, if any, or to stdout.\n"
- "\t\tThese tags are the only data in the notmuch database\n"
- "\t\tthat can't be recreated from the messages themselves.\n"
- "\t\tThe output of notmuch dump is therefore the only\n"
- "\t\tcritical thing to backup (and much more friendly to\n"
- "\t\tincremental backup than the native database files.)" },
+ "\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').",
- "\t\tNote: The dump file format is specifically chosen to be\n"
- "\t\tcompatible with the format of files produced by sup-dump.\n"
- "\t\tSo if you've previously been using sup for mail, then the\n"
- "\t\t\"notmuch restore\" command provides you a way to import\n"
- "\t\tall of your tags (or labels as sup calls them)." },
+ "\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.",
- "\t\tRun this command without any search-term(s) to obtain a list\n"
- "\t\tof all tags found in the database. If you provide one or more\n"
- "\t\tsearch-terms as argument(s) then the resulting list will\n"
- "\t\tcontain tags only from messages that match the search-term(s).\n"
+ "\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"
- "\t\tIn both cases the list will be alphabetically sorted." },
+ "\tIn both cases the list will be alphabetically sorted." },
{ "help", notmuch_help_command,
"[<command>]",
"This message, or more detailed help for the named command.",
- "\t\tExcept in this case, where there's not much more detailed\n"
- "\t\thelp available." }
+ "\tExcept in this case, where there's not much more detailed\n"
+ "\thelp available." }
};
static void
if (strcmp (argv[0], command->name) == 0) {
printf ("Help for \"notmuch %s\":\n\n", argv[0]);
if (command->arguments)
- printf ("\t%s\t%s\n\n\t\t%s\n\n%s\n\n",
+ printf ("%s %s\n\n\t%s\n\n%s\n\n",
command->name, command->arguments,
command->summary, command->documentation);
else
- printf ("\t%s\t%s\n\n%s\n\n", command->name,
+ printf ("%s\t%s\n\n%s\n\n", command->name,
command->summary, command->documentation);
return 0;
}
projects / notmuch.git / commitdiff