home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-386-Vol-2of3.iso / c / cldrp330.zip / CALLDROP.DOC < prev    next >
Text File  |  1993-01-28  |  15KB  |  283 lines
  1.                         ╒═════════════════════════╕
  2.                         │  CALLDROP 3.30          │
  3.                         │  By Steve Mathieson     │
  4.                         │  ALL RIGHTS RESERVED    │
  5.                         │  Copyright 1993         │
  6.                         ╘═════════════════════════╛
  7.  
  8. Wot is it?
  9. ─────────
  10. Calldrop is a util that should be placed in your batch file before you
  11. delete your Max.log ( And maybe your Bluewave log also ), what it will do is
  12. scan the log for any users who Dropped Carrier during the day, and give you
  13. several optional reports of the cumulative statistics for each user.
  14.  
  15. Also, Calldrop will now keep running totals of Input timeouts and will track
  16. LEECH-Z modem usage for each user. These figures will be added into the Sysop
  17. report that's created when CallDrop is run.
  18.  
  19. This is NOT Public Domain software! Rather it is being distributed as Freeware
  20. ( In the spirit of Maximus ), you are free to use this software, without charge.
  21. If you are distributing this program please include all the Documentation and
  22. sample CFG files that are included.
  23.  
  24. *Please* If you choose to use this software let me know.  This is the only
  25. form of registration I request, as it allows me to gauge whether further
  26. development is worthwhile. Just a simple Netmail would be fine.
  27.  
  28. Quick Installation
  29. ──────────────────
  30. Put all the included CallDrop files into the directory you want to run
  31. CallDrop from. The MakeMsg.exe program can be placed either in the same
  32. directory as Calldrop, or somewhere in your path statement.
  33. Edit the Calldrop.cfg file to suit your needs, and edit your batch file(s)
  34. so that Calldrop is run during your event schedule just before you delete
  35. or otherwise rename/move the MAX.LOG. After Calldrop runs you may also want
  36. to add in MECCA statements in your batch to compile the report(s) generated.
  37.  
  38. Upgrading
  39. ─────────
  40. If you are upgrading from any previous version of CallDrop, all that is
  41. required is that you delete your CallDrop.Dat file.  Copy the new EXE over
  42. the old, edit your CFG and your all set.
  43.  
  44. Command Line Parameters
  45. ───────────────────────
  46. There are two optional parameters that may be passed on the command line
  47. when CallDrop is run: -KMAX Will cause CallDrop to delete your Maximus log
  48. file(s) after it has finished, and -KBLU will cause CallDrop to delete your
  49. BlueWave log file(s) when it's finished. Both these options are case
  50. insensitive.
  51.  
  52. The Calldrop.cfg File
  53. ─────────────────────
  54. The following is a list of valid Verbs that may be used in the CFG:
  55.  
  56. BBSNAME - Just put the Name of your system, and it will appear on the screen,
  57.           when Calldrop is run, and will be placed into your Sysop report file.
  58.  
  59. SYSOP - This is your Name, use this if you don't want your own Name to appear
  60.         in the Carrier drop report(s). Case is not important so joe sysop is
  61.         the same as JOE SYSOP or JoE SysOp. You may specify up to 5 SYSOP verbs
  62.         followed by names you don't want to appear in the reports. The name
  63.         following the first SYSOP verb is used as the FROM: field in messages
  64.         that are created. Any more than 5 are ignored. Also, names you don't
  65.         want to appear in the reports must match exactly the name that Max
  66.         writes to the log.
  67.  
  68. MAXLOG - This is the PATH and NAME of your Max.log files. This is where
  69.          Calldrop gathers it's information from, and is mandatory if you
  70.          want it to work. For Multi-line systems, You may specify up to 8
  71.          MAXLOGs to scan, by putting 8 MAXLOG verbs followed by the path and
  72.          filename to the log. They will all be scanned for data each time
  73.          Calldrop is run. Extras are ignored, and NOTE: the -KMAX command line
  74.          switch will delete ALL the logs specified when Calldrop is finished.
  75.  
  76. BLUEWAVE - This is ONLY for people who use the BlueWave Mail Door, and allow
  77.            the G)oodbye from within the door. Put the full path and filename
  78.            of your BlueWave log here. To use this feature, you MUST have the
  79.            Log General Activity   '='   set to YES in bwutils. Also, Calldrop
  80.            will not alter the logs in any way, so it's important to delete,
  81.            rename or move the BlueWave log file before Calldrop runs again.
  82.            The same applies to the Max.log file, Calldrop will be completely
  83.            inaccurate otherwise. For Multi-line systems, up to 8 BLUEWAVE logs
  84.            may be specified, extras are ignored. Also the -KBLU command line
  85.            switch will delete ALL the BlueWave logs specified when Calldrop
  86.            is finished.
  87.  
  88. REPORTPATH - This is the Directory where you want the Sysop Reports to be placed.
  89.              Both the ASCII, and the MECCA (if enabled) will be created here.
  90.              It may be worth noting here that the old ones will be overwritten
  91.              when the new is created. The report will be called either
  92.              SYSOP.RPT or SYSOP.MEC depending on what you specify for the
  93.              REPORT TYPE verb.
  94.  
  95. REPORT TYPE - This verb specifies the type of file you want the SYSOP report to
  96.               be created as. The two options are: MECCA, which will create the
  97.               Sysop report in a colour Mecca format using the colours you
  98.               specify with RPTCOLOUR. The second option being ASCII which will
  99.               cause Calldrop to create a flat ASCII sysop report.
  100.  
  101. RPTSHOW - Defines the minimum # of Drops for a user to be listed in the SYSOP
  102.           Report.. For example specifying RPTSHOW 5 will cause only users with
  103.           5 or more Carrier drops to be shown in the SYSOP.RPT file.
  104.  
  105. MAKEMEC - Uncomment this if you want to use either the default Mecca report, or
  106.           the Custom header. If it's commented out, no MEC's will be created
  107.           except for a SYSOP.MEC if you use custom color. ( See RPTCOLOUR )
  108.  
  109. MECPATH - The Directory where you want the MEC file created. The MEC file will
  110.           be placed in the directory, and named CALLDROP.MEC
  111.           Again, the old ones will be overwritten each time Calldrop is run, so
  112.           you can keep a fairly up to date record on-line for viewing if you
  113.           wish.
  114.  
  115. BULLSHOW - Works the same a RPTSHOW, but controls the minimum # required for
  116.            a user to be shown in the bulletin (MEC) files.
  117.  
  118. HEADERFILE - This verb will optionally allow you to use your own custom
  119.              MEC file for the MEC report generated. Basically all Calldrop
  120.              will do is copy it to the MECPATH, and append the data to the
  121.              end. This leaves the original untouched so you can easilly run
  122.              Calldrop in your batch file and update the report.
  123.              ALSO - Calldrop WILL NOT add in the Name and # of Drops headings
  124.              in to the report, I left this so you may put your own in.
  125.  
  126. QUIETMODE - If this is uncommented most screen output will be suppressed during
  127.             CallDrop's execution. This is faster, and is advised for use during
  128.             your batch processing.
  129.  
  130. SORTBY - This keyword allows you to specify how ( or if ) you want the output
  131.          reports to be sorted by either: NAMES - The users names in descending
  132.          alphabetical order, or NUMBER - the list to be in descending numeric
  133.          order on the number of Dropes per user. IE: The user with the most
  134.          drops to his name will be listed first. Also worth mentioning is that
  135.          the Calldrops data file is also saved in the sorted format, so if you
  136.          switch from Names to None for example, the list will still remain in a
  137.          semi-sorted format, and additions will be added to the end.
  138.  
  139. RPTCOLOUR           - Most of the Colours in the Sysop report created by
  140. Customizing Colours   Calldrop are configurable.
  141. (Canadian Spelling)   The RPTCOLOUR verb is followed by 10 numbers seperated
  142.                       by commas. Each number represents a colour, and the
  143.                       order of the Numbers is VERY important. Unexpected
  144.                       results may also occur, if the spacing between the
  145.                       numbers is altered.
  146.  
  147.   ──────────────────────────────────────────────────────────────────────────
  148.   Colour Values:
  149.                 1 - Black                           9 - Dark Gray
  150.    Colours      2 - Blue         Colours 9-16      10 - LightBlue
  151.      1-8        3 - Green            Are           11 - LightGreen
  152.      Are        4 - Cyan           Valid for       12 - Light Cyan
  153.   Valid For     5 - Red              Only          13 - Light Red
  154.     Both        6 - Magenta        Foreground      14 - Light Magenta
  155.   Foreground    7 - Brown                          15 - Yellow
  156.      And        8 - Gray                           16 - White
  157.   Background
  158.   ──────────────────────────────────────────────────────────────────────────
  159.  Explanation:
  160.              (2)   (4)    (6)    (8)    (10)
  161. RPTCOLOUR 16, 1, 5, 1, 10, 1, 15, 1, 11, 1
  162.          (1)    (3)    (5)    (7)    (9)
  163.  
  164.  (1) is the Header colour            (7) - Colour for Names
  165.  (2) - Header background             (8) - Names Bkgrnd
  166.  (3) - Border colour                 (9) - Number of drops Colour
  167.  (4) - Border bkgrnd                (10) - Drops Background colour
  168.  (5) - Text Colour
  169.  (6) - Text Bkgrnd
  170.  
  171. The first number sets the color for the Header and Title on the reports.
  172. in the above example it's 16, which is White, and the number following
  173. the 16 is 1, which sets the background colour to black. Also worth mentioning
  174. is that the numbers 1-8 may be used as both Fore/Background colours, but the
  175. remaining 8-16 are only available for the foreground. If the RPTCOLOUR Verb is
  176. commented out, a plain ASCII SYSOP report will be generated with a RPT
  177. extension rather than an MEC.
  178.  
  179.  ───────────────────────────────────────────────────────────────────────────
  180.  The Following is Only Used For Automatic Message Creation
  181.  ───────────────────────────────────────────────────────────────────────────
  182.  If you don't want messages written, then comment out this section entirely
  183.  ───────────────────────────────────────────────────────────────────────────
  184.  
  185. ADDRESS - Your Network Address in the format ZONE:NET/NODE.POINT
  186.  
  187. MSGPATH - The path ( and BaseName ) to your Private Comments message area.
  188.           Only Squish is presently supported, because I see no reason why
  189.           any Max sysops would want to use anything else :-)  But if this is
  190.           a problem for anyone please let me know, and I'll allow *.MSG creation
  191.           as well.
  192.           Warning messages will be placed into this message base, addressed to
  193.           the user in question and from you as defined with the SYSOP verb.
  194.           ALL messages will be marked as Private.
  195.  
  196. CDCONTENT - Carrier Drops MSG content file. This is a flat text file that will
  197.             essentially become the body of the message. Full PATH and FileName
  198.             is required! Also worth mentioning is that if %N is found anywhere
  199.             in this file, the %N will be replaced with the total carrier drops
  200.             the user in the from field has accumulated.
  201.  
  202. CDTHRESHOLD <x> This is the threshold for message creation. Once a given user
  203.                 passes <x> drops, they will be issued a warning message.
  204.  
  205. TOCONTENT - This is the contents file for the Input Timeouts message. Full path
  206.             AND filename are required. As with CDCONTENT, a %N will be replaced
  207.             with the total INPUT TIMEOUTS for the user that the message is
  208.             addressed to.
  209.  
  210. TOTHRESHOLD <x> The same as CDTHRESHOLD, but for Input timeouts. Once they have
  211.                 Input timeout'd <x> times, CallDrop will start writing the user
  212.                 warning messages.
  213.  
  214. LZCONTENT - Again, this is the Path and filename to the contents file for LEECH
  215.             Z modem users. For those who don't know, Leech-Z is a protocol that
  216.             users can use to Download files from the BBS, but it sends an abort
  217.             code during the last few moments of the transfer. Normally this
  218.             will fool the BBS software into thinking the user DID NOT receive
  219.             the file and will not adjust the users Ratio/DL count. Maximus
  220.             2.01wb and greater versions are aware of this protocol, and does
  221.             it's best to report it.
  222. ──────────────────────────────────────────────────────────────────────────────
  223. ******* NOTE: Be careful with this, because sometimes a LEGITIMATE Download
  224.         will be aborted, and Maximus will report it as a possible Leech-Z
  225.         attempt. Use your discretion, if the user get's logged as having 10
  226.         consequtive leech-Z transfers, it's probably safe to assume s/he's
  227.         using it.
  228. ──────────────────────────────────────────────────────────────────────────────
  229.             As with the other content files, a %N anywhere in this file, will
  230.             be replaced with the total Leech-Z reports the user has had.
  231.  
  232. LZTHRESHOLD <x> If a user passes the value x, then CallDrop will begin sending
  233.                 out warning messages.
  234.  
  235.  
  236. That'd be it :-)
  237.  
  238. My Thanks to the Beta-Testers:
  239. ( In no particular order )
  240.  
  241.                  Chris Grainger     -  1:163/518
  242.                  Paul Venne         -  1:163/518.9
  243.                  Michael Downing    -  1:112/25
  244.                  Randy Hough        -  1:204/7
  245.                  Stephane Seguin    -  1:163/116
  246.                  Kevin Klement      -  1:134/77
  247.                  Evin Mulron        -  1:350/501
  248.  
  249. Contacting the Author
  250. ─────────────────────
  251.  
  252.            The Author may be conatacted through various electronic means,
  253.  
  254.                 Fidonet 1:163/319        BBS # (613) 837-0413
  255.                 IMEX   89:483/319
  256.  
  257.            I'm also generally available in the MUFFIN Maximus Support Echo.
  258.            Netmail is preferred, and is likely the fastest means to contact
  259.            me. If you're reporting a bug, if at all possible, please include
  260.            your CallDrop.Dat file, CallDrop.cfg and your Max.Log snippets.
  261.  
  262. Warranty
  263. ────────
  264.            THERE IS NONE. THIS SOFTWARE IS PROVIDED 'AS IS' WITH NO WARRANTY
  265.            EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE
  266.            IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  267.            PURPOSE. THE ENTIRE RISK AS TO QUALITY AND PERFORMANCE OF CALLDROP
  268.            AND THE ACCURACY OF IT'S ASSOCIATED DOCUMENTATION, LIES WITH YOU.
  269.  
  270.            IN NO WAY WILL STEVE MATHIESON BE HELD RESPONSIBLE FOR THE USE OR
  271.            MISUSE OF CALLDROP, INCLUDING BUT NOT LIMITED TO, DEFECTS, DAMAGES,
  272.            LOST MONIES, LOST DATA, OR SPECIAL, INCIDENTAL OR CONSEQUENTIAL
  273.            DAMAGES ARISING OUT OF THE USE, OR INABILTY TO USE CALLDROP.
  274.  
  275. Copyrights
  276. ──────────
  277. CallDrop is Copyright 1993 by Steve Mathieson
  278. Maximus CBCS Is Copyright By Scott J. Dudley.
  279. Squish is a trademark of Scott Dudley.
  280. BlueWave Mail is Copyright by Cutting Edge Computing.
  281. MakeMsg is Copyright by Tower Enterprises and Jeff Galbraith
  282. TheDraw is Copyright by TheSoft Programming and Ian E. Davis.
  283.