home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Tools / MorphOS / Epic4_mos / share / epic / help / 5_programming / timer < prev    next >
Encoding:
Text File  |  2002-10-28  |  2.1 KB  |  54 lines
  1. Synopsis:
  2.    timer [-refnum <num|name>] [-repeat <times>] <seconds> [<action>]
  3.    timer -delete [all]|[<num>]
  4.  
  5. Description:
  6.    This command allows the client to store arbitrary commands scheduled
  7.    for execution at some specified number of seconds in the future. Any
  8.    number of timers may be set, and any number of commands may be used
  9.    in a timer.  Timers with multiple commands must have those commands
  10.    surrounded by curly braces.
  11.  
  12.    All timers are assigned a reference number to distinguish them from
  13.    each other.  A specific reference number may be specified, though the
  14.    number may not be one that is already in use, and it must be either a
  15.    non-negative integer or a string of no more than 10 characters (longer
  16.    strings will be silently truncated).  The reference number or name is
  17.    also used to delete a timer.  Using the TIMER command with no
  18.    arguments will display the list of pending timers.
  19.  
  20.    When used with -repeat, the timer will only expire after running through
  21.    <times> number of times.
  22.  
  23. Options:
  24.    -delete <num>|all    delete the numbered timer, or all timers
  25.    -list                same as using no arguments; lists all timers
  26.    -refnum <num|name>   set a timer with the given reference number or name
  27.    -repeat <times>      cycle through the timer <times> times before expiring
  28.    -update              re-assign the timer with new values
  29.    -window <windesc>    specifies in which window the timer should go off
  30.    
  31. Examples:
  32.    To create a reminder that X Files will be on in 10 minutes:
  33.       timer 600 {
  34.          beep
  35.          echo *** X Files is on!
  36.          echo *** Why are you still on irc?!
  37.       }
  38.  
  39.    To assign a specific refnum to that timer:
  40.       timer -ref 103 600 { ... }
  41.       timer -ref foo 600 { ... }
  42.  
  43.    This timer's reference name will be truncated to "foobarbooy":
  44.       timer -ref foobarbooya 45 { ... }
  45.  
  46.    To delete all pending timers:
  47.       timer -d all
  48.  
  49. Other Notes:
  50.    EPIC attempts to keep track of which server and window each timer was
  51.    started from.  Each timer will be reverted back to that window and server
  52.    when it expires.
  53.  
  54.