home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / MAXTOP.LZH / MAXTOP.DOC < prev    next >
Text File  |  1991-01-13  |  3KB  |  70 lines
  1.  
  2.     MAXTOP  Top five upload/download users utility, Version 1.00
  3.     Copyright (C) 1991 Douglas J. Hill.   All Rights Reserved.
  4.  
  5.  
  6.     User Documentation:  OS/2 Version.
  7.  
  8.  
  9.     Part I:     What is it?
  10.  
  11.  
  12.         MaxTop v1.00 is a very small utility for use with Maximus BBS.  What
  13. MaxTop does is maintain a list of the top five uploaders and the top five
  14. downloaders on your system.  Each time a caller logs off the system, MaxTop
  15. is run and updates the list.  The caller can also view the lists while on-line
  16. (providing the Maximus menus have been altered to do so).  What's nice about
  17. MaxTop is that is is small.  It takes about about 11k of disk space including
  18. the data file it creates.
  19.  
  20.  
  21.     Part II:    Installation.
  22.  
  23.         To install MaxTop is dead easy.  First simply copy MAXTOP.EXE to
  24. somewhere in your PATH.  Next copy COMM.DLL to somewhere in your LIBPATH.  If
  25. you're running Maximus I assume you have this DLL already installed but I
  26. included it in the package mainly as it's one of the conditions on
  27. distributing the COMM.DLL package.
  28.         To complete the installation you need to edit the MAXTOP.CTL
  29. configuration file.  There are only three things in this file.
  30.  
  31. MaxTopPath      :  This describes where you want MaxTop to place its data file.
  32.                     Specify a FULL PATH including the trailing backslash.
  33.  
  34. UserBBSPath     :  This token describes where your Maximus USER.BBS file.
  35.                     Since all MaxTop does is scan this file this token has
  36.                     to be correct.  Again MaxTop is looking for a FULL PATH and
  37.                     trailing backslash.
  38.  
  39. Title:          :  This token allows you to add a bit of customization to
  40.                     MaxTop without recompiling the whole thing.
  41.  
  42.  
  43. Make your changes, save 'em and you're done.
  44.  
  45.  
  46.     Part III:   The first run.
  47.  
  48.         When you first run MaxTop you should probably do so locally to make
  49. sure things are working smoothly.  To test MaxTop simply type MAXTOP -K -S
  50. at an OS/2 command prompt.  You should see MaxTop scan your USER.BBS
  51. file and display the upload/download list.  If not, re-rear the above
  52. and see what you missed.
  53.  
  54.  
  55.     Part IV:    Adding to Maximus.
  56.  
  57.         All that remains is to modify your Maximus .CTL files to reference
  58. MaxTop.  On my system I added the following to the FILE menu in MENUS.CTL:
  59.  
  60. UsrRemote       Xtern_Run C:\MAX\MAXTOP.EXE_-S_-P%P Normal "Top UL/DLers"
  61. UsrLocal        Xtern_Run C:\MAX\MAXTOP.EXE_-S_-K   Normal "Top UL/DLers"
  62.  
  63.  
  64. Don't forget to change your BBS .CMD files to run MAXTOP after each caller
  65. logs off the system or else the lists will never be updated.
  66.  
  67.  
  68.  
  69.  
  70.