home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / T10DL16.ZIP / TOP10DL.DOC < prev    next >
Text File  |  1994-09-25  |  6KB  |  157 lines
  1.  
  2.                   Top 10 Downloads Report Program v1.6
  3.  
  4.                   by Aldur:  1@3314 WWIVnet
  5.                              1@3314 IceNET
  6.                              1@3314 FUNnet
  7.                              1@13301 WWIVLink
  8.  
  9. I.  Quick Setup
  10.  
  11.     You may put TOP10DL.EXE anywhere that you like - it is required
  12.     that you pass the program the full path and name to your
  13.     CHAIN.xxx file:
  14.  
  15.         EX1:  TOP10DL.EXE %1    (from chains)
  16.  
  17.                 or
  18.  
  19.         EX2:  TOP10DL.EXE C:\WWIV\CHAIN.TXT  (from external event)
  20.  
  21.     The program will assemble a report file called TOP10DL.MSG in
  22.     your GFiles directory indicated in your CHAIN.TXT file.
  23.  
  24. II.  Additional Program Parameters
  25.  
  26.     A.   There are four additional commandline parameters that may be
  27.          given:
  28.  
  29.          1.  /MONO
  30.  
  31.             EX:  TOP10DL.EXE %1 /MONO
  32.  
  33.             This will build a report without the WWIV color codes -
  34.             try it both ways and see what you think.
  35.  
  36.          2.  /G<dirname>
  37.  
  38.             EX:  TOP10DL.EXE %1 /GTRANSFER
  39.  
  40.             The parameter (/G) will append the subdirectory that
  41.             follows the /G parameter to the output report location.
  42.             i.e. if your GFiles directory is: C:\WWIV\GFILES then
  43.             the report with the /G parameter above will actually
  44.             be created in the C:\WWIV\GFILES\TRANSFER directory.
  45.             This way, if you are using the report(s) as a GFile,
  46.             then you can create it where the board will find it
  47.             for your transfer GFiles.
  48.  
  49.          3.  /T<number>
  50.  
  51.             EX:  TOP10DL.EXE %1 /GTRANSFER /T15
  52.  
  53.             The '/T' parameter will cause Top10 to create report(s)
  54.             for the Top xx number of files.  This number may be from
  55.             5 to 25.  In the example above - you would get the Top 15
  56.             Downloads from your file section.  If this parameter is
  57.             not given at the commandline, the default is 10.  If you
  58.             specify a number lower than 5 or higher than 25 - it will
  59.             revert to the default value of 10.  The report title will
  60.             change to match the number you give here.
  61.  
  62.          4.  /ALL
  63.  
  64.             EX:  TOP10DL.EXE %1 /GTRANSFER /T10 /ALL
  65.  
  66.             This particular parameter will cause Top10 to generate a
  67.             Top 10 Report (see item 3) in the GFILES\TRANSFER directory
  68.             for each directory in your file section.  The naming
  69.             convention used here is the same as your file directories
  70.             in //diredit:
  71.  
  72.             EX:  TDL_10.MSG
  73.  
  74.             In this example - it would be the Top 10 Downloads Report
  75.             for your directory number 10.  Top10 will handle up to
  76.             and including the 999 file directories available in WWIV
  77.             v4.23+.
  78.  
  79.          5. /X
  80.  
  81.             The /X parameter disables the SysOpLog feature so that Top
  82.             10 will not make an entry in your SysOpLog when the program
  83.             operates.
  84.  
  85.     B.  Configuration File (TOP10DL.CFG)
  86.  
  87.         You may want to configure Top10 to only generate reports on some
  88.         of your file directories rather than all of them (the default).
  89.         If so, you will need to put TOP10DL.EXE and your configuration
  90.         file, TOP10DL.CFG, in the same directory and change to that
  91.         directory to call the program.  Top 10 will find the configuration
  92.         file and only report on the directories listed in the TOP10DL.CFG
  93.         file.
  94.  
  95.         To make the TOP10DL.CFG file use any standard ASCII editor.  List
  96.         the directory names (from //diredit), one per line, that you want
  97.         Top10 to check:
  98.  
  99.         EX:            UBSYSOP
  100.                        GAMES
  101.                        EIDTORS
  102.                        GIF
  103.  
  104.         All of the entries must have a cooresponding .DIR file in your
  105.         DATA directory.  Top10 will verify this information BEFORE it
  106.         generates any reports.  Do NOT append the .DIR extension here
  107.         as Top10 will do that for you.  If you have directories listed
  108.         here that are not actually in existance - Top10 will figure
  109.         that out and continue as though the line did not exist. If you
  110.         do not have any valid directory names here - Top10 will default
  111.         to producing a report for all directories.
  112.  
  113.         NOTE:  When you use a configuration file - the Top 10 Downloads
  114.         report will only be a summary of the Top 10 files downloaded
  115.         from the list of directories contained in the configuration file.
  116.  
  117.         All the preceeding parameters are in effect for any directories
  118.         listed in the configuration file:  if you specify /MONO - the
  119.         report(s) will not contain WWIV color codes.  If you specify
  120.         /T15 - the report(s) will be for the Top 15.  If you give the
  121.         /ALL parameter - Top10 will give you a Top 10 report for each
  122.         valid directory listed and a summary report for the Top 10 files
  123.         downloaded from only the directories listed in the configuration
  124.         file.
  125.  
  126. II.  WWIV Interaction
  127.  
  128.     TOP10DL reads CHAIN.TXT to locate your DATA directory and GFiles
  129.     directory.  It needs the DATA directory for all your *.DIR files
  130.     and the GFiles directory for the output report location.
  131.  
  132.     The program will also append to INST-001.LOG (or above) for WWIV
  133.     v4.23+ systems or to the standard SYSOPLOG that earlier versions
  134.     use.  (This program is WWIV v4.23 aware and will handle CHAIN.002,
  135.     CHAIN.003, CHAIN.004, etc. as well as CHAIN.TXT from earlier
  136.     versions.)
  137.  
  138.     If TOP10DL.EXE encounters a problem - it will be reported to your
  139.     SysOpLog as will a normal program completion.
  140.  
  141.     It is fairly fast and (hopefully) effective - I do hope that you
  142.     enjoy it!!
  143.  
  144.     Recommendations:
  145.  
  146.       I run my version in my external event file (EXTERN.BAT) so that
  147.       the statistics are updated daily.
  148.  
  149. III.  Freeware
  150.  
  151.     It didn't take enough time to develop to release this as Shareware
  152.     so its out on the market as freeware at this point.  If you have
  153.     any recommendation or comments - please send the mail as I would
  154.     appreciate hearing from you!!
  155.  
  156.                                       Aldur
  157.