home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 426.lha / tmonth / tmonth.doc < prev    next >
Text File  |  1990-10-07  |  5KB  |  155 lines
  1.  
  2.  
  3. ---------------------------------------------------------------------------- 
  4.     SHAREWARE   SHAREWARE   SHAREWARE   SHAREWARE   SHAREWARE   SHAREWARE
  5. ----------------------------------------------------------------------------
  6.  
  7. TMONTH is SHAREWARE.  If you try this program and continue to use it for
  8. over 30 days you are required to register your copy and make payment of $5
  9. for use of the program.  Please make payment of $5 to:
  10.  
  11.               George Kerber
  12.               19756 E. Linvale Drive
  13.               Aurora, Colorado  80013
  14.               303-693-2890
  15.  
  16.  
  17. ---------------------------------------------------------------------------- 
  18.     SHAREWARE   SHAREWARE   SHAREWARE   SHAREWARE   SHAREWARE   SHAREWARE
  19. ----------------------------------------------------------------------------
  20.  
  21.  
  22.               TMONTH   Copyright (c)  1990   by George Kerber
  23.  
  24.  
  25.     Program:  TMONTH
  26.  Programmer:  George Kerber
  27. Application:  AmigaDOS
  28.     Written:  09/09/90
  29.      Status:  Shareware  - Requires shareware payment of $5.
  30.  
  31.  
  32.  
  33.  
  34.    Purpose:  TMONTH is a program to allow the easy execution of any series
  35.              of commands from a batch file once a month.
  36.  
  37.     SYNTAX:  TMONTH [-h or ?] [program]
  38.  
  39.              -h or ?  --  A short help screen will be displayed.
  40.  
  41.              program  --  the specified program will be executed if TMONTH
  42.                           has not been executed in the current month.
  43.                           Entering a program is optional, see below for
  44.                           information on TMONTH return codes.
  45. Description:
  46. ------------
  47. Each time TMONTH is executed, it checks the current month and the month of
  48. the previous time it was executed.  If a program name was entered with the
  49. -p option, it will be executed if TMONTH has not been executed yet in the
  50. current month.  If TMONTH has been executed in the current month, TMONTH
  51. simply exits without doing anything.
  52.  
  53. TMONTH also sets the return code returned to AmigaDOS, depending if TMONTH
  54. has been executed in the current month.
  55.  
  56. If TMONTH has not been executed it returns a 5 (WARN) to the AmigaDOS shell.
  57. If TMONTH has been executed in the current month, it returns a 0 to the
  58. AmigaDOS shell.  The return code from TMONTH can be detected using the 
  59. IF WARN/ENDIF functions of AmgiaDOS.
  60.  
  61.  
  62. Examples:
  63. ---------
  64. TMONTH is very useful in your startup-sequence file to perform any type of
  65. commands once a month.  For example, suppose you wanted a message displayed
  66. on the screen the first time you boot your computer each month.  Below is a
  67. sample excerpt from a startup-sequence.
  68.  
  69.   
  70. --------------------------------------------------------------------------
  71. Use this method if you plan on executing more than one command using the
  72. return code from TMONTH.
  73.  
  74.    ...
  75.    tmonth                           ; execute the TMONTH program
  76.    if WARN
  77.       echo "This is an example of how TMONTH"
  78.       echo "can be used in your startup-sequence"
  79.       echo "to perform any number of commands the"
  80.       echo "time you use your Amiga each month"
  81.       dir
  82.       endif
  83.    ...
  84.       
  85. --------------------------------------------------------------------------
  86. Use this method if you are only planning on executing one command using
  87. the -p program option.
  88.  
  89.    ...
  90.    tmonth -p echo "It's a new month!"
  91.    ...
  92.  
  93. --------------------------------------------------------------------------
  94.  
  95. AtomClock is a great program that dials the Navel Observatory in 
  96. Washington DC and sets your computer clock.  This is nice to run once a
  97. month.  TMONTH allows this to be done very easily.
  98.  
  99. A sample script sample for your startup-sequence in shown below.
  100.  
  101. ; Use this in a script that is automatically executed everytime
  102. ; you boot.  This will cause Atomclock to be executed once a month during
  103. ; your boot sequence.
  104.  
  105.    ...
  106.    TMONTH
  107.    if WARN
  108.       stack 10000
  109.       atomclock z/MST ;sets mountain standard time (MST)
  110.       endif
  111.    ...
  112.  
  113. --------------------------------------------------------------------------
  114.  
  115.  
  116.  
  117. The program name can be any valid program or batch file name.  The program
  118. or batch file must be in the current directory, in the current PATH or a
  119. fully qualified path must be entered.
  120.  
  121.  
  122. Installation:
  123. -------------
  124. Copy TMONTH to your logically assigned c: directory. 
  125.  
  126.  
  127. Technical:
  128. ----------
  129. TMONTH does not need to create any special files that contain the month
  130. number of the previous time it was executed.  TMONTH actually writes the
  131. month number of the previous time it was executed to itself.  This way
  132. TMONTH always know internally if it's the first time it was executed in
  133. the current month.
  134.  
  135.  
  136. Status:
  137. -------
  138. TMONTH is SHAREWARE.  You have permission to use this program for a period
  139. of 30 days.  After 30 days you must send the author $5 for the use of the 
  140. program and to register your copy.  
  141.  
  142. An MS-DOS version of TMONTH exists and can be obtained by sending $7
  143. ($5 shareware payment, $2 shipping and handling) to the author.
  144.  
  145. I assume no responsibility for the use of this program or it's operation
  146. (I hate responsibility).
  147.  
  148.  
  149.                            George Kerber
  150.                            19756 E. Linvale Drive
  151.                            Aurora, Colorado  80013
  152.                            (303) 693-2890
  153.     
  154.  
  155.