cli: add a tool for starting new message in the emacs ui

[notmuch] / doc / man1 / notmuch-emacs-mua.rst

diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst
new file mode 100644 (file)
index 0000000..eb47098
--- /dev/null
+++ b/doc/man1/notmuch-emacs-mua.rst
@@ -0,0 +1,63 @@
+=================
+notmuch-emacs-mua
+=================
+
+SYNOPSIS
+========
+
+**notmuch-emacs-mua** [options ...] [<to-address> ...]
+
+DESCRIPTION
+===========
+
+Start composing an email in the Notmuch Emacs UI with the specified
+subject, recipients, and message body.
+
+Supported options for **notmuch-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.
+
+    ``--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.
+
+    ``--no-window-system``
+        Even if a window system is available, use the current terminal
+
+    ``--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.
+
+Options may be specified multiple times.
+
+ENVIRONMENT VARIABLES
+=====================
+
+``EMACS``
+Name of emacs command to invoke
+
+``EMACSCLIENT``
+Name of emacsclient comment to invoke
+
+SEE ALSO
+========
+
+**notmuch(1)**, **emacsclient(1)**, **mutt(1)**