git.cworth.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 :manpage:`emacsclient(1)`, rather than
  45     :manpage:`emacs(1)`. For :manpage:`emacsclient(1)` to work, you
  46     need an already running Emacs with a server, or use
  47     ``--auto-daemon``.
  48
  49 ``--auto-daemon``
  50     Automatically start Emacs in daemon mode, if the Emacs server is
  51     not running. Applicable with ``--client``. Implies
  52     ``--create-frame``.
  53
  54 ``--create-frame``
  55     Create a new frame instead of trying to use the current Emacs
  56     frame. Applicable with ``--client``. This will be required when
  57     Emacs is running (or automatically started with ``--auto-daemon``)
  58     in daemon mode.
  59
  60 ``--print``
  61     Output the resulting elisp to stdout instead of evaluating it.
  62
  63 The supported positional parameters and short options are a compatible
  64 subset of the :manpage:`mutt(1)` MUA command-line options. The options
  65 and positional parameters modifying the message can't be combined with
  66 the mailto: URL.
  67
  68 Options may be specified multiple times.
  69
  70 ENVIRONMENT VARIABLES
  71 =====================
  72
  73 **EMACS**
  74     Name of emacs command to invoke. Defaults to "emacs".
  75
  76 **EMACSCLIENT**
  77     Name of emacsclient command to invoke. Defaults to "emacsclient".
  78
  79 SEE ALSO
  80 ========
  81
  82 **notmuch(1)**,
  83 :manpage:`emacsclient(1)`,
  84 :manpage:`mutt(1)`