X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-emacs-mua.rst;h=a0476136f50340f9869d858a079b29e755e2df6a;hp=651d00fa4eb8e665cb2f910727c293019bba3c52;hb=HEAD;hpb=518843747835903b77889da30ce8c4518a5c0574 diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst index 651d00fa..d8af08bd 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,7 +7,7 @@ notmuch-emacs-mua SYNOPSIS ======== -**notmuch-emacs-mua** [options ...] [ ... | ] +**notmuch** **emacs-mua** [options ...] [ ... | ] DESCRIPTION =========== @@ -13,65 +15,88 @@ DESCRIPTION Start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body, or mailto: URL. -Supported options for **notmuch-emacs-mua** include +Supported options for **emacs-mua** include + +.. program:: emacs-mua + +.. option:: -h, --help + + Display help. + +.. option:: -s, --subject= + + Specify the subject of the message. + +.. option:: --to= + + Specify a recipient (To). + +.. option:: -c, --cc= - ``-h, --help`` - Display help. + Specify a carbon-copy (Cc) recipient. - ``-s, --subject=``\ - Specify the subject of the message. +.. option:: -b, --bcc= - ``--to=``\ - Specify a recipient (To). + Specify a blind-carbon-copy (Bcc) recipient. - ``-c, --cc=``\ - Specify a carbon-copy (Cc) recipient. +.. option:: -i, --body= - ``-b, --bcc=``\ - Specify a blind-carbon-copy (Bcc) recipient. + Specify a file to include into the body of the message. - ``-i, --body=``\ - Specify a file to include into the body of the message. +.. option:: --hello - ``--no-window-system`` - Even if a window system is available, use the current terminal. + Go to the Notmuch hello screen instead of the message composition + window if no message composition parameters are given. - ``--client`` - Use **emacsclient**, rather than **emacs**. For - **emacsclient** to work, you need an already running Emacs - with a server, or use ``--auto-daemon``. +.. option:: --no-window-system - ``--auto-daemon`` - Automatically start Emacs in daemon mode, if the Emacs server - is not running. Applicable with ``--client``. Implies - ``--create-frame``. + Even if a window system is available, use the current terminal. - ``--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. +.. option:: --client - ``--print`` - Output the resulting elisp to stdout instead of evaluating it. + 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``. + +.. option:: --auto-daemon + + Automatically start Emacs in daemon mode, if the Emacs server is + not running. Applicable with ``--client``. Implies + ``--create-frame``. + +.. option:: --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. + +.. option:: --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. The options and -positional parameters modifying the message can't be combined with the -mailto: URL. +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)`