notmuch-emacs-mua: do not create a frame by default with --client
[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> ...]
9
10 DESCRIPTION
11 ===========
12
13 Start composing an email in the Notmuch Emacs UI with the specified
14 subject, recipients, and message body.
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``.
47
48     ``--create-frame``
49         Create a new frame instead of trying to use the current Emacs
50         frame. Applicable with ``--client``. This will be required
51         when Emacs is running (or automatically started with
52         ``--auto-daemon``) in daemon mode.
53
54     ``--print``
55         Output the resulting elisp to stdout instead of evaluating it.
56
57 The supported positional parameters and short options are a compatible
58 subset of the **mutt** MUA command-line options.
59
60 Options may be specified multiple times.
61
62 ENVIRONMENT VARIABLES
63 =====================
64
65 **EMACS**
66     Name of emacs command to invoke. Defaults to "emacs".
67
68 **EMACSCLIENT**
69     Name of emacsclient command to invoke. Defaults to "emacsclient".
70
71 SEE ALSO
72 ========
73
74 **notmuch(1)**, **emacsclient(1)**, **mutt(1)**