fish-shell/doc_src/emit.txt

29 lines
797 B
Text
Raw Normal View History

\section emit emit - Emit a generic event
\subsection emit-synopsis Synopsis
2014-08-01 12:25:41 +00:00
\fish{synopsis}
emit EVENT_NAME [ARGUMENTS...]
\endfish
\subsection emit-description 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.
\subsection emit-example Example
The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.
\fish
function event_test --on-event test_event
2012-12-20 00:11:55 +00:00
echo event test: $argv
end
2012-12-20 00:11:55 +00:00
emit test_event something
\subsection notes 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.
\endfish