+.. _notmuch-emacs-mua(1):
+
=================
notmuch-emacs-mua
=================
SYNOPSIS
========
-**notmuch-emacs-mua** [options ...] [<to-address> ...]
+**notmuch** **emacs-mua** [options ...] [<to-address> ... | <mailto-url>]
DESCRIPTION
===========
Start composing an email in the Notmuch Emacs UI with the specified
-subject, recipients, and message body.
+subject, recipients, and message body, or mailto: URL.
+
+Supported options for **emacs-mua** include
+
+.. program:: emacs-mua
+
+.. option:: -h, --help
+
+ Display help.
+
+.. option:: -s, --subject=<subject>
+
+ Specify the subject of the message.
+
+.. option:: --to=<to-address>
+
+ Specify a recipient (To).
+
+.. option:: -c, --cc=<cc-address>
-Supported options for **notmuch-emacs-mua** include
+ Specify a carbon-copy (Cc) recipient.
- ``-h, --help``
- Display help.
+.. option:: -b, --bcc=<bcc-address>
- ``-s, --subject=``\ <subject>
- Specify the subject of the message.
+ Specify a blind-carbon-copy (Bcc) recipient.
- ``--to=``\ <to-address>
- Specify a recipient (To).
+.. option:: -i, --body=<file>
- ``-c, --cc=``\ <cc-address>
- Specify a carbon-copy (Cc) recipient.
+ Specify a file to include into the body of the message.
- ``-b, --bcc=``\ <bcc-address>
- Specify a blind-carbon-copy (Bcc) recipient.
+.. option:: --hello
- ``-i, --body=``\ <file>
- Specify a file to include into the body of the message.
+ Go to the Notmuch hello screen instead of the message composition
+ window if no message composition parameters are given.
- ``--no-window-system``
- Even if a window system is available, use the current terminal.
+.. option:: --no-window-system
- ``--client``
- Use **emacsclient**, rather than **emacs**. This will start
- an Emacs daemon process if necessary.
+ Even if a window system is available, use the current terminal.
- ``--print``
- Output the resulting elisp to stdout instead of evaluating it.
+.. option:: --client
+
+ Use :manpage:`emacsclient(1)`, rather than
+ :manpage:`emacs(1)`. For :manpage:`emacsclient(1)` to work, you
+ need an already running Emacs with a server, or use
+ ``--auto-daemon``.
+
+.. option:: --auto-daemon
+
+ Automatically start Emacs in daemon mode, if the Emacs server is
+ not running. Applicable with ``--client``. Implies
+ ``--create-frame``.
+
+.. option:: --create-frame
+
+ Create a new frame instead of trying to use the current Emacs
+ frame. Applicable with ``--client``. This will be required when
+ Emacs is running (or automatically started with ``--auto-daemon``)
+ in daemon mode.
+
+.. option:: --print
+
+ Output the resulting elisp to stdout instead of evaluating it.
The supported positional parameters and short options are a compatible
-subset of the **mutt** MUA command-line options.
+subset of the :manpage:`mutt(1)` MUA command-line options. The options
+and positional parameters modifying the message can't be combined with
+the mailto: URL.
Options may be specified multiple times.
ENVIRONMENT VARIABLES
=====================
-**EMACS**
- Name of emacs command to invoke. Defaults to "emacs".
+.. envvar:: EMACS
+
+ Name of emacs command to invoke. Defaults to "emacs".
+
+.. envvar:: EMACSCLIENT
-**EMACSCLIENT**
- Name of emacsclient command to invoke. Defaults to "emacsclient".
+ Name of emacsclient command to invoke. Defaults to "emacsclient".
SEE ALSO
========
-**notmuch(1)**, **emacsclient(1)**, **mutt(1)**
+:any:`notmuch(1)`,
+:manpage:`emacsclient(1)`,
+:manpage:`mutt(1)`