usage.c

Go to the documentation of this file.

 
#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "cli/lib.h"
#include "version.h"

static void print_header(const char *section, const char *desc, bool use_color)
{
  if (use_color)
    printf("\033[1;4m%s\033[0m: %s\n", section, desc);
  else
    printf("%s: %s\n", section, desc);
}

static void show_cli_overview(bool use_color)
{
  // L10N: Help Overview -- `neomutt --help`
  //       The modes are: help, info, send, tui
  //       Plus two helper modes: shared, all
  //       These should not be translated.
  printf("%s ", _("NeoMutt has four modes of operation:"));
  if (use_color)
    puts("\033[1;4mhelp\033[0m, \033[1;4minfo\033[0m, \033[1;4msend\033[0m, \033[1;4mtui\033[0m");
  else
    puts("help, info, send, tui");
 
  puts(_("The default mode, if no command line arguments are specified, is tui."));
  puts("");
 
  // L10N: Parameters in <>s may be translated
  print_header("shared", _("Options that apply to all modes"), use_color);
  puts(_("neomutt -n, --no-system-config       Don't read system config file"));
  puts(_("        -F, --config <file>          Use this user config file"));
  puts(_("        -e, --command <command>      Run extra commands"));
  puts(_("        -m, --mbox-type <type>       Set default mailbox type"));
  puts(_("        -d, --debug-level <level>    Set logging level (1..5)"));
  puts(_("        -l, --debug-file <file>      Set logging file"));
  puts("");
 
  print_header("help", _("Get command line help for NeoMutt"), use_color);
  puts(_("neomutt -h, --help <mode>            Detailed help for a mode"));
  puts(_("        -v, --version                Version"));
  puts(_("        -vv, --license               License"));
  puts("");
 
  print_header("info", _("Ask NeoMutt for config information"), use_color);
  puts(_("neomutt -A, --alias <alias> [...]             Lookup email aliases"));
  puts(_("        -D, --dump-config [-O] [-S]           Dump the config"));
  puts(_("        -DD, --dump-changed-config [-O] [-S]  Dump the changed config options"));
  puts(_("        -Q, --query <option> [...] [-O] [-S]  Query config options"));
  puts(_("        -O, --with-docs                       Add one-liner documentation"));
  puts(_("        -S, --hide-sensitive                  Hide sensitive option values"));
  puts("");
 
  print_header("send", _("Send an email from the command line"), use_color);
  puts(_("neomutt -a, --attach <file> [...]    Attach files"));
  puts(_("        -b, --bcc <address>          Add Bcc: address"));
  puts(_("        -C, --crypto                 Use crypto (signing/encryption)"));
  puts(_("        -c, --cc <address>           Add Cc: address"));
  puts(_("        -E, --edit-message           Edit message (draft/include)"));
  puts(_("        -H, --draft <file>           Use draft email file"));
  puts(_("        -i, --include <file>         Include body file"));
  puts(_("        -s, --subject <subject>      Set Subject:"));
  puts(_("        -- <address> [...]           Add To: addresses"));
  puts("");
 
  print_header("tui", _("Start NeoMutt's TUI (Terminal User Interface)"), use_color);
  puts(_("neomutt                              Start NeoMutt's TUI"));
  puts(_("        -f, --folder <mailbox>       Open this mailbox"));
  puts(_("        -G, --nntp-browser           Open NNTP browser"));
  puts(_("        -g, --nntp-server <server>   Use this NNTP server"));
  puts(_("        -p, --postponed              Resume postponed email"));
  puts(_("        -R, --read-only              Open mailbox read-only"));
  puts(_("        -y, --browser                Open mailbox browser"));
  puts(_("        -Z, --check-new-mail         Check for new mail"));
  puts(_("        -z, --check-any-mail         Check for any mail"));
  puts("");
 
  if (use_color)
    printf("%s \033[1m%s\033[0m\n", _("For detailed help, run:"), "neomutt --help all");
  else
    printf("%s %s\n", _("For detailed help, run:"), "neomutt --help all");
}

