notmuch/doc/man1/notmuch-emacs-mua.rst
Jani Nikula 574b2436ee doc: use envvar directive and role for environment variables
Make man1/notmuch.rst the single point of truth for describing notmuch
environment variables. Use the envvar directive for that, and
reference them with the envvar role.

Drive-by cleanup configuration file and hook directory search order
documentation.
2021-05-22 16:41:20 -03:00

88 lines
2.2 KiB
ReStructuredText

.. _notmuch-emacs-mua(1):
=================
notmuch-emacs-mua
=================
SYNOPSIS
========
**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, or mailto: URL.
Supported options for **emacs-mua** include
``-h, --help``
Display help.
``-s, --subject=``\ <subject>
Specify the subject of the message.
``--to=``\ <to-address>
Specify a recipient (To).
``-c, --cc=``\ <cc-address>
Specify a carbon-copy (Cc) recipient.
``-b, --bcc=``\ <bcc-address>
Specify a blind-carbon-copy (Bcc) recipient.
``-i, --body=``\ <file>
Specify a file to include into the body of the message.
``--hello``
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.
``--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``.
``--auto-daemon``
Automatically start Emacs in daemon mode, if the Emacs server is
not running. Applicable with ``--client``. Implies
``--create-frame``.
``--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.
``--print``
Output the resulting elisp to stdout instead of evaluating it.
The supported positional parameters and short options are a compatible
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
=====================
.. envvar:: EMACS
Name of emacs command to invoke. Defaults to "emacs".
.. envvar:: EMACSCLIENT
Name of emacsclient command to invoke. Defaults to "emacsclient".
SEE ALSO
========
:any:`notmuch(1)`,
:manpage:`emacsclient(1)`,
:manpage:`mutt(1)`