home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DEMO510.ZIP / TOPTEN3.INS / TOPTEN.DOC next >
Text File  |  1999-01-25  |  3KB  |  91 lines
  1.  
  2. TOPTEN                                                   May 1994
  3. Searchlight BBS Top Ten User Program
  4.  
  5. Update: 5/94
  6.   Recompilation for Searchlight 4.0. No functional changes.
  7.  
  8. Update: 3/6/93
  9.   Recompilation for Searchlight 3.0. No functional changes.
  10.  
  11. Update: 4/1/1991
  12.   Update for SLBBS 2.0 -- Does not work with earlier versions
  13.  
  14. Description
  15.   TOPTEN is a program which will compute and print "Top-10" user 
  16. listings for bulletin boards using the Searchlight BBS software.  It 
  17. will produce listings by one of three criteria- number of calls, 
  18. amount of uploads, or amount of downloads- and you may specify the 
  19. number of users you want listed (ten is the default, but the entire 
  20. user list can be printed if desired).
  21.   TOPTEN writes the listing to standard output, and you may redirect 
  22. it to a text file if desired.  This program is suitable for use with 
  23. the SLBBS Doors system.
  24.  
  25.  
  26. Useage
  27.   The syntax for running TOPTEN is as follows:
  28.  
  29.   TOPTEN [CUD][n] [a] [/w] [/p<path>]
  30.  
  31.   where: [CUD] is one of
  32.     C: computes top caller listing
  33.     U: computes top uploaders
  34.     D: computes top downloaders
  35.   You can only specify one list at a time.
  36.   The default, if no option is specified, is C.
  37.  
  38.   [n] is the number of positions you desire in the list.
  39.       If missing, it defaults to 10.
  40.       A value of 0 indicates that ALL users are to be listed.
  41.  
  42.   [a] is the maximum access level to list.
  43.       If given, only those users with access levels less than or 
  44.       equal to this number are listed.
  45.       This parameter is useful for leaving the SYSOP out of a top
  46.       ten user listing.
  47.  
  48.  [/w] if specified, the "wait" parameter causes the program to wait
  49.       after displaying the Top-10 listing until a key is pressed.
  50.       This parameter may appear anywhere on the command line.
  51.  
  52.  [/p] allows you to specify the name of the directory containing the
  53.       CONFIG.BBS file, if other than the current directory. Do not
  54.       type a trailing backslash (ie. type 'C:\BBS' not 'C:\BBS\').
  55.  
  56.  
  57. Here are some examples:
  58.  
  59.   TOPTEN
  60.   prints a listing of the top ten callers;
  61.  
  62.   TOPTEN C20
  63.   gives a listing of the top 20 callers;
  64.  
  65.   TOPTEN U15 240
  66.   prints top 15 uploaders, excluding users with access level
  67.   greater than 240;
  68.  
  69.   TOPTEN D0 /W /PC:\BBS1
  70.   lists the entire user file sorted in order of most to least
  71.   amount of downloads. The program will wait until a key is
  72.   pressed before continuing. The CONFIG.BBS file is in directory
  73.   C:\BBS1.
  74.  
  75.  
  76. You can use the I/O redirection feature of DOS to have the listing 
  77. sent to a text file rather than to the screen.  Simply append the 
  78. right-bracket followed by a filename to the end of the command line.
  79. For example,
  80.  
  81.   TOPTEN U15 100 >TOPUL.TXT
  82.  
  83. will produce the indicated Top listing and write it to the file 
  84. TOPUL.TXT.  A filename of PRN will cause the listing to go to the 
  85. printer. Don't use the "/W" option when redirecting output.
  86.  
  87.  
  88.                                                           12/03/87
  89.  -----------------------------------------------------------------
  90. 
  91.