home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / Utils / scheduler.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  4.7 KB  |  144 lines
  1.  
  2.  
  3.  
  4.    =====( Scheduler V1.10 )=============================================
  5.  
  6.  
  7.         Trion 'Scheduler' Utility.
  8.  
  9.         (c) Copyright Paul Spijkerman, '96-'98. All rights reserved.
  10.  
  11.         Written for use with the Trion BBS package.
  12.  
  13.  
  14.    ===================================================================
  15.  
  16.    The trion scheduler is a programm that starts programms and
  17.    script at specific times. You can do things what you do regularly
  18.    do by a programm .. like calling out and do maintenance.
  19.    It is very much like a cron utility with a few little differences.
  20.  
  21.    It has an optional window with the time in big digits and a list
  22.    of the next events.
  23.    When it is started with no arguments it reads "trion:cfg/scheduler.cfg"
  24.    instead of a crontab and keeps a log in "trion:log/scheduler.log",
  25.    but you can change this by using arguments on the command line.
  26.  
  27.  
  28.    These are the arguments the Scheduler understands:
  29.  
  30.    CONFIG <path/name>        default:  trion:cfg/scheduler.cfg
  31.    LOG    <path/name>        default:  trion:log/scheduler.log
  32.    WINDOW <xpos> <ypos>      default:  x=450 y=55
  33.    ONTRION                   default:  On Workbench
  34.    NOWINDOW
  35.    PRI    <priority>         default:  priority=0
  36.    STACK  <stack>            default:  stack=2048
  37.    12HOUR or 24HOUR
  38.  
  39.  
  40.    The programm default opens a window with a clock and a list of
  41.    events, but by using NOWINDOW this can be overruled.
  42.  
  43.    When you use the ONTRION option the window will be opened
  44.    on the Trion public screen when available instead of the
  45.    workbench screen.
  46.    Note that you can't iconize the TrionRM screen until
  47.    you close the scheduler window.
  48.    Note that it isn't a problem to have the screen always open, but
  49.    it slows the mail processor a little when unpacking mail because
  50.    it has to update the screen after each message.
  51.    The Trion:down script still works because it also quits the
  52.    scheduler.
  53.    Couldn't think of a better way to implement this at this moment,
  54.    well actually I just thougth of something.
  55.    Just add to the "event" program commands to Iconize and DeIconize
  56.    the scheduler and then call the "event" program when TrionRM
  57.    is Iconized or Deiconized. Have to think if that is a 
  58.    really smart thing to do.
  59.  
  60.  
  61.    The clock in the window can be of the 12 hour (AM/PM) type or
  62.    of of the 24 hour type depending on what argument you use
  63.    on the command line. Default is the 12 hour type.
  64.  
  65.  
  66.    Also there is a utility called "event" what was meant to
  67.    add events ... but at this time it can be used to remove
  68.    the scheduler from the system by typeing "event -Q".
  69.  
  70.  
  71.    The format of the scheduler.cfg (crontab) looks very much like
  72.    that of other cron utilities:
  73.  
  74.    min hour day month DayOfWeek "command args" ["Description"]
  75.  
  76.    The only difference is the an optional description for use
  77.    in the scheduler window. And because there has to be some
  78.    separation between commands and description they both
  79.    have to be between "".
  80.  
  81.    Also there are some arguments that can be placed after
  82.    the command part that are filtered out by scheduler
  83.    and used for starting a programm:
  84.  
  85.  
  86.      >outfile                   <- redirect output to "outfile"
  87.      >>outfile                  <- same but add to existing file
  88.      <infile                    <- redirect input from "infile"
  89.      :PRI    <prioriteit>       <- Suplies a priority for this task
  90.      :STACK  <stack>            <- Suplies an amount of stack for this task
  91.      :STDIO                     <- Input/Output of this task is redirected
  92.                                    to the shell where scheduler was started
  93.                                    from instead of NIL:
  94.  
  95.  
  96.  
  97.  
  98.    How to make a scheduler.cfg (Crontab)..
  99.  
  100.  
  101.    The scheduler.cfg consists or 3 types or lines, blank lines,
  102.    comment lines and event lines.
  103.  
  104.    Comment lines start with a "#" or a ";" character.
  105.  
  106.  
  107.    Event lines have this format:
  108.  
  109.    min hour day month DayOfWeek "command args" ["Description"]
  110.  
  111.  
  112.    The first 5 fields, are specifications for what range of values this
  113.    command has to be run. A "*" means that any value is acceptable.
  114.    The fields can consist of a row of numbers separated by a ",".
  115.    Also ranges (numbers separated by a "-") may be used instead of
  116.    a number.
  117.  
  118.    Months range from 1 (January) to 12 (December).
  119.    The Day Of Week ranges from 0 (Sunday) to 6 (Saturday).
  120.  
  121.  
  122.    For example:
  123.  
  124.    * * * * *  "Date"
  125.  
  126.    Would run the command Date every minute of every hour of every day
  127.    of every month regardless of the day of the week.
  128.  
  129.     15 * * * *  "Date"
  130.  
  131.    Only runs on the 15th minute of each hour.
  132.  
  133.    0 10,12-16,18 * * *  "Date"
  134.  
  135.    Runs at the start of the hours 10, 12, 13, 14, 14, 16 and 18.
  136.  
  137.    0 3 * * 2,4,6   "c:execute trion:scripts/PollHub 14:103/3"  "Call Paul"
  138.  
  139.    This calls out on Tuesday, Thursday and Saterday at 3 AM.
  140.  
  141.  
  142.  
  143.  
  144.