home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 1 / GoldFishApril1994_CD2.img / d4xx / d432 / badger / badger.doc < prev    next >
Text File  |  1991-01-12  |  22KB  |  500 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 - 12/09/90  
  51.    Application:  MS-DOS (3.0 or higher)
  52.                  AmigaDOS (1.2 or higher, 2.0 compatible)
  53.     
  54.  
  55. PURPOSE:  (MS-DOS or AmigaDOS)
  56. --------  
  57. BADGER is a 'quick' reminder program.  The user can enter important events
  58. via prompts, along with the number of days to pre-notify.  BADGER will 
  59. display any important events that fall within the pre-notify date from the
  60. menu or using the '-s'  or '-o' option.  The '-s' & '-o' options will only
  61. display the important events that are 'due'.  This is useful for inclusion 
  62. in your autoexec.bat/startup-sequence file. 
  63.  
  64.   
  65. SYNTAX:  
  66. -------  
  67.   
  68.         BADGER  
  69.         BADGER -s   
  70.         BADGER -o
  71.         BADGER -c (MS-DOS Only)
  72.         BADGER -l (MS-DOS Only)
  73.         BADGER -check
  74.         BADGER -h or ?
  75.  
  76.         With no option BADGER will display a menu to add, view or search
  77.         for current due events.   BADGER is easy to use, most choices are   
  78.         self-explanatory.
  79.     
  80.         -s  BADGER will display only the current due important events and 
  81.             then exit.  If no events are due, there will be no output.
  82.  
  83.         -o  This option is the same as the '-s' option above, except that
  84.             BADGER will only check the Important Event List once per day.
  85.  
  86.             Add 'BADGER -s' or 'BADGER -o' to your autoexec.bat/startup-
  87.             sequence file.  
  88.  
  89.         -c  Toggle color/black & white.  See the section titled "COLOR"
  90.             for more information.  (MS-DOS ONLY)
  91.  
  92.         -l  This option prevents BADGER from using any text attributes
  93.             in it's display.  This is useful for LCD displays due to the
  94.             "reversed" nature of their output.  See the section titled
  95.             "COLOR" for more information.  (MS-DOS ONLY)
  96.  
  97.     -check  This option will display the status of this copy of BADGER,
  98.             along with the compile date.  If this copy is a SHAREWARE
  99.             version, '-check' will also display to the user if this copy 
  100.             of BADGER has ever been executed.  See the 'STATUS' section
  101.             for more information about this option for SHAREWARE users.
  102.  
  103.         -h  A short help/information screen will be displayed. 
  104.  
  105.               or
  106.  
  107.          ?  A short help/information screen will be displayed.
  108.  
  109.        
  110. When choices appear between [] brackets, any choice that is capitalized is  
  111. the default and can be selected by simply pressing any key.  
  112.  
  113.   
  114. MENU OPERATION  
  115. ---------------  
  116. All menu selections can be selected by the choice number or the highlighted
  117. letter of the description.   
  118.   
  119.     (s)     1.  Search For Important Events.  
  120.   
  121.     (a)     2.  Add Events.  
  122.   
  123.     (v)     3.  View Events.  
  124.   
  125.     (h)     4.  Help/Information. 
  126.  
  127.     (q)     5.  Quit. (default)  
  128.  
  129.     (P)         Print Event List.  (not shown on main menu)
  130.  
  131.     (W)         Write (SAVE) changes to disk. (not shown on main menu)
  132.   
  133. 1.  (s) Any important events that are "due" will be displayed.  The user  
  134.         will have six possible choices.  If a reference year was entered
  135.         on the ADD EVENT screen, the number of year elapsed since the
  136.         reference year will be displayed. 
  137.   
  138.     1.  (s) Snooze:  This is the default and will be selected by pressing
  139.             any key not used for the other menu choices.  The event will
  140.             be kept and the user will be reminded again the next time the
  141.             program is executed.  
  142.   
  143.     2.  (d) Delete:  The event will be removed from the Event List.
  144.  
  145.     3.  (q) Quit:  Or press ESC to return to the main menu. 
  146.  
  147.     4.  (w) Remind Again Next Week:  The event will be moved ahead seven
  148.             days from the Important Event date.   
  149.   
  150.     5.  (m) Remind Again Next Month:  The event will be moved to the same
  151.             date in the next month if possible.  If the new date is invalid,
  152.             the day will be moved to the last day in the new month.   
  153.  
  154.             Example:  05/31/90 will be changed to 06/30/90.  
  155.  
  156.             If you want to be reminded of an event at the end of every  
  157.             month, enter the event for the 1st day of the next month to  
  158.             notify you a few days before that.  This will insure that you  
  159.             will always be notified the same number of days before the end
  160.             of each month, no matter how many days are in the month.  
  161.     
  162.     6.  (y) Remind Again Next Year:  The event will be moved to the next 
  163.             year in the list.  Any dates of 2/29/LEAPYEAR will be moved to 
  164.             2/28 of the next year.   
  165.   
  166.     7.  (a) Change Advance Notice:  This option allows the user to change
  167.             the number of days in advance that this Event will be displayed.
  168.              
  169. 2.  (a) Enter Date:  The user will be prompted for a date.  The date must be
  170.         entered as m/d or m/d/y.  Leading zero's can be entered, but they
  171.         are not required.  Today or later is all that will be accepted up
  172.         until year 2030.  Any date entered without a year, will default to
  173.         the next date in the upcoming year. 
  174.   
  175.         Enter Days:  Enter the number of days you would like to be reminded
  176.         of this event ahead of time.  The default is 10 days.  You can
  177.         enter 0 - 45 days.  
  178.   
  179.         Enter (Reference) Year:  You may enter a 4 digit year from 1800 up
  180.         until current year.  This is useful for birth years and wedding
  181.         anniversary years.  If a valid year is entered, the number of years
  182.         from the reference year to the current year will be displayed on
  183.         the SEARCH EVENT screen.  Press <return> to skip the reference year.
  184.         BADGER will not allow the user to enter an invalid year.
  185.  
  186.         Enter Event Description:  Enter a description of the event.  This is
  187.         the message that will be displayed to the user when the event is
  188.         displayed.  
  189.  
  190.         NOTE:  The SEARCH EVENT screen will show how old a person is or
  191.         how many years ago their anniversary was if a reference year is
  192.         entered and the word 'birthday' or 'anniversary' appears in the
  193.         Event Description field.
  194.  
  195. 3.  (v) The user will be prompted for all or part of an Event Description
  196.         to search for.  The search is an un-anchored & non-case-sensitive.
  197.         This means that entering "ann" would locate both:
  198.  
  199.         Mom & Dad's anniversary
  200.         Ann Miller's Birthday
  201.  
  202.         Or, press <return> to view all records.
  203.  
  204.         Any event that is 'due' will be highlighted on the VIEW EVENT
  205.         display.
  206.  
  207.           MS-DOS:  Due events will appear WHITE, all others will appear in
  208.                    LIGHTCYAN.
  209.         AmigaDOS:  Due events will appear in bolded color 3, all others
  210.                    will appear in color 3 only.  Color 3 (when the default
  211.                    colors are being used) is orange in AmigaDOS1.2 and
  212.                    lightblue in AmigaDOS2.0.
  213.  
  214.  
  215.     1.  (c)  Continue:  
  216.  
  217.     2.  (d)  Delete:
  218.  
  219.     3.  (q)  Quit: 
  220.  
  221.     4.  (r)  Change Remind Date:  The Event Date can be changed with this
  222.              option.
  223.  
  224.     5.  (a)  Change Advance Notice:  The number of days advance notice for
  225.              the event can be changed with this option.
  226.  
  227.     6.  (y)  Change Reference Year:  The reference year can be added,
  228.              deleted or changed with this option.  An existing reference
  229.              year can be removed by entering a '0' at the prompt.
  230.  
  231.     7.  (e)  Change Event Description:  The Event description can be changed
  232.              with this option.
  233.  
  234. 4.  (h)  A short help/information screen will be displayed. 
  235.   
  236. 5.  (q)  If any changes were made to the event list, the user will be  
  237.          prompted to save or ignore the changes.  
  238.  
  239.     THE FOLLOWING CHOICES ARE NOT SHOWN ON THE MAIN BADGER MENU.
  240.     ------------------------------------------------------------
  241.     (P)  Print Event List:  An uppercase "P" must be used for this option.
  242.          This option is only available if there are any events in the
  243.          Event List.  Selecting this option will print your entire Event 
  244.          List on stdprn(MS-DOS) or prt:(AmigaDOS).  Insure that your printer
  245.          is turned on before selecting this option.  If any changes were
  246.          made to the Event List, the user will be prompted to store
  247.          the changes before printing begins.  It's usually a good idea
  248.          to store the changes at this point in case some printing error
  249.          occurs.
  250.  
  251.          MS-DOS users must be especially careful to insure that their
  252.          printer is turned on & is operational, since MS-DOS will exit
  253.          the program if any errors are encountered.  Data loss could occur
  254.          if your events have not been saved and a printing error occurs.
  255.  
  256.     (W)  Write Event List:  An uppercase "W" must be used for this option.
  257.          This option is only available if any changes have been made to
  258.          the Event List.  Selecting an uppercase 'W' will write the Event
  259.          List to disk if any changes have been made.  Use of this option
  260.          is normally not necessary, since the user will be prompted to
  261.          save any changes on exit from the program.
  262.  
  263.   
  264. DATA FILE LOCATION:  
  265. -------------------  
  266. MS-DOS:
  267.  
  268. The BADGER program looks at the drive that it was executed from and assumes
  269. that this is the drive that the user wants to store the data file on.  So,
  270. if you have BADGER.EXE on your c: drive, BADGER will use
  271. C:\BADGER\BADGER.DAT for the data file.  Or if you have BADGER.EXE on the a:
  272. drive, BADGER will use A:\BADGER\BADGER.DAT instead.  This allows the
  273. program to be used by both hard drive and floppy disk users.  If a current
  274. file exists, then it will be renamed to 'BADGER.BAK' and the new information
  275. will be written to 'BADGER.DAT'.  This insures that the previous generation
  276. file will always be available in the \BADGER directory.  If the \BADGER
  277. directory doesn't exist, BADGER.EXE will create it.  
  278.  
  279. AmigaDOS:
  280.  
  281. BADGER stores the data file in your logically assigned s: directory.  The
  282. date file is named s:badger.data.  Whenever BADGER writes new information,
  283. badger.data (if it exists) is renamed to badger.bak and the new data is
  284. written to badger.data.  This insures that the previous generation file is
  285. always available if needed.
  286.  
  287.   
  288. AUTOEXEC.BAT (MS-DOS) / STARTUP-SEQUENCE (AmigaDOS) FILE  
  289. --------------------------------------------------------  
  290. Add the following line to your autoexec.bat/startup-sequence file after any 
  291. commands necessary to set your system clock.  
  292.   
  293.    BADGER -s    : check the event list on very boot or reboot 
  294.  
  295.    or
  296.  
  297.    BADGER -o    : check the event list only the first boot per day
  298.   
  299. Each time you boot your computer, BADGER will check for any important events
  300. that are 'due' and display them to the user.  If there is nothing to
  301. display, there will be no output.  See the RETURN CODE section below.  The
  302. display will be identical to the "Search For Important Events" from the
  303. BADGER menu, except that the main menu will not be displayed.
  304.  
  305. AmigaDOS:
  306.  
  307. Since the Amiga is a multi-tasking machine, BADGER can be 'run' to allow
  308. your startup-sequence to continue in the background while BADGER is running.
  309. This allows BADGER to check and/or display events that are due while your
  310. startup-sequence continues.  If you desire to 'run' BADGER, add this line
  311. to your startup-sequence instead of 'badger -s':
  312.  
  313.    run >nil: badger -s     -or-     run >nil: badger -o
  314.   
  315.   
  316. INSTALLATION:  
  317. -------------  
  318.  
  319. MS-DOS:
  320.  
  321. Execute the supplied 'install' program.  BADGER will be installed on your
  322. hard-disk.  Your autoexec.bat file will be modified so BADGER will check the
  323. event list for 'due' events when the computer is booted.
  324.  
  325. See the README.1ST file for more information, or....
  326.  
  327. Copy BADGER.EXE to any directory that is in your current path.  Remember 
  328. that BADGER will use the drive that you executed BADGER.EXE from for the  
  329. location of the data file as described above. 
  330.  
  331. BADGER will fail if a file named BADGER exists in the root directory of
  332. the disk you are running BADGER from.  This is because BADGER will try and
  333. make a directory called BADGER and will fail if a file named BADGER exists.
  334.  
  335. AmigaDOS:
  336.  
  337. Badger and badger.info can be copied to any location on your disk.  If you
  338. copy badger to a directory that is not in your current path, you will have
  339. to give a fully qualified path when executing badger from your startup-
  340. sequence.  For example:  If dh0:extra is not in your current path and you
  341. have copied badger to this directory, you will need to enter 
  342.    
  343.    dh0:extra/badger -s    (or dh0:extra/badger -o)
  344.  
  345. to your startup-sequence so your computer can find it.
  346.  
  347.  
  348. FLOPPY DISK USERS
  349. -----------------
  350. This program will work from floppy disks, but may be annoyingly slow to run
  351. each and every time your system is booted from every disk.  I suggest that a
  352. bootable (and writable) disk be created with the program run from the
  353. autoexec.bat/startup-sequence as described above.  Then simply boot from
  354. your BADGER disk whenever you want to check your event list.
  355.  
  356.  
  357. RETURN CODE (MS-DOS and AmigaDOS) 
  358. -----------  
  359. If an error occurs that terminates the program prematurely, a return code of
  360. 10 (ERROR) is passed to the DOS shell along with a message printed to the 
  361. screen informing the user.  
  362.  
  363. When the program is executed using the -s or -o option, a return code of
  364. 5 (WARN) is returned to the DOS shell if there were important events to
  365. display.  No messages or errors are displayed.  Adding 'BADGER -s' to your
  366. autoexec.bat/startup-sequence file will produce no output unless an
  367. important event is displayed.
  368.  
  369. The user can safely ignore the return code if desired.   
  370.   
  371. AmigaDOS:
  372.  
  373. You can trap for a no-event condition by checking the return
  374. code in the script you are executing 'badger -s' from.
  375.  
  376. ....
  377.  
  378. badger -s
  379. if NOT WARN
  380.    echo "No Important Events Today"
  381.    endif
  382.  
  383. ....
  384.  
  385. If you want some type of message displayed if there were no important events
  386. to display, add the above code to your startup-sequence.  Otherwise badger
  387. -s (or -o) will execute quietly unless there is an important event to
  388. display. 
  389.  
  390.  
  391.  
  392. Color: (MS-DOS users only, AmigaDOS always uses color)
  393. ------------------------------------------------------
  394. Text and background color is difficult to control in MS-DOS due to the many
  395. possible combinations of graphics cards and monitors.  Many programs will
  396. change the text or background colors for their use and not return them to 
  397. the original colors when the program ends.  This is poor programming. 
  398. BADGER always attempts to return your display to the way it found it.
  399. BADGER attempts to determine the type of video adapter and current textmode
  400. to determine if the display should be in color or black & white.  You can
  401. override the automatic choices using one of the methods shown below:
  402.  
  403. Using the '-c' option will cause the display to change to the opposite of
  404. the currently 'normal' display when executing BADGER with no option.
  405. That is, if BADGER normally displays in color, using the '-c' option will
  406. change the display to a black & white display, and vice-versa.  Of course
  407. you must have a color monitor and color video adapter to have a color
  408. display.
  409.  
  410. The '-c' option can be set with an environmental variable if desired to
  411. avoid having to specify the '-c' option every time BADGER is executed.
  412. Add the following line (or enter it at the DOS prompt) to your autoexec.bat
  413. file.
  414.  
  415.                set NOCOLOR=x   (no spaces are allowed on either side
  416.                                 of the equals sign)
  417.  
  418. Using the '-l' option will cause the BADGER display to use no text
  419. attributes in it's display.  This can be useful when using an LCD monitor
  420. due to the "reversed" nature of their display.  
  421.  
  422.                set NOCOLOR=LCD   (no spaces are allowed on either side
  423.                                   of the equals sign)
  424.  
  425. If the NOCOLOR environmental variable is set to LCD or the '-l' option is
  426. used, the '-c' option will have no effect.
  427.  
  428. If you are not using a color monitor, experiment with the NOCOLOR variable
  429. or the '-c' and '-l' options to get the best and most readable display.
  430.  
  431. Public domain programs UDATE (v1.21s+) and FORTUNE (v2.02s+) can also
  432. read the NOCOLOR environmental variable if it's set.
  433.  
  434.  
  435. UPDATES?
  436. --------
  437. Due to the initial low price of BADGER, registered users will not receive
  438. automatic notification of any updates, bug fixes or improvements to BADGER.
  439. Any registered user may request the latest version of BADGER by sending $5
  440. (for shipping & handling only) to the author.  To be eligible for the
  441. update, you must send me your current version number and serial number.
  442. Very early AmigaDOS versions of BADGER were not serialized, you must
  443. inform me of this fact. 
  444.  
  445. Updates will only be sent to the original address of the purchaser.  If you
  446. have moved, you must send your original disk as proof of purchase.
  447.  
  448.  
  449. STATUS:  
  450. -------  
  451. This program is SHAREWARE.  If you find this program useful, you are
  452. required to mail the author $15 as payment for the program and to register
  453. your copy.
  454.  
  455. If you have a registered version of BADGER, you MAY NOT FREELY DISTRIBUTE
  456. your copy.  Only unregistered 'usage' protected copies may be freely
  457. distributed.  
  458.  
  459. Usage protected SHAREWARE versions of this program can be freely distributed
  460. as long as all files are included in the archive.  The archive should 
  461. contain the following files:
  462.  
  463. MS-DOS:   1. badger.exe           AmigaDOS:  1. badger
  464.           2. badger.doc                      2. badger.doc
  465.           3. badger.reg (register)           3. badger.info (icon)
  466.           4. README.1ST                      4. REGISTER.TXT
  467.           5. convert.exe                     5. convert
  468.           6. convert.doc                     6. convert.doc
  469.           7. install.exe                     7. help.me
  470.           8. help.me
  471.  
  472. If a SHAREWARE copy of BADGER is redistributed, it should be the exact copy
  473. copy that was obtained from the archive.  This is, the copy that is
  474. distributed should not have been executed.  You can determine if BADGER has
  475. ever been executed by executing badger using '-check' as an option.  If
  476. If BADGER has been date-stamped, that copy should not be distributed, since
  477. since it will become inoperative 45 days from the first time it was 
  478. executed, not 45 days from when the new user first executes it.
  479.  
  480. Please specify MS-DOS (3 1/2 or 5 1/4) or AmigaDOS.  If you wouldn't steal
  481. a program off the shelf in a software store, please don't steal the program
  482. from me.  If you use the program beyond the 30 day trial period, failure to
  483. mail payment is theft.  An ordering form has been provided in the text file
  484. "BADGER.REG" (MS-DOS) or REGISTER.TXT (AmigaDOS).
  485.  
  486. Registered users of BADGER may purchase a copy of BADGER for the other
  487. operating system for $10.  Please include your current serial number
  488. when ordering.
  489.  
  490. I am not responsible for any failure of this program, or any missed events
  491. or any consequences of the missed event. (I hate responsibility)  
  492.    
  493.   
  494.                            George Kerber  
  495.                            19756 E. Linvale Drive  
  496.                            Aurora, Colorado  80013  
  497.                            303-692-2890  
  498.   
  499.                            Compuserve 74010,2132  
  500.