From 88a2b622df50d5f9c85a3912826ae93b603992a0 Mon Sep 17 00:00:00 2001 From: liljencrantz Date: Thu, 17 Jan 2008 08:25:31 +1000 Subject: [PATCH] Add more documentation on events darcs-hash:20080116222531-75c98-ef30dabc492d7883dbb620c40ef95152469057a3.gz --- doc_src/function.txt | 6 ++++++ doc_src/index.hdr.in | 1 + 2 files changed, 7 insertions(+) diff --git a/doc_src/function.txt b/doc_src/function.txt index 7bf7ced20..829530f6e 100644 --- a/doc_src/function.txt +++ b/doc_src/function.txt @@ -6,6 +6,7 @@ \subsection function-description Description - -d DESCRIPTION or \c --description=DESCRIPTION is a description of what the function does, suitable as a completion description +- -e or --on-event EVENT_NAME tells fish to run this function when the specified named event is emitted. Fish internally generates named events e.g. when showing the prompt. - -j PID or --on-job-exit PID tells fish to run this function when the job with group id PID exits. Instead of PID, the string 'caller' can be specified. This is only legal when in a command substitution, and will result in the handler being triggered by the exit of the job which created this command substitution. - -p PID or --on-process-exit PID tells fish to run this function when the fish child process with process id PID exits - -s or --on-signal SIGSPEC tells fish to run this function when the signal SIGSPEC is delivered. SIGSPEC can be a signal number, or the signal name, such as SIGHUP (or just HUP) @@ -26,6 +27,11 @@ will write hello whenever the user enters \c hi. If the user enters any additional arguments after the function, they are inserted into the environment variable array argv. +By using one of the event handler switches, a function can be made to run automatically at specific events. The user may generate new events using the