X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-emacs-mua.rst;h=a0476136f50340f9869d858a079b29e755e2df6a;hb=018ad3703ba46ea603854f51f8ff5ae86183cca0;hp=eb47098e11ca27299b50b85243456fa9ef7cb449;hpb=f4a5a534c8312bc46b7c561d5f4d26600a532d96;p=notmuch diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst index eb47098e..a0476136 100644 --- a/doc/man1/notmuch-emacs-mua.rst +++ b/doc/man1/notmuch-emacs-mua.rst @@ -5,57 +5,75 @@ 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 **notmuch-emacs-mua** include +Supported options for **emacs-mua** include - ``-h, --help`` - Display help. +``-h, --help`` + Display help. - ``-C, --client`` - Use emacsclient, rather than emacs. This will start - an emacs daemon process if necessary. +``-s, --subject=``\ + Specify the subject of the message. - ``-s, --subject=``\ - Specify the subject of the message. +``--to=``\ + Specify a recipient (To). - ``--to=``\ - Specify a recipient (To). +``-c, --cc=``\ + Specify a carbon-copy (Cc) recipient. - ``-c, --cc=``\ - Specify a carbon-copy (Cc) recipient. +``-b, --bcc=``\ + Specify a blind-carbon-copy (Bcc) recipient. - ``-b, --bcc=``\ - Specify a blind-carbon-copy (Bcc) recipient. +``-i, --body=``\ + Specify a file to include into the body of the message. - ``-i, --body=``\ - Specify a file to include into the body of the message. +``--hello`` + Go to the Notmuch hello screen instead of the message composition + window if no message composition parameters are given. - ``--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. - ``--print`` - Output the resulting elisp to stdout instead of evaluating it. +``--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 ========