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