fish-shell/doc_src/emit.txt

\section emit emit - Emit a generic event

\subsection emit-synopsis Synopsis
\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
    echo event test: $argv
end

emit test_event something


\subsection emit-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
Add a 'generic' type of event that can be emited from any piece of code or by the user. Use this event layer to perform interactive configuration startup at the correct time. darcs-hash:20070819164230-75c98-f91b8a73de7bbbb500d80770ddf4d2d46ae592cc.gz 2007-08-19 16:42:30 +00:00			`\section emit emit - Emit a generic event`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			`\subsection emit-synopsis Synopsis`
Simplify styling 2014-08-01 12:25:41 +00:00			`\fish{synopsis}`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			`emit EVENT_NAME [ARGUMENTS...]`
			`\endfish`
Add a 'generic' type of event that can be emited from any piece of code or by the user. Use this event layer to perform interactive configuration startup at the correct time. darcs-hash:20070819164230-75c98-f91b8a73de7bbbb500d80770ddf4d2d46ae592cc.gz 2007-08-19 16:42:30 +00:00
			`\subsection emit-description Description`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			`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.
Add a 'generic' type of event that can be emited from any piece of code or by the user. Use this event layer to perform interactive configuration startup at the correct time. darcs-hash:20070819164230-75c98-f91b8a73de7bbbb500d80770ddf4d2d46ae592cc.gz 2007-08-19 16:42:30 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00
Add a 'generic' type of event that can be emited from any piece of code or by the user. Use this event layer to perform interactive configuration startup at the correct time. darcs-hash:20070819164230-75c98-f91b8a73de7bbbb500d80770ddf4d2d46ae592cc.gz 2007-08-19 16:42:30 +00:00			`\subsection emit-example Example`

Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.`
Add a 'generic' type of event that can be emited from any piece of code or by the user. Use this event layer to perform interactive configuration startup at the correct time. darcs-hash:20070819164230-75c98-f91b8a73de7bbbb500d80770ddf4d2d46ae592cc.gz 2007-08-19 16:42:30 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			`\fish`
			`function event_test --on-event test_event`
Allow 'emit' to accept event arguments 2012-12-20 00:11:55 +00:00			`echo event test: $argv`
Add a 'generic' type of event that can be emited from any piece of code or by the user. Use this event layer to perform interactive configuration startup at the correct time. darcs-hash:20070819164230-75c98-f91b8a73de7bbbb500d80770ddf4d2d46ae592cc.gz 2007-08-19 16:42:30 +00:00			`end`

Allow 'emit' to accept event arguments 2012-12-20 00:11:55 +00:00			`emit test_event something`
document events are per fish process Fixes #2954 2017-03-23 03:53:39 +00:00

fix some documentation errors 2017-07-12 05:50:55 +00:00			`\subsection emit-notes Notes`
document events are per fish process Fixes #2954 2017-03-23 03:53:39 +00:00
			`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.`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 02:37:32 +00:00			`\endfish`