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> ...]
   9
  10 DESCRIPTION
  11 ===========
  12
  13 Start composing an email in the Notmuch Emacs UI with the specified
  14 subject, recipients, and message body.
  15
  16 Supported options for **notmuch-emacs-mua** include
  17
  18     ``-h, --help``
  19         Display help.
  20
  21     ``--client``
  22         Use emacsclient, rather than emacs. This will start
  23         an emacs daemon process if necessary.
  24
  25     ``-s, --subject=``\ <subject>
  26         Specify the subject of the message.
  27
  28     ``--to=``\ <to-address>
  29         Specify a recipient (To).
  30
  31     ``-c, --cc=``\ <cc-address>
  32         Specify a carbon-copy (Cc) recipient.
  33
  34     ``-b, --bcc=``\ <bcc-address>
  35         Specify a blind-carbon-copy (Bcc) recipient.
  36
  37     ``-i, --body=``\ <file>
  38         Specify a file to include into the body of the message.
  39
  40     ``--no-window-system``
  41         Even if a window system is available, use the current terminal
  42
  43     ``--print``
  44         Output the resulting elisp to stdout instead of evaluating it.
  45
  46 The supported positional parameters and short options are a compatible
  47 subset of the **mutt** MUA command-line options.
  48
  49 Options may be specified multiple times.
  50
  51 ENVIRONMENT VARIABLES
  52 =====================
  53
  54 **EMACS**
  55     Name of emacs command to invoke. Defaults to "emacs".
  56
  57 **EMACSCLIENT**
  58     Name of emacsclient command to invoke. Defaults to "emacsclient".
  59
  60 SEE ALSO
  61 ========
  62
  63 **notmuch(1)**, **emacsclient(1)**, **mutt(1)**