git.notmuchmail.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 .. program:: emacs-mua
  21
  22 .. option:: -h, --help
  23
  24    Display help.
  25
  26 .. option:: -s, --subject=<subject>
  27
  28    Specify the subject of the message.
  29
  30 .. option:: --to=<to-address>
  31
  32    Specify a recipient (To).
  33
  34 .. option:: -c, --cc=<cc-address>
  35
  36    Specify a carbon-copy (Cc) recipient.
  37
  38 .. option:: -b, --bcc=<bcc-address>
  39
  40    Specify a blind-carbon-copy (Bcc) recipient.
  41
  42 .. option:: -i, --body=<file>
  43
  44    Specify a file to include into the body of the message.
  45
  46 .. option:: --hello
  47
  48    Go to the Notmuch hello screen instead of the message composition
  49    window if no message composition parameters are given.
  50
  51 .. option:: --no-window-system
  52
  53    Even if a window system is available, use the current terminal.
  54
  55 .. option:: --client
  56
  57    Use :manpage:`emacsclient(1)`, rather than
  58    :manpage:`emacs(1)`. For :manpage:`emacsclient(1)` to work, you
  59    need an already running Emacs with a server, or use
  60    ``--auto-daemon``.
  61
  62 .. option:: --auto-daemon
  63
  64    Automatically start Emacs in daemon mode, if the Emacs server is
  65    not running. Applicable with ``--client``. Implies
  66    ``--create-frame``.
  67
  68 .. option:: --create-frame
  69
  70    Create a new frame instead of trying to use the current Emacs
  71    frame. Applicable with ``--client``. This will be required when
  72    Emacs is running (or automatically started with ``--auto-daemon``)
  73    in daemon mode.
  74
  75 .. option:: --print
  76
  77    Output the resulting elisp to stdout instead of evaluating it.
  78
  79 The supported positional parameters and short options are a compatible
  80 subset of the :manpage:`mutt(1)` MUA command-line options. The options
  81 and positional parameters modifying the message can't be combined with
  82 the mailto: URL.
  83
  84 Options may be specified multiple times.
  85
  86 ENVIRONMENT VARIABLES
  87 =====================
  88
  89 .. envvar:: EMACS
  90
  91    Name of emacs command to invoke. Defaults to "emacs".
  92
  93 .. envvar:: EMACSCLIENT
  94
  95    Name of emacsclient command to invoke. Defaults to "emacsclient".
  96
  97 SEE ALSO
  98 ========
  99
 100 :any:`notmuch(1)`,
 101 :manpage:`emacsclient(1)`,
 102 :manpage:`mutt(1)`