mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-06-01 21:21:15 -03:00
We no longer have two doc systems, move sphinx_doc_src back to doc_src
This commit is contained in:
39
doc_src/cmds/emit.rst
Normal file
39
doc_src/cmds/emit.rst
Normal file
@@ -0,0 +1,39 @@
|
||||
.. _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.
|
||||
Reference in New Issue
Block a user