X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-emacs-mua.rst;h=c0d5b1a7c4768d1c2bc301da57c0e5db773faaa0;hb=574b2436eeabf60c930ba227931ee87b0b151a65;hp=87787e20e531157b6ebc18a6d5d852634edc8ae0;hpb=ab022657776af0bb47e72caf2517464ca59e7d48;p=notmuch diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst index 87787e20..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 ================= @@ -15,67 +17,72 @@ subject, recipients, and message body, or mailto: URL. Supported options for **emacs-mua** include - ``-h, --help`` - Display help. +``-h, --help`` + Display help. - ``-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. +``--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. - ``--client`` - Use **emacsclient**, rather than **emacs**. For - **emacsclient** to work, you need an already running Emacs - with a server, or use ``--auto-daemon``. +``--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``. - ``--auto-daemon`` - Automatically start Emacs in daemon mode, if the Emacs server - is not running. Applicable with ``--client``. Implies - ``--create-frame``. +``--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. +``--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. +``--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)`