The syntax for 'function --on-job-exit caller' was flat out wrong in the docs. Fixed.

darcs-hash:20060617141426-ac50b-835a389b29243023739315f21135f19c5f010c5a.gz
This commit is contained in:
axel 2006-06-18 00:14:26 +10:00
parent f836bd41c0
commit e007a5c203
2 changed files with 1 additions and 2 deletions

View file

@ -541,7 +541,6 @@ a string is expanded into a process id. The following expansions are
performed: performed:
- If the string is the entire word \c self, the shells pid is the result - If the string is the entire word \c self, the shells pid is the result
- When inside a command substitution, if the string is the entire word \c caller, the job number (not the pid) of the job the created the command substitution is the result
- Otherwise, if the string is the id of a job, the result is the process - Otherwise, if the string is the id of a job, the result is the process
group id of the job. group id of the job.
- Otherwise, if any child processes match the specified string, their - Otherwise, if any child processes match the specified string, their

View file

@ -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. - \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>-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>-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>-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 - <code>-v</code> or <code>--on-variable VARIABLE_NAME</code> tells fish to run this function when the variable VARIABLE_NAME changes value