diff options
Diffstat (limited to 'Doc/Zsh/mod_sched.yo')
| -rw-r--r-- | Doc/Zsh/mod_sched.yo | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/Doc/Zsh/mod_sched.yo b/Doc/Zsh/mod_sched.yo index 87ee9064c..0e9075841 100644 --- a/Doc/Zsh/mod_sched.yo +++ b/Doc/Zsh/mod_sched.yo @@ -1,7 +1,8 @@ COMMENT(!MOD!zsh/sched A builtin that provides a timed execution facility within the shell. !MOD!) -The tt(zsh/sched) module makes available one builtin command: +The tt(zsh/sched) module makes available one builtin command and one +parameter. startitem() findex(sched) @@ -40,3 +41,19 @@ visible output to the terminal; it is not needed, for example, with output that updates a terminal emulator's title bar. ) enditem() + +startitem() +vindex(zsh_scheduled_events) +item(zsh_scheduled_events)( +A readonly array corresponding to the events scheduled by the +tt(sched) builtin. The indices of the array correspond to the numbers +shown when tt(sched) is run with no arguments (provided that the +tt(KSH_ARRAYS) option is not set). The value of the +corresponding element is the same as the text shown to the right +of the index in the tt(sched) listing. + +The tt(sched) builtin should be used for manipulating the events. Note +that this will have an immediate effect on the contents of the array, +so that indices may become invalid. +) +enditem() |