mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-26 21:03:12 +00:00
3a23fdf359
Includes harmonizing the display of options and arguments, standardising terminology, using the envvar directive more broadly, adding help options to all commands that support them, simplifying some language, and tidying up multiple formatting issues. string documentation is not changed.
40 lines
860 B
ReStructuredText
40 lines
860 B
ReStructuredText
.. _cmd-emit:
|
|
|
|
emit - emit a generic event
|
|
===========================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. 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.
|
|
|
|
The **--help** or **-h** option displays help about using this command.
|
|
|
|
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.
|