aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/function.txt
diff options
context:
space:
mode:
authorGravatar axel <axel@liljencrantz.se>2006-06-18 00:14:26 +1000
committerGravatar axel <axel@liljencrantz.se>2006-06-18 00:14:26 +1000
commite007a5c203c9b506cc9c5262cf30b67617ef7743 (patch)
tree3b1760be2273534f8270166b66226def9c4e10d6 /doc_src/function.txt
parentf836bd41c08952d27917977049e188347b4383c6 (diff)
The syntax for 'function --on-job-exit caller' was flat out wrong in the docs. Fixed.
darcs-hash:20060617141426-ac50b-835a389b29243023739315f21135f19c5f010c5a.gz
Diffstat (limited to 'doc_src/function.txt')
-rw-r--r--doc_src/function.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc_src/function.txt b/doc_src/function.txt
index 612b663b..62dd41e0 100644
--- a/doc_src/function.txt
+++ b/doc_src/function.txt
@@ -7,7 +7,7 @@
- \c -b or \c --key-binding specifies that the function is a key biding. Key binding functions work exactly like regular functions except that they can not be tab-completed, and may contain the '-' character.
- <code>-d DESCRIPTION</code> or \c --description=DESCRIPTION is a description of what the function does, suitable as a completion description
-- <code>-j PID</code> or <code> --on-job-exit PID</code> tells fish to run this function when the job with group id PID exits
+- <code>-j PID</code> or <code> --on-job-exit PID</code> 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.
- <code>-p PID</code> or <code> --on-process-exit PID</code> tells fish to run this function when the fish child process with process id PID exits
- <code>-s</code> or <code>--on-signal SIGSPEC</code> 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)
- <code>-v</code> or <code>--on-variable VARIABLE_NAME</code> tells fish to run this function when the variable VARIABLE_NAME changes value