mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-04-21 08:51:14 -03:00
7c27c1e7d0
Commit 0893134543 (Added .editorconfig file (#3332) (#3313),
2016-08-25) trimmed trailing whitespace for Markdown file (which do
have significant trailing whitespace) but ReStructuredText does not,
and none of our Markdown files cares about this, so let's clean up
whitespace always.
39 lines
841 B
ReStructuredText
39 lines
841 B
ReStructuredText
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.
|