home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD2.bin / bbs / util / timeplanner-1.0.lha / TimePlanner / README < prev    next >
Text File  |  1994-05-29  |  6KB  |  176 lines
  1. *****************************************************************************
  2. *                                                                           *
  3. *                    PUBLIC DOMAIN SOFTWARE LICENSE                         *
  4. *                                                                           *
  5. * The following program(s) and/or data file(s) are declared Public Domain.  *
  6. *                                                                           *
  7. * Provided the end user sticks to the following author's wishes, he or she  *
  8. * is authorized to use, copy, analyze and improve the items.                *
  9. *                                                                           *
  10. * Conditions of use:                                                        *
  11. * ------------------                                                        *
  12. *                                                                           *
  13. * 1) No part of this distribution will be omitted (incl. this README file)  *
  14. * 2) None of the Copyright texts will be modified.                          *
  15. * 3) None of the files should be stored and/or converted onto environment-  *
  16. *    ally damaging media. (paper listings, faxes, etc...)                   *
  17. *                                                                           *
  18. *                                                                           *
  19. * The Author,                                                               *
  20. *                                                                           *
  21. * Laurence Vanhelsuwé                                                       *
  22. *                                                                           *
  23. * Auroville 27/MAY/94                                                       *
  24. *                                                                           *
  25. *                                                                           *
  26. *****************************************************************************
  27.  
  28. Program Title(s): TimePlanner (TP) V1.2                (C) L. Vanhelsuwé 1994
  29.  
  30. Author:           Laurence Vanhelsuwé
  31.  
  32.  
  33. 0. Short description:
  34.    ------------------
  35.  
  36.    A simple but handy scheduled events deamon. Sits in the background and
  37.    notifies you of pre-programmed events (described in an ASCII configuration
  38.    file); can also start batch files at preset dates and/or times.
  39.  
  40.  
  41. 1. Requirements/Installation:
  42.    --------------------------
  43.  
  44.    The configuration file "EVENTS" needs to be present in S: .
  45.  
  46.    Edit your startup-sequence or user-startup (for 2.0+ users) file and add
  47.    a line like this:
  48.  
  49.       RUN TimePlanner >NIL:
  50.  
  51.  
  52. 2. How to use it:
  53.    --------------
  54.  
  55.    Create your own personalized "S:EVENTS" file from the template which
  56.    acompanies this release.
  57.    For exact file record structure, see below.
  58.  
  59.    Simply install the program as outlined above and Timeplanner will
  60.    notify you as soon as the first chronological event has arrived...
  61.  
  62.  
  63. 3. Internals:
  64.    ----------
  65.  
  66.    The structure of the S:EVENTS file should be as follows:
  67.  
  68.  
  69.    EVENT_REC 1
  70.    EVENT_REC 2
  71.        :
  72.    EVENT_REC N-1
  73.    EVENT_REC N
  74.  
  75.    Where EVENT_REC is an Event Record which has the following format:
  76.  
  77.                   WHEN
  78.                   [EARLY_REMINDER]
  79.                   ACTION
  80.  
  81.    a. WHEN
  82.    -------
  83.    has the following one-line structure:
  84.  
  85.                   ON [DAY] DD-MMM-YYYY [AT HH:MM]
  86.  
  87.    Examples:
  88.                   ON 01-JAN-1996
  89.                   ON MON 01-JAN-1996
  90.                   ON 01-JAN-1996 AT 09:30
  91.                   ON MON 01-JAN-1996 AT 09:30
  92.  
  93.    b. EARLY_REMINDER
  94.    -----------------
  95.    is optional and has the following structure:
  96.  
  97.                   REMIND MONTH, DAY, HOUR, N DAYS, N HOURS, N MINUTES
  98.  
  99.    Examples:
  100.                   REMIND 5 MINUTES
  101.                   REMIND 14 DAYS, 7 DAYS, 3 DAYS, 1 DAYS
  102.                   REMIND 2 HOURS, 1 HOURS, 15 MINUTES, 5 MINUTES
  103.  
  104.    c. ACTION
  105.    ---------
  106.    can be a simple on-screen notification and/or a launching of a
  107.    program.
  108.    Notification has the following structure:
  109.  
  110.                   NOTIFY "MESSAGE"
  111.  
  112.    Examples:
  113.                   NOTIFY "Mr. Wizard on TV soon !"
  114.                   NOTIFY "Solar eclipse."
  115.  
  116.    Launching a program is done by adding a line with the following structure:
  117.    Note that TimePlanner launches batchfiles for extra flexibility.
  118.  
  119.                   EXECUTE "batchfile"
  120.  
  121.    Examples:
  122.                   EXECUTE "S:WEEKLY_BACKUP"
  123.                   EXECUTE "S:MONTHLY_BACKUP"
  124.                   EXECUTE "S:DAILY_EXCH_RATE_DOWNLOAD"
  125.  
  126.  
  127.    Some examples of complete event records can be found in the example
  128.    EVENTS file which is part of this release.
  129.  
  130.    Note that any lines in the EVENTS file which can not be identified as one of
  131.    the above record field lines, will be interpreted as comments.
  132.    This allows you to add some informative comments, notes, etc...
  133.  
  134.  
  135. 4. Limitations/Warnings:
  136.    ---------------------
  137.  
  138.    No user-interface.
  139.    No command line options.
  140.  
  141. **!! CRASH !!**
  142.  
  143.  
  144.    Stick rigidly to the structure of an event record.
  145.    Don't add exotic characters. (The parser isn't one of the most flexible!)
  146.  
  147.    Even though the code might not be of commercial quality on the parsing side,
  148.    TimePlanner has run for years on my machine without a hitch, and it has
  149.    proven very useful indeed !
  150.  
  151.  
  152. 5. History:
  153.    --------
  154.  
  155.    If UNIX can have cron, then ...
  156.  
  157.  
  158. 6. Future:
  159.    -------
  160.  
  161.    Dependent on user's feedback.
  162.  
  163.    One neat change would be to use the new file notification feature in 2.0
  164.    to detect changes to S:EVENTS.
  165.    This way, you wouldn't have to reboot your Amiga to make a new EVENTS file
  166.    active. (This is currently a requirement...)
  167.  
  168.  
  169. 7. Credits:
  170.    --------
  171.  
  172.    L. Vanhelsuwé
  173.    Christinastraat 105
  174.    B-8400 Oostende
  175.    Belgium
  176.