home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: SysTools / SysTools.zip / crontab.zip / readme < prev   
Text File  |  1998-01-22  |  7KB  |  144 lines
  1. Author:  J. Pedone (jpedone@flash.net)
  2. Copyright:  This program is provided free as is with no warranty whatsoever
  3.  
  4. What it does:
  5. CRON is a simple program launcher.  Once every 60 seconds it will compare the current system time to events in the CRONTAB database.  If an event time matches the current time, it will run.  4 digit years are used to allow the program to be Y2K compliant.
  6.  
  7. Requirements:
  8. CRON by itself requires OS/2 with REXX and DrDialog (Available free from IBM at http://service2.boulder.ibm.com/devcon/) be installed.  Part of this package (DRREXX.EXE) is included in case you don't want to download the full package.  The program was tested using OS/2 version 4 with Object REXX.  It should however, work equally well with plain REXX and earlier versions of OS/2.
  9.  
  10. To fully use the program however, it is recommended you also have multimedia installed on your system.
  11.  
  12. The add in module (MSGBOX.RES) requires both multimedia and DrDialog to be fully functional. MSGBOX.CMD is used to display a reminder box and optionally play a WAV file.
  13.  
  14. Usage:
  15. Type CRON at a command line
  16. NOTE:  This file (CRON.CMD) is not compatible with the previous CRONTAB database file.  Use CONVERT.CMD to reformat your database if needed.
  17.  
  18. Usage options:
  19. Starting the program as "CRON 1>OUT.LOG 2>ERR.LOG" will create two log files for storing program output and errors respectively.  No other options are available.
  20.  
  21. Event Database:
  22. A sample crontab file is supplied.  This file stores the events that CRON will run and is called CRONTAB. This file MUST be in the same directory as the CRON.CMD file.  It is a standard ascii file and the data layout is as follows:
  23.  
  24. minutes ≡ hours  ≡ dates  ≡ months  ≡ days  ≡ Years ≡ session type ≡ program type ≡ file name (wav or executable) ≡ parameters or message ≡ close on exit
  25.  
  26. Permissable data is as follows:
  27.  
  28. Minutes - Must be a number.  Can be entered as discrete numbers (1,2,3) or a range (1-3)
  29.  
  30. Hours - Can be entered as discrete numbers (1,2,3) or a range (1-3) or a wildcard (*)
  31.  
  32. Dates - Can be entered as discrete numbers (1,2,3) or a range (1-3) or a wildcard (*)
  33.  
  34. Months - Can be entered as discrete numbers (1,2,3) or a range (1-3) or a wildcard (*)
  35.  
  36. Days (Day of the week) - Can be entered as discrete numbers (1,2,3) or a range (1-3) or a wildcard (*)  Days are 1 for Sunday ... 7 For Saturday
  37.  
  38. Years - Can be entered as discrete numbers (1996,1997) or a range (2001-2002) or a wildcard (*).  Years are entered as a 4 digit year for Y2K compliance.
  39.  
  40. Session Type - Is case sensitve and entered as follows:
  41.  
  42. Minimized (To start as 'start * /min')
  43. Detached  (To start as 'detach')
  44. Full Screen (To start as 'start * /fs')
  45. Window (To start as 'start * /win')
  46. Default (To start as 'start *')
  47. * - A /c option will be added here if "Close on exit" is set to "Yes".
  48.  
  49. Program type - Case Sensitive as follows:
  50.  
  51. Program (an executable program)
  52. Message (a message box)
  53.  
  54. File name - an executable file name or a wav file to be played
  55.  
  56. Close on exit - Case sensitive as follows:
  57.  
  58. Yes (Closes after program execution)
  59. No (Does not close after program execution)
  60.  
  61. NOTE - The following are special characters:
  62.  
  63. ≡ (ALT+240) - Element seperator
  64.  
  65. Installation:
  66. Unzip the file into a directory - That's it !! Or, if you would like the program objects created for you, type 'install' at the command line.
  67.  
  68. Additional programs:
  69.  
  70. CRONTAB.CMD
  71. This file is no longer included.  Originally, MSGBOX.CMD and CRONTAB.CMD were written using the freeware VREXX utilities from IBM.  This set of utilities caused numerous SYS3175 errors that could not be corrected by me.  
  72.  
  73. CRONTAB.RES
  74. This is a resource file that provides a GUI interface for maintaining the CRONTAB database file.  If you have a resource compiler, you may compile this into a stand-alone executable.  To execute this via a command line type:  DRREXX CRONTAB.RES
  75. To set up a program object for this use the following parameters:
  76.  
  77. Command line: x:\directory\DRREXX.EXE
  78.  
  79. Parameters: x:\directory\crontab.res
  80.  
  81. Working directory: x2:\directory2
  82.  
  83. Where:
  84. x is the drive holding DRREXX.EXE 
  85. directory is the full path to DRREXX.EXE
  86. x2 is the drive holding your CRONTAB file
  87. directory2 is the full path to your CRONTAB file
  88.  
  89. It will look in the current working directory for the CRONTAB file.  If it does not exist, it will create it.  The data entered must adhere to the event database values as listed above.
  90. The function buttons perform the following actions:
  91.  
  92. Browse - brings up a File Open dialog to select a wav file or program
  93. << - Displays the previous record
  94. >> - Displays the next record
  95. Add - Adds the currently displayed record as a new record
  96. Delete - Deletes the currently displayed record and displays record # 1
  97. Quit - Ends the program
  98. Update - Updates the currently displayed record. 
  99.     NOTE:  Changes made to the displayed record are not updated unless this button is clicked !! 
  100.              NEXT and PREVIOUS will discard any pending changes.
  101. Test - Runs the currently displayed program immediately.  This function will not update, add or delete anything.  
  102.  
  103. (Duplicate menu options are also provided for these functions.)
  104.  
  105. MSGBOX.CMD
  106. This file is no longer included.  It's function was incorporated directly into CRON.CMD and MSGBOX.RES.
  107.  
  108. MSGBOX.RES
  109. This is the MSGBOX resource file.  If you have a resource compiler, you may compile this into a stand-alone executable.  It may also be run as-is using the DRREXX.EXE program.
  110. Although not intended, this file may be invoked alone as:
  111.  
  112. DRREXX MSGBOX.RES wav_file_to_play≡message_to_display
  113.  
  114. Additional files:
  115. INSTALL.CMD - Creates the Crontab folder and associated program objects.
  116.  
  117. CRONTAB - This is the database for your events
  118.  
  119. DRREXX.EXE - The resource runtime module from the DrDialog utilities.
  120.  
  121. CONVERT.CMD - This is a simple utility to convert the previous version of the CRONTAB file to the new format.  To invoke type: CONVERT data_file at the command prompt.
  122.  
  123. It will do the following:
  124.  
  125. Convert the old delimiter (/) to the new one (≡)
  126. Break down your old command line to find out the working directory
  127. Set the 'Close on exit' string to 'Yes'
  128. Set the 'Program type' string
  129. Save the converted file to a file called NEWDATA
  130.  
  131. If everything went as planned you may rename this file to CRONTAB to use it with the new CRON.CMD and CRONTAB.RES files.
  132.  
  133. Known problems:
  134. None
  135.  
  136. History:
  137. 1.  Added another field to the CRONTAB file to specify the session type.
  138. 2.  Changed MSGBOX to use DrDialog rather than VREXX.
  139. 3.  Changed the field delimiter to ≡
  140. 4.  Added another field to the CRONTAB file to optionally leave the session open.
  141. 5.  Added a wait state to CRONTAB.RES and CRON.CMD to avoid file contention problems.
  142. 6.  Changed CRON.CMD so that it no longer requires wrapper files to launch a program or message box.
  143. 7.  Moved the MSGBOX.CMD functionality into MSGBOX.RES and CRON.CMD.
  144.