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