HANGUP.DOC

9.9 KB 9fb8f655e8eca16a…
 ┌──────────────────┐
 ├──────────────    │         -  NorthWind SoftWare Presents -
 ├─────────         │                       HangUp!
 ├─────             │                The HangUp Alerter!
 │NorthWind SoftWare│                        v3.5
 │             ─────┤        (C)opyright 1992, All Right Reserved
 │        ──────────┤              For Use with Telegard 2.7
 │   ───────────────┤
 └──────────────────┘

==============================================================================


Disclaimer:
~~~~~~~~~~~

The author(s) of this software are in no way responsible for damages caused
by this program.  If something does happen to your system, please notify us
immediately.  Netmail can be sent to us at the addresses listed at the
end of this document.  This program has undergone testing, and while it works
on my system with no problems, I can't make any promises about yours!


The FREEware concept:
~~~~~~~~~~~~~~~~~~~~~

HangUp! is released into the public domain with only one "price".
We ask that you let us know what you think of our program and that you
help distribute it as far as you can!  (cheap at half the price, eh?).
Also, if you see a need for a particular utility for Telegard, get ahold
of one of us!  We're always on the prowl for a good project <grin>.
We can be reached either through netmail, or through any of several forums
in the USTGNET dealing with Telegard support.


Credits:
~~~~~~~~

Telegard is a registered trademark of software copyrighted by Martin
Pollard.

Bluewave is a registered trademark of software copyrighted by George
Hatchew.

Overview of HangUp!:
~~~~~~~~~~~~~~~~~~~~

When a User logs off incorrectly, Telegard records this information in the
SYSOP.LOG of the day.  HangUp! reads this log and sends a prepared email
message to the offending user, notifying the User of the improper logoff.
HangUp! will also notify the SysOp via email of the improper logoff.


Whats New:
~~~~~~~~~~

Now, Hangup! will make a displayable bulletin (using Telegard color codes!)
showing who the dastardly Users were that dropped carrier on the BBS.  This
is strictly an option, which can be disabled.  Or, (heh, heh) display it
for all to see <grin>.  The message to the SysOp is also now an option.
HangUp! now includes the ability to create its own configuration file.     


This archive consists of five files:

        HANGUP.DOC      This text file you are reading
        HANGUP.CFG      Sample Configuration file
        HANGUP.EXE      The executable program
        HANGUSER.MSG    Sample text file message to be sent to the user
        HANGSYSP.MSG    Sample text file message to be sent to the SysOp


Operation of Hangup!:
~~~~~~~~~~~~~~~~~~~~~

1.  HangUp! must be able to locate the Telegard STATUS.DAT file.  So
    either your BBS directory must be on the path, or HangUp! must reside
    in the same directory as the STATUS.DAT file.

2.  HangUp! is best run as part of a nightly event, before the SYSOP.LOG
    file has been renamed for the start of a new day.  Once you have
    modified the configuration file for *your* BBS, just run the program!

3.  The major upgrade in this version of HangUp! is in the configuration
    file.  To make setting up HangUp! as painless as possible, HangUp! now
    has a command switch of: /CFG that will build the configuration file.
    Run:  HANGUP /CFG and HangUp! will prompt you for the information it
    needs!  (Be sure you have already created the messages that you wish
    to have sent).  And as always, case is irrelevant.

4.  Included in the archive is a sample configuration file that is
    *well* commented, so it should be easy to modify for your BBS.  It is
    a bit more complex than our earlier version, so lets go through it,
    step by step:

             >>>>>>>>> SAMPLE CONFIGURATION FILE <<<<<<<<<


Configuration Entry                     Explanation
^^^^^^^^^^^^^^^^^^^                     ^^^^^^^^^^^

HANGUSER.MSG                           ;This is the text file sent as
                                       ;email to the user

HANGSYSP.MSG                           ;This is the text file sent as
                                       ;email to the sysop (or NONE if no
                                       ;message is desired)

LOGON1.MSG                             ;This is the Bulletin Name you want,
                                       ;or NONE if you don't want a bulletin

PLEASE LOGOFF PROPERLY, THANKS!        ;SysOp-defined one line message
                                       ;for the bulletin

DOUBLE                                 ;Type of Border for the bulletin;
                                       ;- Choices: None, Single, Double
                                       ;  Double Edge, Double Top-Bottom

                                                                             
                                       ;The following colors correspond with
                                       ;the SYSOP defined Telegard colors,
                                       ;and are for the bulletin:

