home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / HSTUFF41.ZIP / HOTSTUFF.DOC < prev    next >
Encoding:
Text File  |  1993-01-20  |  11.6 KB  |  292 lines
  1.  
  2.  
  3.                        ╔════════════════════════════╗
  4.                        ║  A MÄC's Place BBS Release ║
  5.                        ╚════════════════════════════╝
  6.  
  7.  
  8.  
  9.                      HOTSTUFF: File and Statistics Utility
  10.                      ~~~~~~~~  ~~~~ ~~~ ~~~~~~~~~~ ~~~~~~~
  11.  
  12.                                  Version  4.0
  13.  
  14.  
  15.  
  16.                           Copyright (C)1988,1989,1990
  17.                                 MÄC's Place BBS
  18.                               All Rights Reserved
  19.  
  20.  
  21.      Written By:  John McNamara                   
  22.                                      
  23.  
  24.      MÄC's Place BBS                 
  25.      Dunn, North Carolina            
  26.      (919) 891-1111 [38400 HST Dual Standard V.32 V.42      
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.      Release Date:  20 August 1990
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.     HOTSTUFF - Version 4.0                                           Page - 1
  46.  
  47.  
  48.     HOTSTUFF - A MÄC's Place BBS PCBoard Utility
  49.  
  50.  
  51. ╔═════════════════════════════════╗
  52. ║ Files included in this ZIPhive: ║
  53. ╚═════════════════════════════════╝
  54.  
  55.     HOTSTUFF.EXE     - Main HotStuff Executable File, Version 4.0.
  56.     HOTSTUFF.DOC     - Information on HotStuff PCBoard File Utility
  57.     HOTSTUFF.HIS     - Program Release History
  58.     README.NOW       - Information on Files Available with the
  59.                         HotStuff PCBoard File Utility
  60.     BUDMAN20.ZIP     - Download.txt file splitter for PCBoard
  61.     HCOMP30.ZIP      - File Parser for  DOWNLOAD.TXT file (gets
  62.                        rid of what you don't want)
  63.  
  64.  
  65. ╔══════════════╗
  66. ║ Introduction ║
  67. ╚══════════════╝
  68.  
  69.  
  70.   HOTSTUFF is a files and statistics utility programme that supports PCBoard
  71.   Versions  11.X,  12.0,  12.1,  and  14.x.  HOTSTUFF generates  a report of
  72.   popular file downloads with  various  statistics  from either the  Callers
  73.   file(s) or Download.Txt file.
  74.  
  75.   The main features of the HotStuff programme include:
  76.  
  77.           o Uses either the Callers file(s) or Download.Txt file.
  78.           o User can specify file popularity for the output report; that is,
  79.              the minimal number of file downloads to list.
  80.           o Useful statistics, including the utilization of various download
  81.          and upload protocols.
  82.           o Fast running (processes a 500 KByte Download.Txt file in less than
  83.              10 seconds on a standard AT)
  84.           o Uses either a file [eg PCBoard bulletin] or standard output for
  85.              the report.
  86.           o Automatic recognition of PCBoard version [ie 11.x through 14.x]
  87.              Callers files or Download.Txt files.
  88.       o Automatic differentiation between Callers and Download.Txt files.
  89.           o Output report format is easy to read and understand.
  90.           o ANSI color graphic version of report is available.
  91.           o Programme provides error checking so that most modified and
  92.              corrupted Callers and Download.Txt files can be processed.
  93.           o Programme is command line controlled, which makes it ideal for the
  94.              the EVENT.SYS file.
  95.           o Share and Network Compatible
  96.           o Processes multiple Callers files so that multiple node systems can
  97.              have a single report file. Handles a maximum of 35 PCBoard nodes.
  98.  
  99.  
  100.  
  101.  
  102.     HOTSTUFF Version 4.0                                             Page - 2
  103.  
  104.  
  105.   HOTSTUFF  reads  the  standard  PCBoard CALLER(S) or DOWNLOAD.TXT files and 
  106.   produces  a report  containing the following information:
  107.  
  108.           o Dates covered by the report
  109.           o Various download and upload protocols used and percent.
  110.           o Total number of download attempts, successes and percent.
  111.           o Total number of upload attempts, successes and  percent.
  112.           o Total number of unique downloads.
  113.           o Overall download to upload ratio.
  114.           o List of all files with specific download popularity.
  115.  
  116.  
  117.   HOTSTUFF/PCBHOT was written out of the need for a fast report generator  for
  118.   one of the most  important statistics of a  Bulletin Board System: the  file
  119.   activity.  The  HOTSTUFF report bulletin  provides your callers  with a good
  120.   idea of which files  are popular and worthy  of downloading.  The  SysOp can
  121.   can determine  what types  of file  his callers  prefer and  plan his system
  122.   accordingly.  HOTSTUFF is fast: it can process a 500K Callers file in  under
  123.   10 seconds on an AT class machine.   This is many times  faster  then all of
  124.   the other popular file analyzers that are available to PCBoard SysOps !!  It
  125.   is suggested that HOTSTUFF be run  as part of your daily EVENT.SYS  file and
  126.   having it automatically produce a file popularity bulletin.
  127.  
  128.   It is important to be aware of the setup of PCBoard Callers files. Each line
  129.   in the Caller file  is 64 bytes long,  with trailing spaces added  after any
  130.   text to  parse the  line to  the full  64 bytes.  The original  Callers file
  131.   should not be edited by a  standard editor. Many editors, such as  Sidekick,
  132.   drop trailing spaces on a line when saving the file. This changes the entire
  133.   Callers file and can create problems.   One needs to be careful when editing
  134.   a callers file,  making sure that the  64 byte length is retained.   A quick
  135.   guideline [but  not always  correct method]  to check  file integrity, is to
  136.   divide the total number of bytes in the edited file by 64. If the result  is
  137.   an integer [eg, a whole number], the file is probably fine. However, if  the
  138.   result is a fraction,  then the file is  probably corrupted.  One  programme
  139.   editor that is recommended is Brief  from UnderWare, Inc.  It preserves  the
  140.   original line length, plus allows editing Callers files larger than  memory.
  141.  
  142.  
  143.  
  144. ╔═════════════════════╗
  145. ║ HotStuff Operation: ║
  146. ╚═════════════════════╝
  147.  
  148.  
  149.   HOTSTUFF is easy to use with the following command line format:
  150.  
  151.  
  152.           HOTSTUFF [Inputfile] [Outputfile] [/Minimum#] [/G] [/N]
  153.  
  154.  
  155.   The Inputfile  is the  valid  DOS  drive and  path listing  for the  PCBoard
  156.   version  11.x  through  14.x  Callers  file  or Download.Txt type file.  The
  157.   HOTSTUFF programme  automatically determines  the differences  between them.
  158.   For example, D:\PCB\MAIN\CALLERS uses the file "Callers" in the  D:\PCB\MAIN
  159.   subdirectory for its input.
  160.  
  161.  
  162.  
  163.     HOTSTUFF Version 4.0                                             Page - 3
  164.  
  165.  
  166.   Outputfile is the optional valid DOS drive and path listing where the report
  167.   is to be placed.  For  example, D:\PCB\GEN\BLT12 would output the report  to
  168.   the bulletin file located  in the D:\PCB\GEN subdirectory,  creating "BLT12"
  169.   as  the  output  file.   If  the  Outputfile  is omitted, the output will be
  170.   directed to  the screen,  or if  it is  redirection, [eg.  " > "] the output
  171.   can be directed to the printer or even a file.
  172.  
  173.   Minimum# is the optional minimum number of successful downloads that a  file
  174.   must have to be included in the report.  The Minimum# MUST be preceded by  a
  175.   "/" and be placed after the Outputfile if an Outputfile is used. For example,
  176.   "/3" would include only those files that have been downloaded times or  more
  177.   in the list of popular files.  If the number is not specified the  programme
  178.   defaults to one, thus including all downloaded files in the report.
  179.  
  180.   The /G  is the  option that  specifies that  HOTSTUFF is  to produce an ANSI
  181.   color version  of the  report as  well.   If the  Outputfile is specified as
  182.   BLT12,  an  ANSI  file  named  BLT12G  will  be  created  in addition to the
  183.   standard ASCII  BLT12 file.   The file  with the  G extension  is the   ANSI
  184.   graphics  file. If  you  use  this  option,  you can automatically create  a
  185.   graphics version  of the  HOTSTUFF report  for your  callers.   This is most
  186.   useful   for   SysOps   who   run   PCBoard   versions    11.X upward  since
  187.   PCBoard automatically   reads   Bulletin   files   with   a   'G'  extension
  188.   instead of the regular Bulletin files when a caller is in the graphics mode.
  189.  
  190.   The /N is the option that allows HOTSTUFF to process multiple Callers  files.
  191.   If you specify this option you  need to give HOTSTUFF the Callers  file name
  192.   without the  node number.  For example,  if your  Caller files  are CALLER1,
  193.   CALLER2, and CALLER3, you simply give HOTSTUFF the name "CALLER" with  the /N
  194.   switch  and  all  three  files  will  be  processed.  HOTSTUFF is Share [and
  195.   Network] compatible so you  can run it while  your other nodes are  still in
  196.   operation.
  197.  
  198.   If HOTSTUFF is invoked with no parameters, an explanatory help message will
  199.   be printed to the screen, including:
  200.  
  201.       o Command line usage of the programme.
  202.       o Brief information on each of the command line options.
  203.  
  204.  
  205.  
  206.   An example of a typical HOTSTUFF command line is executed as follows:
  207.  
  208.  
  209.           HOTSTUFF C:\PCB\MAIN\DOWNLOAD.TXT C:\PCB\GEN\BLT12 /3 /G
  210.  
  211.  
  212.   The  above command  instructs  HOTSTUFF to read the  Callers  file  in the
  213.   location of C:\PCB\MAIN\DOWNLOAD.TXT, to write the output to the specified
  214.   C:\PCB\GEN\BLT12 & C:\PCB\GEN\BLT12G [including ANSI graphics output file]
  215.   with only  files downloaded three or more times being included in the list
  216.   of downloaded files.
  217.  
  218.   A typical output bulletin file produced by the above command line would be:
  219.  
  220.  
  221.  
  222.  
  223.     HOTSTUFF Version 4.0                                             Page - 4
  224.  
  225.  
  226.            Popular Files and Statistics Report
  227.        ╗  ╔ ╔══╗ ╔═╦═╗ ╔═══ ╔═╦═╗ ╦   ╦ ╔═══ ╔═══    Generated by: Version 4.0
  228.        ╠══╣ ║  ║   ║   ╚══╗   ║   ║   ║ ╠══  ╠══     Released:  20 August 1990
  229.        ╝  ╚ ╚══╝   ╩   ═══╝   ╩   ╚═══╝ ╩    ╩       A MÄC's Place Production (C)
  230.  
  231.                     Statistics from 03-12-89 to 04-04-89
  232.  
  233.                Downloads:  747 attempted, 606 successful: 81%
  234.                  Uploads:  163 attempted, 133 successful: 82%
  235.  
  236.    Download protocol: B(2.0%)  C(26.2%)  G(0.2%)  P(0.8%)  S(3.6%)  W(0.2%)
  237.                       X(3.5%)  Y(28.9%)  Z(34.7%)
  238.  
  239.    Upload protocol: B(0.8%)  C(4.5%)  G(3.8%)  J(0.8%)  X(15.0%)  Y(30.8%)
  240.                     Z(43.6%)
  241.  
  242.    Total unique files downloaded: 403    Download to upload ratio: 4.6 to 1
  243.  
  244. Files Downloaded 42 Times:
  245.    MACS.QWK       HSTUFF32.ZIP
  246.  
  247. Files Downloaded 12 Times:
  248.    MACFILE.ZIP    HOTDOG31.ZIP
  249.  
  250. Files Downloaded 9 Times:
  251.    ORIGIN11.ZIP
  252.  
  253.  
  254.  
  255. ╔══════════════════════╗
  256. ║ HotStuff Background: ║
  257. ╚══════════════════════╝
  258.  
  259.  
  260.  
  261.   The HOTSTUFF programme evolved from PCBHOT. John McNamara wrote all the 
  262.   code for HOTSTUFF.  John  can be  contacted through  MÄC's Place BBS 
  263.   or the  RIME(tm) Mail Echo. All  messages concerning  support of  
  264.   HOTSTUFF or  any other MÄC's Place BBS Production  programme doors 
  265.   and  utilities should be  left at MÄC's Pace Main conference or the RIME
  266.   ShareWare or DOORS Conference.
  267.  
  268.   The HOTSTUFF programme is  written in C and  compiled with Microsoft C  6.0.
  269.   The C language  was choosen for  writing all MÄC's Place BBS Production's
  270.   PCBoard utilities  such as  HOTSTUFF because  of its  speed and flexibility.
  271.   The MSC source is NOT available. Any SysOp interested in an enhanced version
  272.   of HOTSTUFF that  has been optimized  for 8087/80287 support  [which greatly
  273.   enhances  the  programme's  execusion  speed  by  almost  40 percent] should
  274.   contact MÄC's Place BBS at (919) 891-1111.
  275.  
  276.  
  277.  
  278.     HOTSTUFF Version 4.0                                             Page - 5
  279.  
  280.  
  281.   The latest version of the HOTSTUFF programme and other MÄC's Place BBS
  282.   utilities can be obtained from most Premier PCBoard member boards.
  283.  
  284.   If you have any questions, bugs, or suggestions for the HOTSTUFF programme,
  285.   please contact:
  286.  
  287.  
  288.      John McNamara - SysOp     
  289.      MÄC's Place BBS           
  290.      (919) 891-1111 [38400 HST DUal Standard v.32 V.42]
  291.  
  292.