home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / BBS / TELEGARD / HANGUP35.ZIP / HANGUP.DOC < prev    next >
Encoding:
Text File  |  1992-04-08  |  9.9 KB  |  247 lines

  1.  ┌──────────────────┐
  2.  ├──────────────    │         -  NorthWind SoftWare Presents -
  3.  ├─────────         │                       HangUp!
  4.  ├─────             │                The HangUp Alerter!
  5.  │NorthWind SoftWare│                        v3.5
  6.  │             ─────┤        (C)opyright 1992, All Right Reserved
  7.  │        ──────────┤              For Use with Telegard 2.7
  8.  │   ───────────────┤
  9.  └──────────────────┘
  10.  
  11. ==============================================================================
  12.  
  13.  
  14. Disclaimer:
  15. ~~~~~~~~~~~
  16.  
  17. The author(s) of this software are in no way responsible for damages caused
  18. by this program.  If something does happen to your system, please notify us
  19. immediately.  Netmail can be sent to us at the addresses listed at the
  20. end of this document.  This program has undergone testing, and while it works
  21. on my system with no problems, I can't make any promises about yours!
  22.  
  23.  
  24. The FREEware concept:
  25. ~~~~~~~~~~~~~~~~~~~~~
  26.  
  27. HangUp! is released into the public domain with only one "price".
  28. We ask that you let us know what you think of our program and that you
  29. help distribute it as far as you can!  (cheap at half the price, eh?).
  30. Also, if you see a need for a particular utility for Telegard, get ahold
  31. of one of us!  We're always on the prowl for a good project <grin>.
  32. We can be reached either through netmail, or through any of several forums
  33. in the USTGNET dealing with Telegard support.
  34.  
  35.  
  36. Credits:
  37. ~~~~~~~~
  38.  
  39. Telegard is a registered trademark of software copyrighted by Martin
  40. Pollard.
  41.  
  42. Bluewave is a registered trademark of software copyrighted by George
  43. Hatchew.
  44.  
  45. Overview of HangUp!:
  46. ~~~~~~~~~~~~~~~~~~~~
  47.  
  48. When a User logs off incorrectly, Telegard records this information in the
  49. SYSOP.LOG of the day.  HangUp! reads this log and sends a prepared email
  50. message to the offending user, notifying the User of the improper logoff.
  51. HangUp! will also notify the SysOp via email of the improper logoff.
  52.  
  53.  
  54. Whats New:
  55. ~~~~~~~~~~
  56.  
  57. Now, Hangup! will make a displayable bulletin (using Telegard color codes!)
  58. showing who the dastardly Users were that dropped carrier on the BBS.  This
  59. is strictly an option, which can be disabled.  Or, (heh, heh) display it
  60. for all to see <grin>.  The message to the SysOp is also now an option.
  61. HangUp! now includes the ability to create its own configuration file.     
  62.  
  63.  
  64. This archive consists of five files:
  65.  
  66.         HANGUP.DOC      This text file you are reading
  67.         HANGUP.CFG      Sample Configuration file
  68.         HANGUP.EXE      The executable program
  69.         HANGUSER.MSG    Sample text file message to be sent to the user
  70.         HANGSYSP.MSG    Sample text file message to be sent to the SysOp
  71.  
  72.  
  73. Operation of Hangup!:
  74. ~~~~~~~~~~~~~~~~~~~~~
  75.  
  76. 1.  HangUp! must be able to locate the Telegard STATUS.DAT file.  So
  77.     either your BBS directory must be on the path, or HangUp! must reside
  78.     in the same directory as the STATUS.DAT file.
  79.  
  80. 2.  HangUp! is best run as part of a nightly event, before the SYSOP.LOG
  81.     file has been renamed for the start of a new day.  Once you have
  82.     modified the configuration file for *your* BBS, just run the program!
  83.  
  84. 3.  The major upgrade in this version of HangUp! is in the configuration
  85.     file.  To make setting up HangUp! as painless as possible, HangUp! now
  86.     has a command switch of: /CFG that will build the configuration file.
  87.     Run:  HANGUP /CFG and HangUp! will prompt you for the information it
  88.     needs!  (Be sure you have already created the messages that you wish
  89.     to have sent).  And as always, case is irrelevant.
  90.  
  91. 4.  Included in the archive is a sample configuration file that is
  92.     *well* commented, so it should be easy to modify for your BBS.  It is
  93.     a bit more complex than our earlier version, so lets go through it,
  94.     step by step:
  95.  
  96.              >>>>>>>>> SAMPLE CONFIGURATION FILE <<<<<<<<<
  97.  
  98.  
  99. Configuration Entry                     Explanation
  100. ^^^^^^^^^^^^^^^^^^^                     ^^^^^^^^^^^
  101.  
  102. HANGUSER.MSG                           ;This is the text file sent as
  103.                                        ;email to the user
  104.  
  105. HANGSYSP.MSG                           ;This is the text file sent as
  106.                                        ;email to the sysop (or NONE if no
  107.                                        ;message is desired)
  108.  
  109. LOGON1.MSG                             ;This is the Bulletin Name you want,
  110.                                        ;or NONE if you don't want a bulletin
  111.  
  112. PLEASE LOGOFF PROPERLY, THANKS!        ;SysOp-defined one line message
  113.                                        ;for the bulletin
  114.  
  115. DOUBLE                                 ;Type of Border for the bulletin;
  116.                                        ;- Choices: None, Single, Double
  117.                                        ;  Double Edge, Double Top-Bottom
  118.  
  119.                                                                              
  120.                                        ;The following colors correspond with
  121.                                        ;the SYSOP defined Telegard colors,
  122.                                        ;and are for the bulletin:
  123.  
  124. 2                                      ;Border Color
  125.  
  126. 3                                      ;Heading Color
  127.  
  128. 4                                      ;User name Color
  129.  
  130. 5                                      ;User Number Color
  131.  
  132. 6                                      ;The sysop-defined message color
  133.  
  134. BLUEWAVE.BAT                           ;Valid doors to hangup in
  135. CALLBACK.BAT
  136. NETDOR.BAT
  137.  
  138.              >>>>>>>>> END OF CONFIGURATION EXAMPLE <<<<<<<<<
  139.  
  140.  
  141. 4.  If you specify that you want a bulletin, you must be sure that all
  142.     lines in the configuration file dealing with the bulletin have a valid
  143.     entry in them, otherwise HangUp! will abort with an error message.
  144.  
  145. 5.  The bulletin will be put into your Afiles directory.  If you do not
  146.     have the HANGUSER.MSG and the HANGSYSP.MSG in the same directory as
  147.     HangUp!, then you must specify a full path statement along with the
  148.     file name.  HANGUP.CFG must be in the same directory as HangUp!, or it
  149.     must be on the path.
  150.  
  151. 6.  Some doors (such as Bluewave or a callback verifier) might show a
  152.     dropped carrier in the SYSOP.LOG  HangUp! will skip sending a message
  153.     to Users who enter these doors, as long as you define these doors
  154.     in the configuration file.  There is no limit to how many doors you
  155.     exempt.  Make sure you use the complete batch filename used to call the
  156.     door!
  157.  
  158. 7.  The Configuration file may also contain blank lines and/or comments,
  159.     as long as the comments are preceeded by a semi-colon
  160.  
  161. 8.  Included in this archive are two sample text files for the program,
  162.     HANGUSER.MSG and HANGSYSP.MSG  These are the messages sent to the User
  163.     and to the SysOp.  You may edit/replace them with a custom message,
  164.     being as sweet or as nasty as you desire.  These text files can have
  165.     any name.
  166.  
  167. *SPECIAL NOTES*
  168.  
  169. 1.  Before running HangUp! BACK UP your E-Mail BRD and MIX files just to make
  170.     sure nothing is accidentally corrupted.  This shouldn't happen, but it's
  171.     nice to be sure you're prepared if it does!
  172.  
  173. 2.  Telegard color code number 6 is white lettering with blue background.
  174.     If used (like in the sample configuration file), the blue background
  175.     will fill the entire line, not just the lettering, so you might want
  176.     to try something else!
  177.                                                                              
  178.  
  179. Version History:
  180. ~~~~~~~~~~~~~~~~
  181.  
  182. Changes from 2.5ß:
  183.  
  184.    * Major overhaul basically.  HangUp! uses a totally different aspect
  185.      to nail offending users.
  186.  
  187.    * HangUp! now E-Mails offenders and SysOps instead of the SHORTMSG.DAT
  188.      method which proved to be very ineffective.  The new method should
  189.      catch the normal user and help prevent this offensive behavior.
  190.  
  191.    * HangUp! is fully compatible with Telegard 2.7
  192.      HangUp! will *ONLY* work with v2.7 after the full rewrite of the message
  193.      bases structures.
  194.  
  195. Changes from    :
  196.  
  197.    * Recompiled to be compatible with 8086/8088's  (hey!! it happens)
  198.  
  199. Changes from 3.0:
  200.  
  201.    * Added the option of having a displayable bulletin created, showing
  202.      the Users that have dropped carrier.
  203.  
  204.    * Fixed a teeny, tiny (hardly worth mentioning) bug that sometimes would
  205.      send an email message to the wrong User.
  206.  
  207.    * Made sending E-mail to the SysOp an option.
  208.  
  209.    * Added a built in Setup Utility to make HangUp's installation easy!
  210.  
  211.  
  212. Technical Support:
  213. ~~~~~~~~~~~~~~~~~~
  214.  
  215.    If you have any problems, or comments as to the usage or production of
  216.    this program, feel free to call our BBS's:
  217.  
  218.    Chief Programmer                          Chief Programmer
  219.    Josh Lippy                                Dave Elmer
  220.    The Data Control Center                   The Darkside            
  221.    (301)831-1014                             (703)951-0347
  222.    1:109/715@fidonet.org                     1:2602/114@fidonet.org
  223.    85:865/101@ustgnet.org                    85:887/101@ustgnet.org
  224.  
  225.                          Support/Test Site
  226.                          Robert Hinshaw
  227.                          Far Point Enclave
  228.                          (316)721-8117 
  229.                          1:291/16@fidonet.org
  230.                          85:847/102@ustgnet.org
  231.  
  232.        Thanks for trying our program and we hope you enjoy it!
  233.  
  234. Other fine products you might want to try:
  235.  
  236. Callog!    The Quick Caller/SysOp Log for FEM's!
  237. CheckUL!   Remove deleted user names from "U/L'd by" lines in File Areas
  238. FPComp!    File point compensator for SDN files
  239. MassMail!  Send Mass E-Mail to Users based on ACS strings
  240. PCRFix     Corrects minor bug in the Telegard Post/Call Ratio
  241. TGFDLog!   View Users called & k-bytes Transferred from FD History log
  242. UReward!   Reward the Uploaders of your most popular files!
  243.  
  244. For The Latest Version, File Request by the magic names of: CALLOG,
  245. CHECKUL, FPCOMP, MASSMAIL, PCRFIX, TGFDLOG and UREWARD
  246.  
  247.