static void show_cli_shared(bool use_color)
{
  // L10N: Shared Help -- `neomutt --help shared`
  print_header("shared", _("Options that apply to all modes"), use_color);
  puts("");
 
  puts(_("By default NeoMutt loads one system and one user config file,"));
  puts(_("e.g. /etc/neomuttrc and ~/.neomuttrc"));
 
  // L10N: Parameters in <>s may be translated
  puts(_("  -n, --no-system-config      Don't read system config file"));
  puts(_("  -F, --config <file>         Use this user config file"));
  puts(_("                              May be used multiple times"));
  puts("");
 
  puts(_("These options override the config:"));
  puts(_("  -m, --mbox-type <type>      Set default mailbox type"));
  puts(_("                              May be: maildir, mbox, mh, mmdf"));
  puts(_("  -e, --command <command>     Run extra commands"));
  puts(_("                              May be used multiple times"));
  puts("");
 
  puts(_("These logging options override the config:"));
  puts(_("  -d, --debug-level <level>   Set logging level"));
  puts(_("                              0 (off), 1 (low) .. 5 (high)"));
  puts(_("  -l, --debug-file <file>     Set logging file"));
  puts(_("                              Default file '~/.neomuttdebug0'"));
  puts("");
 
  if (use_color)
    printf("\033[1m%s\033[0m\n", _("Examples:"));
  else
    printf("%s\n", _("Examples:"));
 
  // L10N: Examples: Filenames may be translated
  puts(_("  neomutt --no-system-config"));
  puts(_("  neomutt --config work.rc"));
  puts(_("  neomutt --config work.rc --config colours.rc"));
  puts("");
 
  puts(_("  neomutt --mbox-type maildir"));
  puts(_("  neomutt --command 'set ask_cc = yes'"));
  puts("");
 
  puts(_("  neomutt --debug-level 2"));
  puts(_("  neomutt --debug-level 5 --debug-file neolog"));
  puts("");
 
  puts(_("See also:"));
  puts(_("- Config files: https://neomutt.org/guide/configuration"));
}

static void show_cli_help(bool use_color)
{
  // L10N: Help Help -- `neomutt --help help`
  print_header("help", _("Get command line help for NeoMutt"), use_color);
  puts("");
 
  // L10N: Parameters in <>s may be translated
  puts(_("  -h, --help           Overview of command line options"));
  puts(_("  -h, --help <mode>    Detailed help for: shared, help, info, send, tui, all"));
  puts(_("  -v, --version        NeoMutt version and build parameters"));
  puts(_("  -vv, --license       NeoMutt Copyright and license"));
  puts("");
 
  if (use_color)
    printf("\033[1m%s\033[0m\n", _("Examples:"));
  else
    printf("%s\n", _("Examples:"));
 
  // L10N: Examples
  puts(_("  neomutt --help info"));
  puts(_("  neomutt --license"));
}

static void show_cli_info(bool use_color)
{
  // L10N: Info Help -- `neomutt --help info`
  print_header("info", _("Ask NeoMutt for config information"), use_color);
  puts("");
 
  // L10N: Parameters in <>s may be translated
  puts(_("  -A, --alias <alias> [...]   Lookup email aliases"));
  puts(_("                              Multiple aliases can be looked up (space-separated)"));
  puts("");
 
  puts(_("  -D, --dump-config           Dump all the config options"));
  puts(_("  -DD, --dump-changed-config  Dump the changed config options"));
  puts("");
 
  puts(_("  -Q, --query <option> [...]  Query config options"));
  puts(_("                              Multiple options can be looked up (space-separated)"));
 
  puts(_("Modify the -D and -Q options:"));
  puts(_("  -O, --with-docs             Add one-liner documentation"));
  puts(_("  -S, --hide-sensitive        Hide the value of sensitive options"));
  puts("");
 
  if (use_color)
    printf("\033[1m%s\033[0m\n", _("Examples:"));
  else
    printf("%s\n", _("Examples:"));
 
  // L10N: Examples
  puts(_("  neomutt --alias flatcap gahr"));
  puts(_("  neomutt --dump-config --with-docs"));
  puts(_("  neomutt --dump-changed-config --hide-sensitive"));
  puts(_("  neomutt --with-docs --query alias_format index_format"));
}

