X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-emacs-mua.rst;h=c0d5b1a7c4768d1c2bc301da57c0e5db773faaa0;hb=574b2436eeabf60c930ba227931ee87b0b151a65;hp=7c2f5c24f1c08c7e9af6ea16bea50c7a1e96171d;hpb=ac609e5a3b8d2f528cc65fd4661e25e5140a7baf;p=notmuch diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst index 7c2f5c24..c0d5b1a7 100644 --- a/doc/man1/notmuch-emacs-mua.rst +++ b/doc/man1/notmuch-emacs-mua.rst @@ -1,3 +1,5 @@ +.. _notmuch-emacs-mua(1): + ================= notmuch-emacs-mua ================= @@ -5,59 +7,82 @@ notmuch-emacs-mua SYNOPSIS ======== -**notmuch-emacs-mua** [options ...] [ ...] +**notmuch** **emacs-mua** [options ...] [ ... | ] 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 **emacs-mua** include + +``-h, --help`` + Display help. -Supported options for **notmuch-emacs-mua** include +``-s, --subject=``\ + Specify the subject of the message. - ``-h, --help`` - Display help. +``--to=``\ + Specify a recipient (To). - ``-s, --subject=``\ - Specify the subject of the message. +``-c, --cc=``\ + Specify a carbon-copy (Cc) recipient. - ``--to=``\ - Specify a recipient (To). +``-b, --bcc=``\ + Specify a blind-carbon-copy (Bcc) recipient. - ``-c, --cc=``\ - Specify a carbon-copy (Cc) recipient. +``-i, --body=``\ + Specify a file to include into the body of the message. - ``-b, --bcc=``\ - Specify a blind-carbon-copy (Bcc) recipient. +``--hello`` + Go to the Notmuch hello screen instead of the message composition + window if no message composition parameters are given. - ``-i, --body=``\ - 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. - ``--no-window-system`` - Even if a window system is available, use the current terminal. +``--client`` + Use :manpage:`emacsclient(1)`, rather than + :manpage:`emacs(1)`. For :manpage:`emacsclient(1)` to work, you + need an already running Emacs with a server, or use + ``--auto-daemon``. - ``--client`` - Use **emacsclient**, rather than **emacs**. This will start - an Emacs daemon process if necessary. +``--auto-daemon`` + Automatically start Emacs in daemon mode, if the Emacs server is + not running. Applicable with ``--client``. Implies + ``--create-frame``. - ``--print`` - Output the resulting elisp to stdout instead of evaluating it. +``--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 :manpage:`mutt(1)` 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. Defaults to "emacs". +.. envvar:: EMACS + + Name of emacs command to invoke. Defaults to "emacs". + +.. envvar:: EMACSCLIENT -**EMACSCLIENT** - Name of emacsclient command to invoke. Defaults to "emacsclient". + Name of emacsclient command to invoke. Defaults to "emacsclient". SEE ALSO ======== -**notmuch(1)**, **emacsclient(1)**, **mutt(1)** +:any:`notmuch(1)`, +:manpage:`emacsclient(1)`, +:manpage:`mutt(1)`