fish-shell/sphinx_doc_src/cmds/emit.rst

.. _cmd-emit:

emit - Emit a generic event
===========================

Synopsis
--------

::

    emit EVENT_NAME [ARGUMENTS...]

Description
-----------

``emit`` emits, or fires, an event. Events are delivered to, or caught by, special functions called :ref:`event handlers <event>`. The arguments are passed to the event handlers as function arguments.


Example
-------

The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.


::

    function event_test --on-event test_event
        echo event test: $argv
    end
    
    emit test_event something


Notes
-----

Note that events are only sent to the current fish process as there is no way to send events from one fish process to another.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 17:05:09 +08:00			`.. _cmd-emit:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`emit - Emit a generic event`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`===========================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`::`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance. 2019-09-17 17:59:04 +08:00			`emit EVENT_NAME [ARGUMENTS...]`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
doc: add link to event handlers in emit [ci skip] 2019-10-04 21:03:25 +08:00			``emit`` emits, or fires, an event. Events are delivered to, or caught by, special functions called :ref:`event handlers <event>`. The arguments are passed to the event handlers as function arguments.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.`


Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00
			`::`

			`function event_test --on-event test_event`
			`echo event test: $argv`
			`end`

			`emit test_event something`

Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Notes`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`Note that events are only sent to the current fish process as there is no way to send events from one fish process to another.`