X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-emacs-mua.rst;h=87787e20e531157b6ebc18a6d5d852634edc8ae0;hp=32b7286391880dd4685c2219263a8b3d215b5e9b;hb=c5356b9ed56e42d36ca18206155b62c94cfbd79d;hpb=5240c438f5f6212fbce811ea4fd55ae964c97d99 diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst index 32b72863..87787e20 100644 --- a/doc/man1/notmuch-emacs-mua.rst +++ b/doc/man1/notmuch-emacs-mua.rst @@ -5,23 +5,19 @@ 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. - ``--client`` - Use emacsclient, rather than emacs. This will start - an emacs daemon process if necessary. - ``-s, --subject=``\ Specify the subject of the message. @@ -37,25 +33,47 @@ Supported options for **notmuch-emacs-mua** include ``-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 + 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 ========