git.cworth.org Git - notmuch/blob - doc/man1/notmuch-emacs-mua.rst

   1 .. _notmuch-emacs-mua(1):
   2
   3 =================
   4 notmuch-emacs-mua
   5 =================
   6
   7 SYNOPSIS
   8 ========
   9
  10 **notmuch** **emacs-mua** [options ...] [<to-address> ... | <mailto-url>]
  11
  12 DESCRIPTION
  13 ===========
  14
  15 Start composing an email in the Notmuch Emacs UI with the specified
  16 subject, recipients, and message body, or mailto: URL.
  17
  18 Supported options for **emacs-mua** include
  19
  20 ``-h, --help``
  21     Display help.
  22
  23 ``-s, --subject=``\ <subject>
  24     Specify the subject of the message.
  25
  26 ``--to=``\ <to-address>
  27     Specify a recipient (To).
  28
  29 ``-c, --cc=``\ <cc-address>
  30     Specify a carbon-copy (Cc) recipient.
  31
  32 ``-b, --bcc=``\ <bcc-address>
  33     Specify a blind-carbon-copy (Bcc) recipient.
  34
  35 ``-i, --body=``\ <file>
  36     Specify a file to include into the body of the message.
  37
  38 ``--hello``
  39     Go to the Notmuch hello screen instead of the message composition
  40     window if no message composition parameters are given.
  41
  42 ``--no-window-system``
  43     Even if a window system is available, use the current terminal.
  44
  45 ``--client``
  46     Use :manpage:`emacsclient(1)`, rather than
  47     :manpage:`emacs(1)`. For :manpage:`emacsclient(1)` to work, you
  48     need an already running Emacs with a server, or use
  49     ``--auto-daemon``.
  50
  51 ``--auto-daemon``
  52     Automatically start Emacs in daemon mode, if the Emacs server is
  53     not running. Applicable with ``--client``. Implies
  54     ``--create-frame``.
  55
  56 ``--create-frame``
  57     Create a new frame instead of trying to use the current Emacs
  58     frame. Applicable with ``--client``. This will be required when
  59     Emacs is running (or automatically started with ``--auto-daemon``)
  60     in daemon mode.
  61
  62 ``--print``
  63     Output the resulting elisp to stdout instead of evaluating it.
  64
  65 The supported positional parameters and short options are a compatible
  66 subset of the :manpage:`mutt(1)` MUA command-line options. The options
  67 and positional parameters modifying the message can't be combined with
  68 the mailto: URL.
  69
  70 Options may be specified multiple times.
  71
  72 ENVIRONMENT VARIABLES
  73 =====================
  74
  75 .. envvar:: EMACS
  76
  77    Name of emacs command to invoke. Defaults to "emacs".
  78
  79 .. envvar:: EMACSCLIENT
  80
  81    Name of emacsclient command to invoke. Defaults to "emacsclient".
  82
  83 SEE ALSO
  84 ========
  85
  86 :any:`notmuch(1)`,
  87 :manpage:`emacsclient(1)`,
  88 :manpage:`mutt(1)`