home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 555a.lha / Badger_2.05a / badger.doc < prev    next >
Text File  |  1991-09-20  |  18KB  |  413 lines
  1.  
  2.                  BADGER  Copyright (c) 1990  by George Kerber
  3.  
  4. ---------------------------------------------------------------------------
  5. SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE 
  6. ---------------------------------------------------------------------------
  7.  
  8. BADGER is released as SHAREWARE.  This means that all users who find this
  9. program useful and continue to use it are required to mail the author (me)
  10. $15 to pay for the program and to register their copy.  Failure to make
  11. the required payment is THEFT.  This program may be used for a period of 30
  12. days (one 30 day trial period per user) without charge.  Any user that
  13. continues to use the program past the 30 day trial period should mail
  14. payment to:  
  15.                          George Kerber  
  16.                          19756 E. Linvale Drive  
  17.                          Aurora, CO  80013  
  18.                          (303) 693-2890  
  19.   
  20. As the author, I choose to make this program shareware and require a payment
  21. of $15 for the use of the program.  If anyone does not think the program is
  22. worth $15 (which is anyone's choice to make), that doesn't justify not
  23. making payment if you continue to use the program.  If my price it too high,
  24. then simply delete the program & documentation. 
  25.   
  26. Your permission to use this version of BADGER expires 30 days after the
  27. first time you execute the program.  Forty five days after you first use
  28. this program, BADGER will delete it's data files and become inoperative. 
  29. Whenever BADGER is executed, insure that your computer clock is set
  30. correctly.  The data files that are created by BADGER will only work with
  31. the copy of BADGER they were created with.  If a new copy of BADGER is
  32. started, it will destroy the old data files.  BADGER will not permit the
  33. user to set their computer date years ahead to start the program in an 
  34. attempt to get more usage time.  BADGER will detect this and become
  35. inoperative.
  36.    
  37. All registered users will receive an unprotected copy of the latest version
  38. of 'BADGER' that operates without any SHAREWARE message notices. The
  39. shareware screen was intended to be annoying.  Please send your registration
  40. payment, and you will never have to see the screen again.  Any attempt to
  41. remove the SHAREWARE notice using some type of sector editor will make the
  42. program inoperative.  When ordering, please specify MS-DOS or AmigaDOS.  
  43.  
  44. ---------------------------------------------------------------------------
  45. SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE  SHAREWARE 
  46. ---------------------------------------------------------------------------
  47.  
  48.        Program:  BADGER                                             03/28/90
  49.     Programmer:  George Kerber  
  50.        Written:  03/15/90 - 02/03/91  
  51.    Application:  AmigaDOS (1.2 or higher, 2.0 compatible)
  52.     
  53.  
  54. PURPOSE: 
  55. --------  
  56. BADGER is a 'quick' reminder program.  The user can enter important events
  57. via prompts, along with the number of days to pre-notify.  BADGER will 
  58. display any important events that fall within the pre-notify date from the
  59. menu or using the '-s'  or '-o' option.  The '-s' & '-o' options will only
  60. display the important events that are 'due'.  This is useful for inclusion 
  61. in your startup-sequence file. 
  62.  
  63.   
  64. SYNTAX:  
  65. -------  
  66.   
  67.         BADGER  
  68.         BADGER -s   
  69.         BADGER -o
  70.         BADGER -check
  71.         BADGER -h or ?
  72.  
  73.         With no option BADGER will display a menu to add, view or search
  74.         for current due events.   BADGER is easy to use, most choices are   
  75.         self-explanatory.
  76.     
  77.         -s  BADGER will display only the current due important events and 
  78.             then exit.  If no events are due, there will be no output.
  79.  
  80.         -o  This option is the same as the '-s' option above, except that
  81.             BADGER will only check the Important Event List once per day.
  82.  
  83.             Add 'BADGER -s' or 'BADGER -o' to your startup-sequence file.  
  84.  
  85.     -check  This option will display the status of this copy of BADGER,
  86.             along with the compile date.  If this copy is a SHAREWARE
  87.             version, '-check' will also display to the user if this copy 
  88.             of BADGER has ever been executed.  See the 'STATUS' section
  89.             for more information about this option for SHAREWARE users.
  90.  
  91.         -h  A short help/information screen will be displayed. 
  92.  
  93.               or
  94.  
  95.          ?  A short help/information screen will be displayed.
  96.  
  97.        
  98. When choices appear between [] brackets, any choice that is capitalized is  
  99. the default and can be selected by simply pressing any key.  
  100.  
  101.   
  102. MENU OPERATION  
  103. ---------------  
  104. All menu selections can be selected by the choice number or the highlighted
  105. letter of the description.   
  106.   
  107.     (s)     1.  Search For Important Events.  
  108.   
  109.     (a)     2.  Add Events.  
  110.   
  111.     (v)     3.  View Events.  
  112.   
  113.     (h)     4.  Help/Information. 
  114.  
  115.     (q)     5.  Quit. (default)  
  116.  
  117.     (P)         Print Event List.  (not shown on main menu)
  118.  
  119.     (W)         Write (SAVE) changes to disk. (not shown on main menu)
  120.   
  121. 1.  (s) Any important events that are "due" will be displayed.  The user  
  122.         will have six possible choices.  If a reference year was entered
  123.         on the ADD EVENT screen, the number of year elapsed since the
  124.         reference year will be displayed. 
  125.   
  126.     1.  (s) Snooze:  This is the default and will be selected by pressing
  127.             any key not used for the other menu choices.  The event will
  128.             be kept and the user will be reminded again the next time the
  129.             program is executed.  
  130.   
  131.     2.  (d) Delete:  The event will be removed from the Event List.
  132.  
  133.     3.  (q) Quit:  Or press ESC to return to the main menu. 
  134.  
  135.     4.  (w) Remind Again Next Week:  The event will be moved ahead seven
  136.             days from the Important Event date.   
  137.   
  138.     5.  (m) Remind Again Next Month:  The event will be moved to the same
  139.             date in the next month if possible.  If the new date is invalid,
  140.             the day will be moved to the last day in the new month.   
  141.  
  142.             Example:  05/31/90 will be changed to 06/30/90.  
  143.  
  144.             If you want to be reminded of an event at the end of every  
  145.             month, enter the event for the 1st day of the next month to  
  146.             notify you a few days before that.  This will insure that you  
  147.             will always be notified the same number of days before the end
  148.             of each month, no matter how many days are in the month.  
  149.     
  150.     6.  (y) Remind Again Next Year:  The event will be moved to the next 
  151.             year in the list.  Any dates of 2/29/LEAPYEAR will be moved to 
  152.             2/28 of the next year.   
  153.   
  154.     7.  (a) Change Advance Notice:  This option allows the user to change
  155.             the number of days in advance that this Event will be displayed.
  156.              
  157. 2.  (a) Enter Date:  The user will be prompted for a date.  The date must be
  158.         entered as m/d or m/d/y.  Leading zero's can be entered, but they
  159.         are not required.  Today or later is all that will be accepted up
  160.         until year 2030.  Any date entered without a year, will default to
  161.         the next date in the upcoming year. 
  162.   
  163.         Enter Days:  Enter the number of days you would like to be reminded
  164.         of this event ahead of time.  The default is 10 days.  You can
  165.         enter 0 - 45 days.  
  166.   
  167.         Enter (Reference) Year:  You may enter a 4 digit year from 1800 up
  168.         until current year.  This is useful for birth years and wedding
  169.         anniversary years.  If a valid year is entered, the number of years
  170.         from the reference year to the current year will be displayed on
  171.         the SEARCH EVENT screen.  Press <return> to skip the reference year.
  172.         BADGER will not allow the user to enter an invalid year.
  173.  
  174.         Enter Event Description:  Enter a description of the event.  This is
  175.         the message that will be displayed to the user when the event is
  176.         displayed.  
  177.  
  178.         NOTE:  The SEARCH EVENT screen will show how old a person is or
  179.         how many years ago their anniversary was if a reference year is
  180.         entered and the word 'birthday' or 'anniversary' appears in the
  181.         Event Description field.
  182.  
  183. 3.  (v) The user will be prompted for all or part of an Event Description
  184.         to search for.  The search is an un-anchored & non-case-sensitive.
  185.         This means that entering "ann" would locate both:
  186.  
  187.         Mom & Dad's anniversary
  188.         Ann Miller's Birthday
  189.  
  190.         Or, press <return> to view all records.
  191.  
  192.         Any event that is 'due' will be highlighted on the VIEW EVENT
  193.         display.
  194.  
  195.         Due events will appear in bolded color 3, all others will appear in
  196.         color 3 only.  Color 3 (when the default colors are being used) is
  197.         orange in AmigaDOS1.2 and lightblue in AmigaDOS2.0.
  198.  
  199.  
  200.     1.  (c)  Continue:  
  201.  
  202.     2.  (d)  Delete:
  203.  
  204.     3.  (q)  Quit: 
  205.  
  206.     4.  (r)  Change Remind Date:  The Event Date can be changed with this
  207.              option.
  208.  
  209.     5.  (a)  Change Advance Notice:  The number of days advance notice for
  210.              the event can be changed with this option.
  211.  
  212.     6.  (y)  Change Reference Year:  The reference year can be added,
  213.              deleted or changed with this option.  An existing reference
  214.              year can be removed by entering a '0' at the prompt.
  215.  
  216.     7.  (e)  Change Event Description:  The Event description can be changed
  217.              with this option.
  218.  
  219. 4.  (h)  A short help/information screen will be displayed. 
  220.   
  221. 5.  (q)  If any changes were made to the event list, the user will be  
  222.          prompted to save or ignore the changes.  
  223.  
  224.  
  225.     THE FOLLOWING CHOICES ARE NOT SHOWN ON THE MAIN BADGER MENU.
  226.     ------------------------------------------------------------
  227.     (P)  Print Event List:  An uppercase "P" must be used for this option.
  228.          This option is only available if there are any events in the
  229.          Event List.  Selecting this option will print your entire Event 
  230.          List on prt:(AmigaDOS).  Insure that your printer is turned on
  231.          before selecting this option.  If any changes were made to the
  232.          Event List, the user will be prompted to store the changes before
  233.          printing begins.  It's usually a good idea to store the changes at
  234.          this point in case some printing error occurs.
  235.  
  236.     (W)  Write Event List:  An uppercase "W" must be used for this option.
  237.          This option is only available if any changes have been made to
  238.          the Event List.  Selecting an uppercase 'W' will write the Event
  239.          List to disk if any changes have been made.  Use of this option
  240.          is normally not necessary, since the user will be prompted to
  241.          save any changes on exit from the program.
  242.  
  243.   
  244. DATA FILE LOCATION:  
  245. -------------------  
  246. BADGER stores the data file in your logically assigned s: directory.  The
  247. date file is named s:badger.data.  Whenever BADGER writes new information,
  248. badger.data (if it exists) is renamed to badger.bak and the new data is
  249. written to badger.data.  This insures that the previous generation file is
  250. always available if needed.
  251.  
  252.   
  253. STARTUP-SEQUENCE FILE  
  254. --------------------------------------------------------  
  255. Add the following line to your startup-sequence file after any commands
  256. necessary to set your system clock.  
  257.   
  258.    BADGER -s    : check the event list on very boot or reboot 
  259.  
  260.    or
  261.  
  262.    BADGER -o    : check the event list only the first boot per day
  263.   
  264. Each time you boot your computer, BADGER will check for any important events
  265. that are 'due' and display them to the user.  If there is nothing to
  266. display, there will be no output.  See the RETURN CODE section below.  The
  267. display will be identical to the "Search For Important Events" from the
  268. BADGER menu, except that the main menu will not be displayed.
  269.  
  270. Since the Amiga is a multi-tasking machine, BADGER can be 'run' to allow
  271. your startup-sequence to continue in the background while BADGER is running.
  272. This allows BADGER to check and/or display events that are due while your
  273. startup-sequence continues.  If you desire to 'run' BADGER, add this line
  274. to your startup-sequence instead of 'badger -s':
  275.  
  276.    run >nil: badger -s     -or-     run >nil: badger -o
  277.   
  278.   
  279. INSTALLATION:  
  280. -------------  
  281. Badger and badger.info can be copied to any location on your disk.  If you
  282. copy badger to a directory that is not in your current path, you will have
  283. to give a fully qualified path when executing badger from your startup-
  284. sequence.  For example:  If dh0:extra is not in your current path and you
  285. have copied badger to this directory, you will need to enter 
  286.    
  287.    dh0:extra/badger -s    (or dh0:extra/badger -o)
  288.  
  289. to your startup-sequence so your computer can find it.
  290.  
  291.  
  292. FLOPPY DISK USERS
  293. -----------------
  294. This program will work from floppy disks, but may be annoyingly slow to run
  295. each and every time your system is booted from every disk.  I suggest that a
  296. bootable (and writable) disk be created with the program run from the
  297. startup-sequence as described above.  Then simply boot from your BADGER
  298. disk whenever you want to check your event list.
  299.  
  300.  
  301. RETURN CODE
  302. -----------  
  303. If an error occurs that terminates the program prematurely, a return code of
  304. 10 (ERROR) is passed to the DOS shell along with a message printed to the 
  305. screen informing the user.  
  306.  
  307. When the program is executed using the -s or -o option, a return code of
  308. 5 (WARN) is returned to the DOS shell if there were important events to
  309. display.  No messages or errors are displayed.  Adding 'BADGER -s' to your
  310. autoexec.bat/startup-sequence file will produce no output unless an
  311. important event is displayed.
  312.  
  313. The user can safely ignore the return code if desired.   
  314.   
  315. You can trap for a no-event condition by checking the return
  316. code in the script you are executing 'badger -s' from.
  317.  
  318. ....
  319.  
  320. badger -s
  321. if NOT WARN
  322.    echo "No Important Events Today"
  323.    endif
  324.  
  325. ....
  326.  
  327. If you want some type of message displayed if there were no important events
  328. to display, add the above code to your startup-sequence.  Otherwise badger
  329. -s (or -o) will execute quietly unless there is an important event to
  330. display. 
  331.  
  332.  
  333. RESET BADGER
  334. ------------
  335. SHAREWARE versions of BADGER that have already been executed can be reset
  336. for distribution.  Note that SHAREWARE versions of BADGER cannot share
  337. data files.  This means that if you reset your copy of BADGER in an 
  338. attempt to get more usage time, the reset version will not use your existing
  339. data file.  The reset option is only offered to allow each user the full
  340. forty five days to evaluate the program.
  341.  
  342.      1>  badger reset
  343.  
  344.  
  345. UPDATES?
  346. --------
  347. Due to the initial low price of BADGER, registered users will not receive
  348. automatic notification of any updates, bug fixes or improvements to BADGER.
  349. Any registered user may request the latest version of BADGER by sending $5
  350. (for shipping & handling only) to the author.  To be eligible for the
  351. update, you must send me your current version number and serial number.
  352. Very early AmigaDOS versions of BADGER were not serialized, you must
  353. inform me of this fact. 
  354.  
  355. Updates will only be sent to the original address of the purchaser.  If you
  356. have moved, you must send your original disk as proof of purchase.
  357.  
  358.  
  359. STATUS:  
  360. -------  
  361. This program is SHAREWARE.  If you find this program useful, you are
  362. required to mail the author $15 as payment for the program and to register
  363. your copy.
  364.  
  365. If you have a registered version of BADGER, you MAY NOT FREELY DISTRIBUTE
  366. your copy.  Only unregistered 'usage' protected copies may be freely
  367. distributed.  
  368.  
  369. Usage protected SHAREWARE versions of this program can be freely distributed
  370. as long as all files are included in the archive.  The archive should 
  371. contain the following files:
  372.  
  373.                1. badger
  374.                2. badger.doc
  375.                3. badger.info (icon)
  376.                4. REGISTER.TXT
  377.                5. convert
  378.                6. convert.doc
  379.                7. help.me
  380.  
  381. If a SHAREWARE copy of BADGER is redistributed, it should be the exact copy
  382. copy that was obtained from the archive.  This is, the copy that is
  383. distributed should not have been executed.  You can determine if BADGER has
  384. ever been executed by executing badger using '-check' as an option.  If
  385. If BADGER has been date-stamped, that copy should not be distributed, since
  386. since it will become inoperative 45 days from the first time it was 
  387. executed, not 45 days from when the new user first executes it.
  388.  
  389. If the SHAREWARE version of BADGER you want to distribute has already been
  390. executed, you can reset the copy.  See the section titled RESET BADGER
  391. for more information.
  392.  
  393. Please specify MS-DOS (3 1/2 or 5 1/4) or AmigaDOS.  If you wouldn't steal
  394. a program off the shelf in a software store, please don't steal the program
  395. from me.  If you use the program beyond the 30 day trial period, failure to
  396. mail payment is theft.  An ordering form has been provided in the text file
  397. "BADGER.REG" (MS-DOS) or REGISTER.TXT (AmigaDOS).
  398.  
  399. Registered users of BADGER may purchase a copy of BADGER for the other
  400. operating system for $10.  Please include your current serial number
  401. when ordering.
  402.  
  403. I am not responsible for any failure of this program, or any missed events
  404. or any consequences of the missed event. (I hate responsibility)  
  405.    
  406.   
  407.                            George Kerber  
  408.                            19756 E. Linvale Drive  
  409.                            Aurora, Colorado  80013  
  410.                            303-692-2890  
  411.   
  412.                            Compuserve 74010,2132  
  413.