home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / apshe103.zip / ApSched.Doc < prev    next >
Text File  |  1998-01-17  |  5KB  |  151 lines
  1.                                   ApSched 1.03
  2.  
  3.                   (c) Copyright 1997-1998 by Alberto Pasquale
  4.  
  5.                                 F R E E W A R E
  6.         
  7.                                     LICENSE
  8.         
  9.         
  10.         You may copy, distribute and use this program freely, provided
  11.         you do not modify the original archive and Copyrights.
  12.         
  13.         
  14.                                    DISCLAIMER
  15.         
  16.         You are entitled to use this freeware program "as is". No
  17.         guarantee can be given on the performance of the program. The
  18.         author will not be liable for any damage or loss related to the
  19.         use of this program.
  20.         
  21.         
  22.                                     Overview
  23.         
  24.  
  25.         ApSched is a simple Scheduler that allows to execute commands
  26.         and batch files at will.
  27.  
  28.         It is currently very poor in the interface, and it will probably
  29.         remain this way, but it is reliable and easy to use.
  30.  
  31.         I wrote ApSched because I have 6 mailer tasks in my BBS, but I
  32.         did not want to link external "global" events to any specific
  33.         mailer task.
  34.  
  35.         This is useful in many situations, for example when the mailer
  36.         task that should execute an external batch event is busy with a
  37.         long session.
  38.  
  39.  
  40.                                  Configuration
  41.  
  42.  
  43.         ApSched requires a configuration file that describes all the
  44.         events: let us name it ApSched.Evt.
  45.  
  46.         Before the Events definitions, two statements are accepted:
  47.  
  48.         LogFile <LogFile>
  49.             Specifies a Binkley style log file.
  50.  
  51.         BatchFile <BatchFile>
  52.             Specifies a batch file to be used for events.
  53.  
  54.  
  55.         The event definitions follow, one per line, with the following
  56.         format:
  57.  
  58.         ================================================================
  59.  
  60.         "<description>" <Day>[,<nth>][-<month>] <time> <Cmd> [<flags>]
  61.  
  62.         "<description>" is a short (truncated to 39 chars) description
  63.         of the event
  64.  
  65.         <Day> can be:
  66.             All
  67.             Sun|Mon|Tue|Wed|Thu|Fri|Sat
  68.             Week (Mon->Fri)
  69.             WeekEnd (Sat|Sun)
  70.             1..31
  71.  
  72.             Multiple items separated by |
  73.  
  74.         <nth> is the nth <day> in the month
  75.  
  76.             Multiple items separated by |
  77.             5 means last (becomes 4 if the 5ft does not exist)
  78.  
  79.         <month> can be:
  80.             All
  81.             Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec
  82.  
  83.             Multiple items separated by |
  84.  
  85.         <time> is 24h time in hour and minutes, range 00:00 -> 23:59
  86.             E.g.  14:00
  87.  
  88.         <Cmd> If no V flag: is the parameter passed to <BatchFile>
  89.               If    V flag: is a full command (possibly quoted)
  90.               Max 79 chars.
  91.  
  92.         <flags> is a set of flags, | separated:
  93.             V   Use <Cmd> as verbatim command, not parameter to
  94.             <BatchFile>
  95.  
  96.         ================================================================
  97.  
  98.         ApSched is designed to remain running 24h/24h, so it does not
  99.         need forced events: it starts examining events at the time it is
  100.         launched and will execute all the configured events, even if the
  101.         time has already elapsed waiting for the termination of a
  102.         previous command.
  103.  
  104.         Usually, <Cmd> specifies a string that will be passed to
  105.         <BatchFile> on its command line (will be used as %1).
  106.  
  107.         So you should change your old habit of using meaningless
  108.         errorlevels to the new style of "labels".
  109.  
  110.         When useful, you can also specify the V flag and use <Cmd> to
  111.         specify a normal command (possibly the name of a batch file with
  112.         parameters): this way ApSched will not invoke <BatchFile> with
  113.         <Cmd> parameter; instead it will directly execute <Cmd>.
  114.  
  115.         ================================================================
  116.  
  117.         Here the magnificent TUI commands are listed.
  118.  
  119.         For people not updated to the latest technological advances, TUI
  120.         stands for Teletype User Interface, which includes the results
  121.         of the latest research in ergonomics.
  122.  
  123.         ALT-X: Exit
  124.         ALT-R: Reload event file
  125.         ALT-S: Show Events
  126.         ALT-E: Enter Event number to execute immediately
  127.         ALT-H: Help
  128.  
  129.  
  130.         The program is launched by specifying the name of the event file
  131.         on the command line:
  132.  
  133.         ApSched <EventFile>
  134.  
  135.         ================================================================
  136.  
  137.         Errorlevel:
  138.  
  139.         0   Help given
  140.         1   ALT-X exit
  141.         2   Configuration file not found
  142.         4   ApSched is already running
  143.  
  144.         ================================================================
  145.  
  146.         For comments and suggestions:
  147.  
  148.         Alberto Pasquale of 2:332/504@fidonet
  149.         alberto@apworks.com
  150.  
  151.