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 event handlers. 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 09:05:09 +00:00			`.. _cmd-emit:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`emit - Emit a generic event`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`===========================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`emit EVENT_NAME [ARGUMENTS...]`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``emit`` emits, or fires, an event. Events are delivered to, or caught by, special functions called event handlers. The arguments are passed to the event handlers as function arguments.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00: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 03:14:04 +00: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-16 21:08:41 +00:00

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Notes`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00: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.`