home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / DOOR / DHOUSE13.ZIP / DOGHOUSE.DOC < prev    next >
Text File  |  1995-11-20  |  12KB  |  230 lines
  1. 1995 -Noel Software-
  2.  
  3.  
  4.                              The Dog House! v1.3
  5.                       For Wildcat! 3.XX & 4.XX Systems
  6.                      Copyright (c) 1995 Thomas J. Smith
  7.                         For the latest version, call
  8.                       The Last Call BBS! (313) 295-6284
  9.                Or FREQ it from 1:2410/903 Magic Name DOGHOUSE
  10.  
  11.  
  12. ╒═══════════════════════════════════════════════════════════════════════════╕
  13. │  The Dog House! A Great new program that lists all callers who dropped    │
  14. │carrier, where they are calling from, and how many times they dropped      │
  15. │carrier! Also shows the total of drop carriers for the day.                │
  16. │Now has a "Big Dog" option! Can exclude callers from being listed by both  │
  17. │security level, and by name.                                               │
  18. ╘═══════════════════════════════════════════════════════════════════════════╛
  19.  
  20.  
  21.   *** New In v1.3 ***
  22.  ────────────────────────────────────────────────────────────────────────────
  23.   ■ Added option to have security levels and/or user names excluded from the
  24.     output. This is configurable by the SysOp. Read part 3, Setting it Up
  25.     for details.
  26.  
  27.   ■ Fixed "Big Dog" feature to only show either the caller with the
  28.     highest number of drop carriers, or if there is a tie between two or
  29.     more users, it will list the most recent one as the "Big Dog." If no
  30.     one has more than one drop carrier, then no Big Dog will be shown.
  31.  
  32.   ■ Rewrote the SETUP program. It is now easier to use and allows you to
  33.     navigate through the input fields with your arrow keys.
  34.  ────────────────────────────────────────────────────────────────────────────
  35.  
  36.  
  37.  
  38.  
  39. ╒═══════════════════════════════════════════════════════════════════════════╕
  40. │ CONTENTS                                                                  │
  41. ╘═══════════════════════════════════════════════════════════════════════════╛
  42.  What is The Dog House?....................................................1
  43.  Files Included............................................................2
  44.  Setting it Up & Upgrading.................................................3
  45.  The Setup Program.........................................................4
  46.  Contacting The Author.....................................................5
  47.  Disclaimer................................................................6
  48.  
  49.  
  50.  
  51. ╒═══════════════════════════════════════════════════════════════════════════╕
  52. │ What is The Dog House?                                                  1 │
  53. ╘═══════════════════════════════════════════════════════════════════════════╛
  54.  
  55.     The Dog House is a great new program that lists all of the callers who
  56.  dropped carrier for the day, where they called from, how many times they
  57.  dropped carrier, and the total of dropped carriers for the day! This
  58.  program was written to work with Wildcat! 4.XX, I am not sure if it will
  59.  work on previous versions. If you find out, then I would greatly appreciate
  60.  it if you could let me know. See part 4 on where to contact me.
  61.     I have included support for Wildcat! 3.XX style activity logs, but have
  62.  not had the opportunity to test it on a Wildcat! 3.XX system.
  63.  
  64.  
  65.   How it Works
  66.  ──────────────
  67.     It reads the activity log for every node that you have, after every call
  68.  via the POSTCALL.BAT file. It searches for callers who dropped carrier,
  69.  then writes their name, and where they were calling from to the output
  70.  file, along with how many times they dropped carrier today.
  71.  
  72.     Each day, a new output file will be written. The program only looks for
  73.  dropped carriers for the day. At the bottom of the output file, the date,
  74.  the day, and the total of dropped carriers for the day are all posted
  75.  (see OUTPUT.BBS for a sample of the output).
  76.  
  77.     If you choose to use the "Big Dog" feature, then the caller with the most
  78.  dropped carriers for the day will be posted at the bottom of the output
  79.  file, along with where they are calling from. If there are more than one
  80.  callers with the same number of dropped carriers, then it will post the
  81.  most recent dropped carrier in the "Big Dog" section. If there are no
  82.  callers with more than one dropped carrier, then no one will be posted as
  83.  the "Big Dog."
  84.  
  85.  
  86.  
  87. ╒═══════════════════════════════════════════════════════════════════════════╕
  88. │ Files Included                                                          2 │
  89. ╘═══════════════════════════════════════════════════════════════════════════╛
  90.  
  91.  Included with your copy of DHOUSE13.ZIP should be the following files,
  92.  
  93.  DOGHOUSE.EXE ──> Main Program file.
  94.  SETUP.EXE    ──> Setup Program for creating configuration file.
  95.  DOGHOUSE.CFG ──> Sample Configuration file (look this over!).
  96.  DOGHOUSE.DOC ──> The documentation you are reading now.
  97.  FREQ_IT.TXT  ──> List of FREQ'able programs from -Noel Software-.
  98.  FILE_ID.DIZ  ──> Description file for BBS's.
  99.  WHATSNEW.TXT ──> File containing latest changes, additions, fixes, etc.
  100.  SYSOP.TXT ─────> Distribution site info
  101.  SITES.TXT ─────> List of distribution sites
  102.  OUTPUT.BBS   ──> Sample of Dog House's output.
  103.  
  104.  
  105.  
  106. ╒═══════════════════════════════════════════════════════════════════════════╕
  107. │ Setting it Up                                                           3 │
  108. ╘═══════════════════════════════════════════════════════════════════════════╛
  109.  
  110.     1) Unpack the DHOUSE13.ZIP file to its own directory.
  111.  
  112.     2) Change to the new Dog House directory, and run the SETUP program, or
  113.        edit the enclosed DOGHOUSE.CFG to reflect your setup and preferences.
  114.        (see setup chapter below for details on setup program, and see
  115.        DOGHOUSE.CFG for an example configuration file).
  116.  
  117.     3) If you wish to exclude some users by security level, then create an
  118.        ASCII file named EXCLUDE#.CFG, with one security level per line, and
  119.        place it in your Dog House directory.
  120.        Example EXCLUDE#.CFG,
  121.                             SYSOP
  122.                             CO-SYSOP
  123.                             VISITOR
  124.                             1000
  125.        The file can have as many security levels as you wish to exclude from
  126.        the output, and they will not be listed in the Dog House if they drop
  127.        carrier.
  128.  
  129.     4) If you wish to exclude some users by their name, then create an ASCII
  130.        file named EXCLUDE.CFG, with one name per line, and place it in your
  131.        Dog House directory. The names must match those in your BBS database
  132.        that you want to exclude from the output.
  133.        Example EXCLUDE.CFG,
  134.                            Thomas Smith
  135.                            BART SIMPSON
  136.                            edmur fuddpucker
  137.                            BiLlY bEaR
  138.        Just like the EXCLUDE#.CFG file, this one also can be as long as you
  139.        want. Case is not important. Any caller who drops carrier, and their
  140.        name is in this file, then they will not be put in the Dog House! :)
  141.  
  142.     5) Add the Dog House program to your POSTCALL.BAT file, or if you do not
  143.        yet have a postcall bat file running, create one with these three
  144.        lines,
  145.              C:                   <--Or whatever drive it will be located on.
  146.              CD\WC-UTILS\DOGHOUSE <--Change to Dog House directory.
  147.              DOGHOUSE             <--Run Dog House!
  148.  
  149.        You can add a /X command line switch to the DOGHOUSE command, if you
  150.        wish to suppress the progress output to the screen. Example,
  151.        DOGHOUSE /X. If you need to, "CD" back to your BBS directory, or
  152.        restart Wildcat! if you terminate instead of swapping out.
  153.  
  154.  
  155.  
  156.  
  157.   Upgrading
  158.  ───────────
  159.     If you are upgrading from v1.0, or 1.1, then all you will have to do is
  160.  replace your existing DOGHOUSE.EXE & SETUP.EXE programs with these new ones,
  161.  and run the new SETUP.EXE program to create a new configuration file, or
  162.  edit your current one, to reflect the neccessary changes. Then you may want
  163.  to run Dog House manually once, to rewrite the output file to reflect the
  164.  new "Big Dog" option (if you opt to use this feature).
  165.  
  166.  
  167.  
  168. ╒═══════════════════════════════════════════════════════════════════════════╕
  169. │ The Setup Program                                                       4 │
  170. ╘═══════════════════════════════════════════════════════════════════════════╛
  171.  
  172.     The setup program is quite simple to use. At the Main Menu you are
  173.  presented with only two options, "Setup Dog House" and "Exit Setup." When
  174.  you choose to Setup Dog House, then if DOGHOUSE.CFG exists in the current
  175.  directory, then it will be read, and that info will be loaded into the
  176.  setup program. Then you can use your arrow keys to navigate between fields,
  177.  and edit the info as necessary. After you are done, press F10 to save your
  178.  changes, and DOGHOUSE.CFG will be rewritten.
  179.     If DOGHOUSE.CFG does not exist upon selecting the "Setup Dog House"
  180.  option, then the fields will be blank. Just fill them in with the proper
  181.  info, and press F10 when you are done to save your changes.
  182.  
  183.     To abort the setup at any time, just press ESC.
  184.  
  185.  
  186.  
  187. ╒═══════════════════════════════════════════════════════════════════════════╕
  188. │ Contacting The Author                                                   5 │
  189. ╘═══════════════════════════════════════════════════════════════════════════╛
  190.  
  191.     If you have any questions, comments, or suggestions, I would be glad to
  192.  hear from you. I can be reached on my BBS, The Last Call BBS! (313) 295-6284
  193.  or on MSI's HQ BBS, or via Internet E-Mail at Thomas.Smith@wland.ack.mi.org
  194.  If you write to me on MSI's BBS, use the name Thomas J.Smith, where J.Smith
  195.  is one word (I'm not the only Thomas J. Smith on MSI's board!), and give
  196.  me some time to respond, as I only call there when I have a new program to
  197.  upload, or a program update. You can also send mail to my FIDO address at
  198.  1:2410/903.
  199.  
  200.     All SysOps who call my BBS receive 160 minutes a day online time, and no
  201.  download limit. Just let me know that you run a BBS, and I will upgrade
  202.  your access.
  203.  
  204.  
  205.  
  206. ╒═══════════════════════════════════════════════════════════════════════════╕
  207. │ Disclaimer                                                              6 │
  208. ╘═══════════════════════════════════════════════════════════════════════════╛
  209.  
  210.     This program is distributed as FREEWARE, This program may be freely
  211.  distributed. You are encouraged to share this program with others. You may
  212.  keep and use this program for as long as you wish, pass it out to others,
  213.  upload it to BBS's, and make it available for download on your BBS (where
  214.  applicable).
  215.  
  216.     No money may be collected by anyone for this program, except for those
  217.  companies collecting costs for packaging and disks, not to exceed $5.00 U.S
  218.  dollars. Exceptions are organizations distributing this product on CD-ROM,
  219.  whose costs may exceed $5.00 for packaging and disks.
  220.  
  221.     There are no warranties of any kind implied with this program. Use of
  222.  this program is the sole responsibility of the user. The author of this
  223.  program claims no responsibility whatsoever for damages of any kind related
  224.  to the use of this program. You use it at your own risk.
  225.  
  226.  
  227. ┌───────────────────────────────────────────────────────────────────────────┐
  228. │ END OF DOGHOUSE.DOC                                                       │
  229. └───────────────────────────────────────────────────────────────────────────┘
  230.