aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/emit.txt
blob: f28217487152a5d1fd6556930443e9df440fe293 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
\section emit emit - Emit a generic event

\subsection block-synopsis Synopsis
 <tt>emit EVENT_NAME</tt>

\subsection emit-description Description

The emit builtin fires a generic fish event. Such events can be caught by special functions called event handlers.

\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.

<pre>function event_test --on-event test_event
    echo event test!!!
end

emit test_event</pre>