home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 004 / lstat220.zip / LSTAT.DOC < prev    next >
Text File  |  1994-10-02  |  6KB  |  151 lines
  1. Lstat v2.20 (c) Larry Hannah, 1990-94
  2.  
  3.     A statistics program for Maximus systems. This program is a FREE program,
  4.     not be sold at any time.
  5.  
  6. >>> Revision Note:
  7.     Lstat 2.20 changed variable sizes in mstruct.h to match between
  8.         memory models.
  9.     Lstat 2.18 revised widths on some columns for larger amounts
  10.     Lstat 2.16 changed order of some items on page 2.
  11.     Lstat 2.14 revised some code due to compiler change.
  12.     Lstat 2.12 revised to show uploads/downloads in K (1024) when
  13.         amount is over 100,000 Kb.
  14.     Lstat 2.10 revised to allow an unlimited number of users.
  15.     Lstat 2.08 revised to show uploads/downloads in K (1024) instead
  16.         of Kb.
  17.     Lstat 2.06 revised to user to control which graphs print.
  18.     Lstat 2.04 revised to use user-defined characters for graphs.
  19.     Lstat 2.02 revised to increase the number of users from 1,000
  20.         to 1,400.
  21.     Lstat 2.00 revised to handle large up/download amounts used
  22.         in Maximus version 2.0, without sacrificing the use with
  23.         previous versions of Max.
  24.     Lstat 1.94 fixes an annoying problem of not being able to
  25.         put slashes (/) in UserName1 or UserName2.
  26.  
  27.  
  28. >>> Syntax:
  29.  
  30.     Lstat [cfgfile]
  31.  
  32.     [cfgfile] is an optional filename that Lstat will try and use
  33.         for getting its configuration information.  Lstat will
  34.         default to "Lstat.cfg".
  35.  
  36.  
  37. >>> Requirements:
  38.  
  39.     Lstat uses the USER.BBS file for its information and must be
  40.         run when logged on to the directory that contains USER.BBS.
  41.         It also uses the BBSTAT??.BBS files to get total information.
  42.  
  43.     Lstat will look for the configuration file in the current
  44.         directory, but requires useage of Dos 3.x or higher so it can
  45.         find its configuration file if it is kept with the EXE.
  46.  
  47. >>> Outputs:
  48.  
  49.     Lstat will output two files: Lstat.BBS and Lstat.TXT. Lstat.BBS has
  50.         all the Meccafile information for colors, etc.  Lstat.TXT is a
  51.         plain ASCII text file.  See below for information on optional
  52.         files that can be output.
  53.  
  54. >>> Configuration:
  55.  
  56.     An optional configuration file (Lstat.CFG) can be used to
  57.         control colors and the "nextfile" that Opus/Maximus displays.
  58.         The format for this file is as follows:
  59.  
  60.         [in any order, only include lines that you wish to change,
  61.          case insensitive]
  62.  
  63.         OnExit = nextfile
  64.         Heading = White / Black
  65.         Border = Yellow / Gray
  66.         Name = White / Red
  67.         Num = Yellow / Red Blink
  68.         line1 = black/magenta
  69.         line2 = white / green
  70.         Omit = John Smith
  71.         Omit = Pam Brown
  72.         Graph = On
  73.         UserName1=My BBS
  74.         UserName2=  A stupendous Board
  75.         GraphChar1 = X
  76.         GraphChar2 = ▄
  77.         GraphChar3 = ▒
  78.         CallGraph = [ ON | TRUE | YES | 1 ] | [ OFF | FALSE | NO | 0 ]
  79.         UpldGraph = [ ON | TRUE | YES | 1 ] | [ OFF | FALSE | NO | 0 ]
  80.         DnldGraph = [ ON | TRUE | YES | 1 ] | [ OFF | FALSE | NO | 0 ]
  81.  
  82.         [colors must follow the order foreground / background <blink> ]
  83.  
  84.     Colors that can be used are:
  85.         foreground:                     background:
  86.         Black                           Black
  87.         Blue                            Blue
  88.         Green                           Green
  89.         Cyan                            Cyan
  90.         Red                             Red
  91.         Magenta                         Magenta
  92.         Brown                           Brown
  93.         Gray                            Gray
  94.         DarkGray
  95.         LightBlue
  96.         LightGreen
  97.         LightCyan
  98.         LightRed
  99.         LightMagenta
  100.         Yellow
  101.         White
  102.  
  103.     OMIT is for people that you don't wish shown as being top
  104.         uploader/ downloaders. Their figures are still included
  105.         in the totals. You can have up to 6 names in the
  106.         configuration file, any more will just be ignored.
  107.  
  108.     GRAPH will produce a graphical representation of up to two
  109.         weeks of data. To use this effectively, you must run
  110.         Lstat every day. The first day that you use graph, a
  111.         graph will NOT be generated; only the information will be
  112.         added to Lstat.nfo. On the second day and thereafter, a
  113.         graph will be generated. Running Lstat a second (or more)
  114.         time will not change the graph information or write to
  115.         the NFO file until the next day. All graphs are self
  116.         scaling.
  117.  
  118.     GRAPHOUT is an option that will output the graph information
  119.         to the file named after the '=' sign.  This will allow
  120.         you to run the graph portion once a day, and Lstat as
  121.         many times as you would like throughout the rest of the
  122.         day.  This will usually be accomplished by keeping two
  123.         configuration files, one for once a day, the other for
  124.         the rest of the day.  Using this format, you can even
  125.         change the colours between the statistic and the graph
  126.         portions.
  127.  
  128.     USERNAME1 and USERNAME2 are to allow the users to put their
  129.         name in the stats.  Restricted to a length of 29
  130.         characters.
  131.  
  132.     GRAPHCHAR? is used to vary the character that is used in the
  133.         graphs for each of the graphs. 1 = CALLS, 2 = UPLOADS,
  134.         3 = DOWNLOADS.
  135.  
  136.     CALLGRAPH, UPLDGRAPH, DNLDGRAPH allows you to exclude any or all
  137.         of the graphs from output. Default is ON.
  138.  
  139. >>> If you like the program, or have suggestions:
  140.  
  141.     Send a note to Larry Hannah @ 1:134/17.1
  142.  
  143. >>> Please Note:
  144.         Tim Bellaart (1:134/17) has been kind enough to have
  145.         the latest version LSTAT available for File Request
  146.         under the magic name "LSTAT".
  147.  
  148.         Special thanks to Scott J. Dudley for making available the
  149.         data structures used in Maximus-CBCS.
  150.  
  151.