static void show_cli_send(bool use_color)
{
  // L10N: Sending Help -- `neomutt --help send`
  print_header("send", _("Send an email from the command line"), use_color);
  puts("");
 
  puts(_("These options can supply everything NeoMutt needs to send an email."));
  puts(_("If any parts are missing, NeoMutt will start the TUI to ask for them."));
  puts(_("Addresses may be used before the options, or after a -- marker."));
  puts(_("Aliases may be used in place of addresses."));
  puts("");
 
  // L10N: Parameters in <>s may be translated
  puts(_("  -a, --attach <file> [...]   Attach files"));
  puts(_("                              Terminated by -- or another option"));
  puts(_("  -b, --bcc <address>         Add Bcc: address"));
  puts(_("  -C, --crypto                Use crypto (signing/encryption)"));
  puts(_("                              Must be set up in the config file"));
  puts(_("  -c, --cc <address>          Add Cc: address"));
  puts(_("  -E, --edit-message          Edit message (draft/include)"));
  puts(_("                              (supplied by -H or -i)"));
  puts(_("  -H, --draft <file>          Use draft email file"));
  puts(_("                              Full email with headers and body"));
  puts(_("  -i, --include <file>        Include body file"));
  puts(_("  -s, --subject <subject>     Set Subject:"));
  puts(_("  -- <address> [...]          Add To: addresses"));
  puts("");
 
  if (use_color)
    printf("\033[1m%s\033[0m\n", _("Examples:"));
  else
    printf("%s\n", _("Examples:"));
 
  // L10N: Examples: Filenames and email subjects may be translated
  puts(_("  neomutt flatcap --subject 'Meeting' < meeting.txt"));
  puts(_("  neomutt jim@example.com --cc bob@example.com --subject 'Party' --include party.txt"));
  puts(_("  neomutt --subject 'Receipts' --attach receipt1.pdf receipt2.pdf -- rocco"));
  puts(_("  cat secret.txt | neomutt gahr --subject 'Secret' --crypto"));
}

static void show_cli_tui(bool use_color)
{
  // L10N: TUI Help -- `neomutt --help tui`
  print_header("tui", _("Start NeoMutt's TUI (Terminal User Interface)"), use_color);
  puts("");
 
  puts(_("Running NeoMutt with no options will read the config and start the TUI."));
  puts(_("By default, it will open the Index Dialog with the $spool_file Mailbox."));
  puts("");
 
  puts(_("These options cause NeoMutt to check a mailbox for mail."));
  puts(_("If the condition isn't matched, NeoMutt exits."));
  puts(_("  -p, --postponed       Resume postponed email"));
  puts(_("  -Z, --check-new-mail  Check for new mail"));
  puts(_("  -z, --check-any-mail  Check for any mail"));
  puts("");
 
  // L10N: Parameters in <>s may be translated
  puts(_("These options change the starting behavior:"));
  puts(_("  -f, --folder <mailbox>      Open this mailbox"));
  puts(_("  -G, --nntp-browser          Open NNTP browser"));
  puts(_("  -g, --nntp-server <server>  Use this NNTP server"));
  puts(_("  -R, --read-only             Open mailbox read-only"));
  puts(_("  -y, --browser               Open mailbox browser"));
  puts("");
 
  if (use_color)
    printf("\033[1m%s\033[0m\n", _("Examples:"));
  else
    printf("%s\n", _("Examples:"));
 
  // L10N: Examples: Path may be translated
  puts(_("  neomutt --folder ~/mail --check-new-mail"));
  puts(_("  neomutt --postponed"));
  puts(_("  neomutt --browser"));
}

void show_cli(enum HelpMode mode, bool use_color)
{
  if (use_color)
    printf("\033[38;5;255mNeoMutt %s\033[0m\n\n", mutt_make_version());
  else
    printf("NeoMutt %s\n\n", mutt_make_version());
 
  switch (mode)
  {
    case HM_NONE:
    {
      show_cli_overview(use_color);
      break;
    }
    case HM_SHARED:
    {
      show_cli_shared(use_color);
      break;
    }
    case HM_HELP:
    {
      show_cli_help(use_color);
      break;
    }
    case HM_INFO:
    {
      show_cli_info(use_color);
      break;
    }
    case HM_SEND:
    {
      show_cli_send(use_color);
      break;
    }
    case HM_TUI:
    {
      show_cli_tui(use_color);
      break;
    }
    case HM_ALL:
    {
      printf("------------------------------------------------------------\n");
      show_cli_shared(use_color);
      printf("\n------------------------------------------------------------\n");
      show_cli_help(use_color);
      printf("\n------------------------------------------------------------\n");
      show_cli_info(use_color);
      printf("\n------------------------------------------------------------\n");
      show_cli_send(use_color);
      printf("\n------------------------------------------------------------\n");
      show_cli_tui(use_color);
      printf("\n------------------------------------------------------------\n");
      break;
    }
  }
}