]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-emacs-mua.rst
emacs: Add new option notmuch-search-hide-excluded
[notmuch] / doc / man1 / notmuch-emacs-mua.rst
index 87787e20e531157b6ebc18a6d5d852634edc8ae0..d8af08bda47a530dac1827a28c55fa976fe96e0a 100644 (file)
@@ -1,3 +1,5 @@
+.. _notmuch-emacs-mua(1):
+
 =================
 notmuch-emacs-mua
 =================
@@ -15,67 +17,86 @@ subject, recipients, and message body, or mailto: URL.
 
 Supported options for **emacs-mua** include
 
-    ``-h, --help``
-        Display help.
+.. program:: emacs-mua
+
+.. option:: -h, --help
+
+   Display help.
+
+.. option:: -s, --subject=<subject>
+
+   Specify the subject of the message.
+
+.. option:: --to=<to-address>
+
+   Specify a recipient (To).
+
+.. option:: -c, --cc=<cc-address>
 
-    ``-s, --subject=``\ <subject>
-        Specify the subject of the message.
+   Specify a carbon-copy (Cc) recipient.
 
-    ``--to=``\ <to-address>
-        Specify a recipient (To).
+.. option:: -b, --bcc=<bcc-address>
 
-    ``-c, --cc=``\ <cc-address>
-        Specify a carbon-copy (Cc) recipient.
+   Specify a blind-carbon-copy (Bcc) recipient.
 
-    ``-b, --bcc=``\ <bcc-address>
-        Specify a blind-carbon-copy (Bcc) recipient.
+.. option:: -i, --body=<file>
 
-    ``-i, --body=``\ <file>
-        Specify a file to include into the body of the message.
+   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.
+.. 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)`