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

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