home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 371.lha / badger_v1.01 / badger.doc < prev    next >
Text File  |  1990-05-05  |  8KB  |  217 lines
  1.                                                                     3/28/90
  2.  
  3. SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE
  4.  
  5.        Program:  Badger
  6.     Programmer:  George Kerber
  7.        Written:  03/15/90 - 03/31/90
  8.        Version:  1.01
  9.  
  10.   This program is released as SHAREWARE.  This means that all users who
  11.   find this program useful and continue to use it are required to mail
  12.   the author (me) $15 to pay for the program and to register their copy.
  13.   Failure to make the required payment is THEFT.  This program may be used
  14.   for a period of 15 days (one 15 day trial period per user) without 
  15.   charge.  Any user that continues to use the program past the 15 day trial
  16.   period should mail payment to:
  17.  
  18.                          George Kerber
  19.                          19757 E. Linvale Drive
  20.                          Aurora, CO  80013
  21.                          (303) 693-2890
  22.  
  23.   As the author, I choose to make this program shareware and require a
  24.   payment of $15 for the use of the program.  If anyone does not think
  25.   the program is worth $15 (which is anyone's choice to make), that
  26.   doesn't justify not making payment if you continue to use the program. 
  27.   If my price is too high, then simply delete the program.
  28.  
  29.   All registered users will receive a copy of the latest version of
  30.   'badger' that operates without any SHAREWARE message notices.  The
  31.   shareware screen was intended to be annoying.  Please send your
  32.   registration payment, and you will never have to see the screen again.
  33.   Any attempt to remove the SHAREWARE notice using some type of sector
  34.   editor will make the program inoperative.
  35.  
  36. SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE
  37.  
  38.  
  39.  
  40. PURPOSE:
  41. --------
  42. Badger is a 'quick' reminder program.  The user can enter important events 
  43. via prompts, along with the number of days to pre-notify.  Badger will
  44. display any important events that fall within the pre-notify date from the
  45. menu or using the '-s' option.  The '-s' option will only display the
  46. important events that are 'due'.  This is useful for inclusion in your
  47. startup-sequence.
  48.  
  49.  
  50. SYNTAX:
  51. -------
  52.  
  53.         badger
  54.         badger -s 
  55.         badger ?
  56.  
  57.         -s  Badger will display only the current due important events and   
  58.             then exit.  If no events are due, there will be no output.  Add 
  59.             this to your startup-sequence.
  60.  
  61.          ?  A short help screen will be displayed.
  62.  
  63.         With no option (or an invalid option) Badger will display a menu to 
  64.         add, view or search for current due events.
  65.  
  66.  
  67. When choice appear between [] brackets, any choice that is capitalized is
  68. the default and can be selected by simply pressing any key.
  69.  
  70.  
  71. MENU OPERATION
  72. ---------------
  73. All menu selections can be selected by the choice number or the first
  74. letter of the description.
  75.  
  76.  
  77.  (s)              1.  Search For Important Events.
  78.  
  79.  (a)              2.  Add Events.
  80.  
  81.  (v)              3.  View Events.
  82.  
  83.  (q)              4.  Quit. (default)
  84.  
  85.  
  86. 1.  (s) Any important events that are "due" will be displayed.  The user
  87.     will have 3 possible choices.
  88.  
  89.     1.  Snooze:  This is the default and will be selected by pressing any   
  90.         key not used for the other menu choices.  The event will be kept and 
  91.         the user will be reminded again the next time the program is        
  92.         executed.
  93.     2.  Delete:  The event will be deleted from the file. 
  94.     3.  Remind Again Next Year:  The event will be moved to the next year in
  95.         the list.  Any dates of 2/29/LEAPYEAR will be moved to 2/28 of the  
  96.         next year.
  97.  
  98.     If there are no pending events to display, this menu choice will appear 
  99.     in black text (color 2) and will be inoperative. 
  100.  
  101. 2.  (a) The user will be prompted for a date.  The date must be entered as  
  102.     m/d/y.  Leading zeros can be entered for the month, day and year, but   
  103.     they are not required.  Today or later is all that will be accepted.
  104.  
  105.     Enter the number of days to pre-notify the user about the event.  The
  106.     default is 10 days.  You can enter 0 - 45 days.
  107.  
  108.     Enter a description of the event.  This is the message that will be
  109.     displayed to the user when the event is displayed.
  110.         
  111. 3.  (v) The user will be presented with a sequential display of all events  
  112.     in the file.  Events can be deleted with this choice.  This menu choice 
  113.     will appear black (color 2) if there are no events to view and be       
  114.     inoperative.
  115.  
  116. 4.  (q)  If any changes were made to the event list, the user will be
  117.     prompted to save or ignore the changes.
  118.  
  119. All records are stored in 's:badger.data'.  If a current file exists, then
  120. it will be renamed to 's:badger.bak' and the new information will be written
  121. to 's:badger.data'.  This insures that the previous generation file is
  122. always available in the s: directory.
  123.  
  124.  
  125. STARTUP-SEQUENCE
  126. ----------------
  127. Add the following line to your startup-sequence after any commands
  128. necessary to set your system clock.
  129.  
  130.    c:badger -s
  131.  
  132.    or whatever directory badger is in.
  133.  
  134. Each time you boot your Amiga, badger will check for any important events
  135. that are 'due' and display them to the user.  If there is nothing to
  136. display, there will be no output.  See the RETURN CODE section below.  The
  137. display will be identical to the "Search For Important Events" from the
  138. badger menu, except that the user WILL NOT be prompted if any changes should
  139. be saved.
  140.  
  141. It is also possible to 'run' 'badger -s' so that your startup-sequence will
  142. continue to execute while you are viewing any 'due' events.
  143.  
  144.    c:run >nil: badger -s
  145.  
  146.  
  147. INSTALLATION:
  148. -------------
  149. Copy the badger program to the sys:c directory, or any other directory in
  150. your PATH if you do not plan on using badger from the workbench with an
  151. icon.  
  152.  
  153.  -- or --
  154.  
  155. Copy both badger and badger.info to any directory you desire.  You will have
  156. to specify this directory when you execute badger from your
  157. startup-sequence.
  158.  
  159.  
  160. RETURN CODE
  161. -----------
  162. If an error occurs that terminates the program prematurely, a return code of
  163. 10 (ERROR) is passed to the AmigaDOS shell along with a message printed to
  164. the screen informing the user.
  165.  
  166. When the program is executed using the -s option, a return code of 5 (WARN)
  167. is returned to the AmigaDOS shell if there were important events to
  168. display.  No messages or errors are displayed.  Adding 'badger -s' to your
  169. startup-sequence will produce no output unless an important event is
  170. displayed.  You can trap for a no-event condition by checking the return
  171. code in the script you are executing 'badger -s' from.
  172.  
  173. ....
  174.  
  175. badger -s
  176. if NOT WARN
  177.    echo "No Important Events Today"
  178.    endif
  179.  
  180. ....
  181.  
  182. If you want some type of message displayed if there were no important events
  183. to display, add the above code to your startup-sequence.  Otherwise badger
  184. -s will execute quietly unless there is an important event to display.  The
  185. user can safely ignore the return code if desired. 
  186.  
  187.  
  188. FLOPPY DISK USERS
  189. -----------------
  190. This program will work from floppy disks, but may be annoying slow to run
  191. each and every time your system is booted from every disk.  I suggest that a
  192. bootable (and writable) disk be created with the program run from the
  193. startup-sequence as described above.  Then simply boot from your badger disk
  194. whenever you want to check your event list.
  195.  
  196.  
  197. STATUS:
  198. -------
  199. This program is SHAREWARE.  If you find this program useful, you are
  200. required to mail the author $15 as payment for the program and to register
  201. your copy.  Failure to mail payment is THEFT, no different than stealing a
  202. program from a shelf in a store.   I am not responsible for any failure of
  203. this program, or any missed events or any consequences of the missed event. 
  204. (I hate responsibility)
  205.  
  206.  
  207.  
  208.  
  209.                            George Kerber
  210.                            19756 E. Linvale Drive
  211.                            Aurora, Colorado  80013
  212.                            303-692-2890
  213.  
  214.                            Compuserve 74010,2132
  215.  
  216.  
  217.