aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJani Nikula <jani@nikula.org>2015-02-22 21:34:44 +0100
committerDavid Bremner <david@tethera.net>2015-03-06 08:02:08 +0100
commitf4a5a534c8312bc46b7c561d5f4d26600a532d96 (patch)
tree2f3143927bfb51d27a372b6252e5ad84f54bfe76 /doc
parentee2d490280a939ca91dd184bece2bd53582b8e54 (diff)
cli: add a tool for starting new message in the emacs ui
Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
Diffstat (limited to 'doc')
-rw-r--r--doc/conf.py4
-rw-r--r--doc/man1/notmuch-emacs-mua.rst63
2 files changed, 67 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py
index fb49f6eb..8fbc8544 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -78,6 +78,10 @@ man_pages = [
u'creates a plain-text dump of the tags of each message',
[u'Carl Worth and many others'], 1),
+('man1/notmuch-emacs-mua','notmuch-emacs-mua',
+ u'send mail with notmuch and emacs',
+ [u'Carl Worth and many others'], 1),
+
('man5/notmuch-hooks','notmuch-hooks',
u'hooks for notmuch',
[u'Carl Worth and many others'], 5),
diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst
new file mode 100644
index 00000000..eb47098e
--- /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)**