]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-emacs-mua.rst
man: advertize notmuch-emacs-mua as notmuch emacs-mua subcommand
[notmuch] / doc / man1 / notmuch-emacs-mua.rst
index eb47098e11ca27299b50b85243456fa9ef7cb449..b80aa5f9b2e59aba9a08aba10d4878663fca79af 100644 (file)
@@ -5,23 +5,19 @@ 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 **notmuch-emacs-mua** include
+Supported options for **emacs-mua** include
 
     ``-h, --help``
         Display help.
 
-    ``-C, --client``
-        Use emacsclient, rather than emacs. This will start
-        an emacs daemon process if necessary.
-
     ``-s, --subject=``\ <subject>
         Specify the subject of the message.
 
@@ -38,24 +34,42 @@ Supported options for **notmuch-emacs-mua** include
         Specify a file to include into the body of the message.
 
     ``--no-window-system``
-        Even if a window system is available, use the current terminal
+        Even if a window system is available, use the current terminal.
+
+    ``--client``
+        Use **emacsclient**, rather than **emacs**. For
+        **emacsclient** 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 **mutt** MUA command-line options.
+subset of the **mutt** 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
+**EMACS**
+    Name of emacs command to invoke. Defaults to "emacs".
 
-``EMACSCLIENT``
-Name of emacsclient comment to invoke
+**EMACSCLIENT**
+    Name of emacsclient command to invoke. Defaults to "emacsclient".
 
 SEE ALSO
 ========