debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 10:58:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/doc/man1/notmuch-emacs-mua.rst

103 lines
2.3 KiB
ReStructuredText
Raw Normal View History

doc: cross-reference notmuch man pages with actual links Add internal hyperlink targets for man pages and cross-reference them using the any role reference. There are a number of alternatives to accomplish this, but this seems like the combination that retains the man page section number and the same boldface style in the man pages. As a bonus, we get sanity checking on the links; for example notmuch-search-terms.rst had a reference to notmuch-properties(1) i.e. the wrong section. The obvious semantic follow-up change would be to only have meaningful "see also" references instead of having them all everywhere.
2021-05-21 22:44:10 +02:00
.. _notmuch-emacs-mua(1):
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
=================
notmuch-emacs-mua
=================
SYNOPSIS
========
man: advertize notmuch-emacs-mua as notmuch emacs-mua subcommand With subcommand handling for external commands we can now hide the implementation detail of emacs-mua being a separate notmuch-emacs-mua script.
2016-11-21 22:13:34 +01:00
**notmuch** **emacs-mua** [options ...] [<to-address> ... | <mailto-url>]
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
DESCRIPTION
===========
Start composing an email in the Notmuch Emacs UI with the specified
notmuch-emacs-mua: add support for mailto: URL handling Add support for composing an email in the Notmuch Emacs UI using a mailto: URL. The mailto: URL mode is mutually exclusive with specifying other message modifying parameters and positional arguments.
2016-10-22 13:22:49 +02:00
subject, recipients, and message body, or mailto: URL.
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
man: advertize notmuch-emacs-mua as notmuch emacs-mua subcommand With subcommand handling for external commands we can now hide the implementation detail of emacs-mua being a separate notmuch-emacs-mua script.
2016-11-21 22:13:34 +01:00
Supported options for **emacs-mua** include
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. program:: emacs-mua
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. option:: -h, --help
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
Display help.
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. option:: -s, --subject=<subject>
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
Specify the subject of the message.
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. option:: --to=<to-address>
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
Specify a recipient (To).
notmuch-emacs-mua: add --hello parameter If the --hello parameter is given, display the notmuch hello buffer instead of the message composition buffer if no message composition parameters are given. Signed-off-by: Jani Nikula <jani@nikula.org>
2016-11-21 22:13:36 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. option:: -c, --cc=<cc-address>
man: clean up notmuch-emacs-mua man page Move --client description to a more suitable location, stylistic changes.
2015-08-15 11:05:11 +02:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
Specify a carbon-copy (Cc) recipient.
notmuch-emacs-mua: add --auto-daemon option to start Emacs daemon as needed Automatically starting Emacs in daemon mode if the Emacs server is not running is a matter of preference better not hard coded in notmuch-emacs-mua. Add an option to control the behaviour.
2015-08-15 11:05:14 +02:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. option:: -b, --bcc=<bcc-address>
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
Specify a blind-carbon-copy (Bcc) recipient.
notmuch-emacs-mua: do not create a frame by default with --client Make the default behaviour for --client the same as emacsclient default: do not create a new frame. Add a new option --create-frame, passing the same option to emacsclient to create a frame.
2015-08-15 11:05:15 +02:00
doc: use program and option directives to document options Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
2021-05-21 22:44:12 +02:00
.. option:: -i, --body=<file>
Specify a file to include into the body of the message.
.. option:: --hello
Go to the Notmuch hello screen instead of the message composition
window if no message composition parameters are given.
.. option:: --no-window-system
Even if a window system is available, use the current terminal.
.. option:: --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``.
.. 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.
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
The supported positional parameters and short options are a compatible
doc: use manpage role references to external man pages Using manpage role references generates helpful links in html documentation, while retaining the same boldface style in the man pages. The external man page site is configurable. The Debian manpage site seems like a good fit for Notmuch.
2021-05-21 22:44:09 +02:00
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.
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
Options may be specified multiple times.
ENVIRONMENT VARIABLES
=====================
doc: use envvar directive and role for environment variables Make man1/notmuch.rst the single point of truth for describing notmuch environment variables. Use the envvar directive for that, and reference them with the envvar role. Drive-by cleanup configuration file and hook directory search order documentation.
2021-05-21 22:44:11 +02:00
.. envvar:: EMACS
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
doc: use envvar directive and role for environment variables Make man1/notmuch.rst the single point of truth for describing notmuch environment variables. Use the envvar directive for that, and reference them with the envvar role. Drive-by cleanup configuration file and hook directory search order documentation.
2021-05-21 22:44:11 +02:00
Name of emacs command to invoke. Defaults to "emacs".
.. envvar:: EMACSCLIENT
Name of emacsclient command to invoke. Defaults to "emacsclient".
cli: add a tool for starting new message in the emacs ui Add a tool to start composing an email in the Notmuch Emacs UI with the specified subject, recipients, and message body.
2015-02-22 21:34:44 +01:00
SEE ALSO
========
doc: cross-reference notmuch man pages with actual links Add internal hyperlink targets for man pages and cross-reference them using the any role reference. There are a number of alternatives to accomplish this, but this seems like the combination that retains the man page section number and the same boldface style in the man pages. As a bonus, we get sanity checking on the links; for example notmuch-search-terms.rst had a reference to notmuch-properties(1) i.e. the wrong section. The obvious semantic follow-up change would be to only have meaningful "see also" references instead of having them all everywhere.
2021-05-21 22:44:10 +02:00
:any:`notmuch(1)`,
doc: use manpage role references to external man pages Using manpage role references generates helpful links in html documentation, while retaining the same boldface style in the man pages. The external man page site is configurable. The Debian manpage site seems like a good fit for Notmuch.
2021-05-21 22:44:09 +02:00
:manpage:`emacsclient(1)`,
:manpage:`mutt(1)`
Reference in a new issue Copy permalink