mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-26 19:34:51 +01:00
f2e2f2aa96
Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
102 lines
2.3 KiB
ReStructuredText
102 lines
2.3 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
|
|
|
|
.. 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>
|
|
|
|
Specify a carbon-copy (Cc) recipient.
|
|
|
|
.. option:: -b, --bcc=<bcc-address>
|
|
|
|
Specify a blind-carbon-copy (Bcc) recipient.
|
|
|
|
.. option:: -i, --body=<file>
|
|
|
|
Specify a file to include into the body of the message.
|
|
|
|
.. option:: --hello
|
|
|
|
Go to the Notmuch hello screen instead of the message composition
|
|
window if no message composition parameters are given.
|
|
|
|
.. option:: --no-window-system
|
|
|
|
Even if a window system is available, use the current terminal.
|
|
|
|
.. 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 :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)`
|