2                                      ;Border Color

3                                      ;Heading Color

4                                      ;User name Color

5                                      ;User Number Color

6                                      ;The sysop-defined message color

BLUEWAVE.BAT                           ;Valid doors to hangup in
CALLBACK.BAT
NETDOR.BAT

             >>>>>>>>> END OF CONFIGURATION EXAMPLE <<<<<<<<<


4.  If you specify that you want a bulletin, you must be sure that all
    lines in the configuration file dealing with the bulletin have a valid
    entry in them, otherwise HangUp! will abort with an error message.

5.  The bulletin will be put into your Afiles directory.  If you do not
    have the HANGUSER.MSG and the HANGSYSP.MSG in the same directory as
    HangUp!, then you must specify a full path statement along with the
    file name.  HANGUP.CFG must be in the same directory as HangUp!, or it
    must be on the path.

6.  Some doors (such as Bluewave or a callback verifier) might show a
    dropped carrier in the SYSOP.LOG  HangUp! will skip sending a message
    to Users who enter these doors, as long as you define these doors
    in the configuration file.  There is no limit to how many doors you
    exempt.  Make sure you use the complete batch filename used to call the
    door!

7.  The Configuration file may also contain blank lines and/or comments,
    as long as the comments are preceeded by a semi-colon

8.  Included in this archive are two sample text files for the program,
    HANGUSER.MSG and HANGSYSP.MSG  These are the messages sent to the User
    and to the SysOp.  You may edit/replace them with a custom message,
    being as sweet or as nasty as you desire.  These text files can have
    any name.

*SPECIAL NOTES*

1.  Before running HangUp! BACK UP your E-Mail BRD and MIX files just to make
    sure nothing is accidentally corrupted.  This shouldn't happen, but it's
    nice to be sure you're prepared if it does!

2.  Telegard color code number 6 is white lettering with blue background.
    If used (like in the sample configuration file), the blue background
    will fill the entire line, not just the lettering, so you might want
    to try something else!
                                                                             

Version History:
~~~~~~~~~~~~~~~~

Changes from 2.5ß:

   * Major overhaul basically.  HangUp! uses a totally different aspect
     to nail offending users.

   * HangUp! now E-Mails offenders and SysOps instead of the SHORTMSG.DAT
     method which proved to be very ineffective.  The new method should
     catch the normal user and help prevent this offensive behavior.

   * HangUp! is fully compatible with Telegard 2.7
     HangUp! will *ONLY* work with v2.7 after the full rewrite of the message
     bases structures.

Changes from    :

   * Recompiled to be compatible with 8086/8088's  (hey!! it happens)

Changes from 3.0:

   * Added the option of having a displayable bulletin created, showing
     the Users that have dropped carrier.

   * Fixed a teeny, tiny (hardly worth mentioning) bug that sometimes would
     send an email message to the wrong User.

   * Made sending E-mail to the SysOp an option.

   * Added a built in Setup Utility to make HangUp's installation easy!


Technical Support:
~~~~~~~~~~~~~~~~~~

   If you have any problems, or comments as to the usage or production of
   this program, feel free to call our BBS's:

   Chief Programmer                          Chief Programmer
   Josh Lippy                                Dave Elmer
   The Data Control Center                   The Darkside            
   (301)831-1014                             (703)951-0347
   1:109/715@fidonet.org                     1:2602/114@fidonet.org
   85:865/101@ustgnet.org                    85:887/101@ustgnet.org

                         Support/Test Site
                         Robert Hinshaw
                         Far Point Enclave
                         (316)721-8117 
                         1:291/16@fidonet.org
                         85:847/102@ustgnet.org

       Thanks for trying our program and we hope you enjoy it!

Other fine products you might want to try:

Callog!    The Quick Caller/SysOp Log for FEM's!
CheckUL!   Remove deleted user names from "U/L'd by" lines in File Areas
FPComp!    File point compensator for SDN files
MassMail!  Send Mass E-Mail to Users based on ACS strings
PCRFix     Corrects minor bug in the Telegard Post/Call Ratio
TGFDLog!   View Users called & k-bytes Transferred from FD History log
UReward!   Reward the Uploaders of your most popular files!

For The Latest Version, File Request by the magic names of: CALLOG,
CHECKUL, FPCOMP, MASSMAIL, PCRFIX, TGFDLOG and UREWARD