mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-31 23:28:45 +00:00
02d82dcf85
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.
39 lines
761 B
ReStructuredText
39 lines
761 B
ReStructuredText
.. _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.
|