home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / MAXIMUS / MXAUT1B.ZIP / MXAUTEUR.DOC < prev    next >
Text File  |  1994-02-25  |  10KB  |  211 lines
  1.      +-----------------------------------------------------------------+
  2.      |                 MaxAuteur v.001b (beta)                         |
  3.      |               by Fais Nasir @ o1:25o/718                        |
  4.      +-----------------------------------------------------------------+
  5.      |    Copyright 1994 by Independent Ick!  All Rights Reserved.     |
  6.      +-----------------------------------------------------------------+
  7.  
  8.    Welcome to "MaxAuteur"!
  9.  
  10.    This programme is my solution to the non-existent market of message-
  11.    writer's utilties!  When I put my BBS back online in April of '93, I
  12.    had requested in various echos for someone to forward me a programme
  13.    that compiled a "Top 10" or "Best User's" listing etc. etc.  The
  14.    sysops were great and sent me various programmes which would show
  15.    you who the top callers were, the best uploaders, the most notorious
  16.    leeches etc. etc., but not one (not a one!) would make a listing of
  17.    the top message-writers.  Being the sysop of a conversations-only 
  18.    system, I was rather appalled to find that this was the case.  It 
  19.    wasn't the programmers' fault, it was Maximus-- Max doesn't keep
  20.    a track of how many messages a user writes like it does the other
  21.    statistics.  Bummer...!
  22.  
  23.    In comes "MaxAuteur".  MaxAuteur will read your Maximus logfile and
  24.    check it for messages-written by the various users on your system.
  25.    It also supports messages written by an alias, so no matter where
  26.    when or how the user writes, he or she are caught on record!
  27.  
  28.    Great, so I wrote a programme to do this, but <ack>!!!  When I 
  29.    executed the programme, I didn't see the people that I *knew*
  30.    wrote tonnes of mail!  Where were they?  The answer was obvious--
  31.    they were using the offline mail-reader!
  32.  
  33.    Here's a quick run-down of what MaxAuteur will do:
  34.  
  35.     - Reads the Maximus log for messages left via a real name *or*
  36.       an alias.
  37.  
  38.     - Reads the BlueWave log file for messages left by a user.
  39.  
  40.     - Allows the exclusion of up to five users you don't want MaxAuteur
  41.       to recognise (making you one of them is recommended).
  42.  
  43.     - Sorts the users and ranks them in a best to worst fashion.
  44.  
  45.     - Writes the acquired data to a MaxAuteur data-file (viewable).
  46.  
  47.     - Creates an .Mec file all ready for compile by Max's "MECCA" utility.
  48.  
  49.    There are two reasons you may want to use MaxAuteur.  One would be that
  50.    you simply want to keep a track of who writes how much mail (via the
  51.    "MxAuteur.Dat" file) or you want a displayable top-ten listing of those
  52.    that actually write on your board.
  53.  
  54.    -------------------------------------
  55.    (1). Alright...  The Intro is Over...
  56.    -------------------------------------
  57.    As you probably haven't guessed by now, this is a utility to help
  58.    you, a Maximus sysop, keep a track of the message-writer's on your
  59.    system, and of those who are not leaving any mail whatsoever
  60.    ('cause they're probably playing some game or leeching a file some-
  61.    where)...
  62.  
  63.    I am not going to go into vast details on how to use this programme
  64.    since it is relatively easy to understand <blah>, <blah> <blah>, and
  65.    after dedicating over fifteen-hundred lines of code on something like
  66.    this, writing a doc file is the least of my concerns!  I admit, I 
  67.    may have gotten a bit fancy in areas where it wasn't necessary, but
  68.    hey-- like a gun or a knife, if you `draw' your C-compiler, then you's
  69.    jes' gots t'a use it!
  70.  
  71.    ------------------------------------------------------------
  72.    (2). Executing MaxAuteur and its Control File (Respectively)   
  73.    ------------------------------------------------------------
  74.    After unarchiving it into a directory of its own, you can execute it
  75.    by typing "mxauteur <filename.ctl>".  The control filename is entirely
  76.    up to you and is *not* optional.  You may use the control file that
  77.    came with this archive and edit it to reflect your own system.  Any
  78.    line beginning with a `;' (semi-colon) or a space will be ignored
  79.    by MxAuteur during runtime.
  80.  
  81.    -------------------------------------------------
  82.    (3). REQUIRED Keywords in the MaxAuteur .CTL file
  83.    -------------------------------------------------
  84.  
  85.    Sysop <sysopname>      -  Your name, e.g. "Sysop Fais Nasir".
  86.  
  87.    System <system name>   -  Your system's name
  88.                              (e.g. "System My Kuel Doodz BBS").
  89.  
  90.    MaxAuteur [<d:><path>] -  The full path to your MaxAuteur directory
  91.                              (e.g. "MaxAuteur c:\misc\mxauteur). Trailing
  92.                              backslashes are optional.
  93.  
  94.    MaxLog [<d:><path><filename>]  -  The full path and name to your Maximus
  95.                                      log file.  Don't forget to specify the
  96.                                      the name (e.g. "MaxLog C:\Max\Max.log").
  97.  
  98.    BwLog [<d:><path><filename>]   -  The full path and name of your BlueWave
  99.                                      logfile.  If you do not use the BlueWave
  100.                                      offline mail-reader, put "None" in the
  101.                                      place of the path (e.g. "BwLog None").
  102.  
  103.    MeccaFile [<d:><path><filename>]  -  The full path and name to the MECCA
  104.                                         file you would like MaxAuteur to
  105.                                         create for you.
  106.                                         (e.g. "MeccaFile C:\Max\Top10.mec")
  107.  
  108.    -------------------------------------------------
  109.    (4). Optional Keywords in the MaxAuteur .CTL file
  110.    -------------------------------------------------
  111.    In addition to the above keywords, you may also include up to five
  112.    occurrences of the "Exclude" keyword.  You follow "Exclude" with the
  113.    name of a person on your BBS that you want MaxAuteur to ignore when
  114.    compiling the best message writer's listing.  You would probably want
  115.    to exclude yourself since otherwise you would more than likely always
  116.    be in the number one position all of the time (who writes more messages 
  117.    than the sysop???).  You may also want to exclude your 'co or assistant
  118.    sysop for the same reason.
  119.  
  120.    If you would like more information on the control file, please refer to
  121.    the file "MxAuteur.ctl" that was included in this archive.  I recommend
  122.    that you simply edit that file and use it since it would be much easier
  123.    that way.
  124.  
  125.    -----------------------------------------------------------
  126.    (5). Something that you MUST do BEFORE running MaxAuteur...
  127.    -----------------------------------------------------------
  128.    Simply put, you must set your "Log Mode" to "Verbose" in "Max.ctl".
  129.    Don't forget to "silt your Max" after doing this.  If you don't do 
  130.    this, MaxAuteur will NOT work for you.
  131.  
  132.    -----------------------------------------------------------
  133.    (5-a). Something that you MUST do AFTER running MaxAuteur...
  134.    -----------------------------------------------------------
  135.    You must either rename, copy, or move your Max.log and Bw.log to a
  136.    temporary directory or file.  If you don't do this, then the next time
  137.    you run MaxAuteur, it will read the names again!  I run MaxAuteur 
  138.    every night within my maintenance routines.  After it runs, I have
  139.    the following lines in my batch file:
  140.  
  141.      c:
  142.      cd\max
  143.      rename master.log temp.log
  144.      copy temp.log + max.log master.log
  145.      delete max.log
  146.  
  147.      cd\bluewave
  148.      rename masterbw.log temp.log
  149.      copy temp.log + bw.log masterbw.log
  150.      delete bw.log
  151.  
  152.  
  153.    The above lines will append the *current* log file for Maximus and
  154.    BlueWave to the "master" file (you can decide upon the name).  Every-
  155.    thing else in the above is pretty much self-explanatory.
  156.  
  157.    Remember: If you aren't using BlueWave, be sure to set the "BwLog" 
  158.              option to "None" (minus the quotes, of course).
  159.  
  160.    If you don't understand the above lines, go buy a DOS manual...
  161.  
  162.  
  163.    ----------------------------------------------------
  164.    (6). <BlaH>, <BlaH>, and just a bit more'o <BlaH>...
  165.    ----------------------------------------------------
  166.    This programme is about many days of non-sleeping, googly-eyed work.
  167.    As it stands, this programme will only print out the top ten on your
  168.    board, and will only give you a data file for a maximum of two-hundred
  169.    users.  It will still work if more than two-hundred people write on
  170.    your system and compile the best writers in a bulletin for you, but
  171.    it won't make a sysop report to you on those past two-hundred.
  172.  
  173.    MaxAuteur represents a lot of work on my part and I am releasing this
  174.    version into the shareware market.  If you find this programme of use,
  175.    please consider "registering" it.  Registration costs only ten bucks, 
  176.    and in return, I will send you a version that will allow you to configure
  177.    as large a bulletin as you like, and up to a thousand-user report.
  178.  
  179.        Please send your registration fund to:
  180.  
  181.        Fais Nasir c/o [ATRIBBS]
  182.        52 Princess Street
  183.        Toronto, Ontario
  184.        CANADA!
  185.        M5A 4G6
  186.  
  187.    Please keep the SHAREWARE concept alive folks, and register this
  188.    piece of software!
  189.  
  190.    Even if you can't register, I would still be interested on knowing your
  191.    thoughts on MaxAuteur.  If you would like to see other features etc. etc.,
  192.    please feel free to drop me a line at the above address, or better yet,
  193.    netmail me at my Fido address (1:250/718).
  194.  
  195.    Often a programmer writes something and doesn't know how well it is 
  196.    received by the public (especially for BBS utilities).  Don't leave me
  197.    in the dark, people!  Tell me what you think!
  198.  
  199.    -------------
  200.    7. That's It!
  201.    -------------
  202.    Anyway, that's about it.  If you find any bugs, please let me know.  If
  203.    this dang thang' breaks, please remember, you own both halves, but I will
  204.    try to make it more "sturdy" the next time around <g>.
  205.  
  206.    Peace out.
  207.  
  208.  
  209.    -- Fais Nasir
  210.       [ATRIBBS]
  211.       1:250/718