home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / TOP10-43.ZIP / TOP10.DOC < prev    next >
Text File  |  1994-04-11  |  8KB  |  190 lines
  1.  Top Ten Posters - Version 4.3 (4/11/94) - by Robert Kish, aka Number One
  2.  ------------------------------------------------------------------------
  3.  Original documentation by Number One, edited by Cecil The Snake.
  4.  
  5.  For WWIV versions 4.22 and 4.23.
  6.  
  7.  Note:  This program might not work on some modded versions of WWIV if the
  8. software has modified STATUS.DAT and USER.LST files. This program should
  9. work perfectly with version 4.23. There may be small inaccuracies when this
  10. program is run under WWIV 4.22.
  11.  
  12.  Requirements:  This program requires WWIV, so therefore, it is a DOS program. 
  13. This program requires an undisclosed amount of RAM, very little hard drive 
  14. space, and a half decent processor. This program has been tested under MS-DOS 
  15. 6.2 and Windows 3.1.
  16.  
  17.  Disclaimer:  I am not responsible for damages incurred from running or using
  18. this program. Anything that happens is entirely your fault.
  19.  
  20.  Switches:
  21.  
  22.     D    Deletes the data file from the last user online. This is important
  23.           to do when running the program as a different user (i.e., a caller
  24.           logs on to the system). This switch is necesarry when Top Ten Posters
  25.           is run as a Logon Event.
  26.           
  27.     Q    This switch *MUST* be used if the Top Ten Posters is only going to be
  28.           run as a door and NOT as a logon event. This will make the data file
  29.           needed to run Top Ten as only a door, and then end the program without
  30.           printing the data at logon. This is used for those SysOps who don't
  31.           want the Top Ten List printed at logon.
  32.     
  33.     R    Reverse sort order. This is for making the program display the
  34.           opposite of the Top Posters, the Worst Posters.
  35.  
  36.   =n=   Where 'n' is a user number. This tells how far to go on the list. If
  37.           the switch is not used, then the default value will be 10. Changing
  38.           this value to 1 will result in displaying only the top poster, or if
  39.           the "R" switch is used at the same time, the worst poster. i.e.,
  40.           setting the switch =5= will display the top 5 posters of the BBS.
  41.  
  42.   !n!   Mainly a debugging switch, this will run Top Ten Posters without the
  43.           need of a CHAIN.TXT. 'n' is the user number to run the program as.
  44.           So, if you use !2! on the command line, then you are running the
  45.           program from the point of view of User #2. This is used to see if the
  46.           displaying options as in TOP10.INI are working properly.
  47.  
  48.     C    This is used with the !n! switch. Without this switch ANSI colors
  49.           will be used when the !n! switch is used. Using this switch will shut
  50.           off ANSI colors in the display when the !n! switch is used. This is
  51.           here just in case the SysOp wants to test something and does not want
  52.           ANSI.
  53.  
  54.     +    This switch adds a call to the user running the program. It is used
  55.           in order to adjust the user's calls as some software updates the
  56.           user's calls to USER.LST at different times.
  57.  
  58.     -    This switch takes away a call to the user running the program.
  59.     
  60.     ?    This switch turns on the User Interrogation Mode where the user
  61.           can either view a scrolling list (in REGISTERED VERSIONS ONLY) or 
  62.           define his/her own parameters for a normal list. It also makes the 
  63.           Top Ten list abortable with the space bar.
  64.  
  65.         Note: Using this switch as a log on event can increase the chances of
  66.                 the BBS hanging if a user decides to hang up in the middle of the
  67.                 program. This problem is eliminated when the program is run as a
  68.                 door.
  69.     
  70.     K    Enabling this switch will enable the use of SysOp definable colors,
  71.           in REGISTERED VERSIONS ONLY.
  72.  
  73.  Setup:
  74.  
  75.   Logon Event:
  76.  
  77.     The basic setup is to put the command line 'TOP10.EXE D' in the Logon Event
  78. slot of INIT.EXE or your Logon batch file. The D is needed to delete
  79. information used from the last user. Without the D parameter, the top ten
  80. lists will become very inaccurate (i.e., negative values for calls). If you
  81. are not going to run Top Ten Posters as a Logon Event, then you must run
  82. 'TOP10.EXE Q' in your logon in order to make the required data file needed
  83. incase Top Ten Posters will be run as a door. (See the information included
  84. with the 'Q' switch.) So no matter what you do, you must have a Top Ten
  85. Posters command line in your Logon Event.
  86.     
  87.  Online Program (Door):
  88.  
  89.     Place 'TOP10.EXE' (and any desired switches - no "D" switch as that will
  90. cause problems with the data files) as the command line in CHAINEDIT. Make
  91. sure in that you have 'DOS Interrupt' set to NOT USED. If the DOS interrupt is
  92. used, then the program will not work over the modem. (The SysOp will still see
  93. the program though, but the user would not be able to see or do anything).
  94. Also, make sure that PAUSES are set to OFF.
  95.  
  96.     If you are registered and wish to turn on the User Interrogation Mode, then
  97. place the command line of 'TOP10.EXE ?' in CHAINEDIT.
  98.  
  99.     Top Ten is currently Multi-Instance aware up to two instances. If there 
  100. is a need for more instance support, then please contact me. The Multi-node 
  101. setting can be set to YES in WWIV version 4.23.
  102.  
  103.  Program Examples:
  104.  
  105.     To use the program as a Top 100 posters:
  106.  
  107.     TOP10.EXE =100=
  108.  
  109.     To do the same but in reverse order:
  110.  
  111.     TOP10.EXE =100=r. 
  112.  
  113.     The switches are not case-sensitive so you may use either upper or lower
  114. case and the spacing does not matter either. 'TOP10.EXE r' and 'TOP10.EXE R'
  115. do the exact same thing, as well as 'TOP10.EXE r=2=' and 'TOP10.EXE =2=R.'
  116.  
  117.  TOP10.INI:
  118.  
  119.     This file is required to run the program. Running the program for the first
  120. time, without a TOP10.INI file, will result in the creation of a default file.
  121. This is the file you may want to change to make sure it has the information
  122. specific for your needs. Note that all the lines in the file are necessary.
  123. Do NOT move the lines around in the file. Doing this will result in major
  124. problems.
  125.     
  126.     To configure the TOP10.INI file, make the appropriate changes using any
  127. text editor.
  128.  
  129.     Here is my TOP10.INI file:
  130.  
  131.  1 :      c:\wwiv\data\user.lst
  132.  2 :      c:\wwiv\data\status.dat
  133.  3 :      c:\wwiv\
  134.  4 :      Crewmember
  135.  5 :      255
  136.  6 :      0.28
  137.  7 :      3
  138.  8 :      4
  139.  
  140.  
  141.     Line 1 :  Path to your USER.LST file. 
  142.     
  143.     Line 2 :  Path to your STATUS.DAT file.
  144.  
  145.     Line 3 : Path to your main WWIV directory where CHAIN.TXT (or .002) 
  146.                 will be found.
  147.     
  148.     Line 4 : What you would like to call people who use your system. Most
  149.                 people choose "Users." On my system I call them "Crewmembers."
  150.     
  151.     Line 5 : The SL limit, but not including, which shows up in the list.
  152.                 For example, if the value of 100 is on that line, then all
  153.                 users with an SL greater than or equal to 100 will NOT be shown
  154.                 on the Top Ten list.
  155.     
  156.     Line 6 : The last line is the Post Per Call value which will result in a
  157.                 change in color if the ratio is or falls below this value. A value
  158.                 of 0.010 for that line would mean that all those with a Post Per
  159.                 Call ratio less than or equal to 0.010, would have their post per 
  160.                 call ratio in a different color (assuming ANSI was on). Check 
  161.                 your INIT.EXE to find what you have your PPC Ratio set to.
  162.  
  163.     Line 7 : This is the IRQ value for the modem used in the first instance.
  164.                 The default settings for COM1 and COM3 are IRQ4, so a value of 4
  165.                 would be placed on that line if COM1 (or COM3) were was used
  166.                 for the main line of the BBS. The default for COM2 and COM4 is 
  167.                 IRQ3.
  168.  
  169.     Line 8 : The IRQ value for the second instance (assuming WWIV 4.23). See
  170.                 above. A value must be present even though a second instance may
  171.                 not be present.
  172.  
  173.  TOP10ANS.INI:
  174.     
  175.     This file configures the colors for registered SysOps only. It is looked
  176. for when the "K" switch is used. If the file does not exist then the default 
  177. colors will be used. The colors are in the file one color per line and remarks 
  178. are permitted after the colors. For more information read the comments in 
  179. TOP10ANS.INI.
  180.  
  181. ----
  182.  
  183.      If you would like to register this program (which I strongly urge you to
  184. do!), please follow the directions in the REGISTER.NOW file, which is included
  185. with the Top Ten package.
  186.  
  187.      And that's all there is. If you have ANY questions, bug reports, comments,
  188. new ideas to add, or anything, then E-MAIL me (NUMBER ONE) on my board, Ten 
  189. Forward (1-609-443-5814).
  190.