home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / mailers / imlfa10.zip / IMLFA10.DOC < prev    next >
Text File  |  1993-03-23  |  13KB  |  282 lines
  1.                              
  2.                              
  3.                              
  4.                                 -= IMLFA =-
  5.  
  6.                     InterMail Log file Analyzer/Reporter
  7.  
  8.                              Copyright(c) 1993
  9.                  Gordon E. Rasnick,  Arctic Computer Services
  10.                              2530 Sebring Circle
  11.                             Anchorage, AK  99516
  12.                             All rights reserved.
  13.  
  14.                             FIDONET (1:355/559)
  15.                           CompuServe ID: 72007,417
  16.                             *******************
  17.  
  18.            InterMail is Copyright 1988-1993 Scandinavian PC Systems AB 
  19.                          & InterZone Software, Inc.
  20.                             All rights reserved.
  21.                             *******************
  22.  
  23.                   
  24.      IMLFA is a complete log file analyzer/reporter for version 2.21 of 
  25.      the InterMail email package.  IMLFA has only been tested with this
  26.      release, but may work with previous versions.  No testing was done
  27.      with earlier versions, and no compatibility is assumed or implied.
  28.      Care has been taken to attempt to eliminate any conflicts with 
  29.      future versions of InterMail log files, should formats change or
  30.      additional information appear.
  31.  
  32.      Please read the documentation carefully.  It is important that both
  33.      IMLFA and InterMail be set up correctly for this system to work
  34.      properly.
  35.  
  36.      This version of IMLFA is not crippled in any way.  All the features 
  37.      are enabled in this release.  When you first start it up, you will be 
  38.      asked to type in a number to continue.  It will then perform without 
  39.      any further intervention.  This random number step will occur each 
  40.      time you run IMLFA until you register your copy and receive a 
  41.      registration key code.  See REGISTER.DOC for more information.  Your 
  42.      registration will disable the random number step, permitting you to 
  43.      run it from your batch file during regular nightly maintainance events.
  44.  
  45.      SysOps/IM users....  You may distribute this software via any means
  46.      you desire so long as it is distributed in the original self-extracting
  47.      archive format it was released in, with all files intact and unmodified.  
  48.      You may not charge for this distribution with the exception of the cost 
  49.      of a distribution disk, if required, plus a minor shipping and 
  50.      duplication fee.
  51.  
  52.      Distribution by commercial corporations, companies, governmental
  53.      agencies, or educational institutions is prohibited without the 
  54.      expressed written consent of the copyright holder.  This is usually
  55.      not a problem, but solely for informational purposes.
  56.  
  57.  
  58.                              *******************
  59.  
  60.  
  61.      IMLFA requires at least 356k of free memory to run, and will use
  62.      any free EMS it finds.  The more free conventional memory (0 - 640k)
  63.      it has, the faster it will run.  During beta testing, IMLFA processed
  64.      InterMail log files of over 1 meg in about 2 minutes on a 386/40mhz 
  65.      machine with no EMS.  
  66.  
  67.      The 1 meg log file contained transfer information on over 1000 file
  68.      transfers with a busy HUB.  Since IM's log file contains so much extra
  69.      information, finding info about transfers between this HUB and a
  70.      particular node would be a hair pulling experience.  IMLFA transformed
  71.      this 1 meg log file into a data file 10% of that size, still retaining
  72.      all the transfer information such as, date, file name, file size, 
  73.      start time, stop time, average CPS thruput, and connecting node.
  74.      IMLFA will even flag you in its reports if a file transfer failure 
  75.      occured.
  76.      
  77.      Once this data is imported into IMLFA, reports can be produced to
  78.      provide you with information on your systems connects.  The comments
  79.      in the IMLFA.CFG file explain the types of reports available in detail.
  80.  
  81.  
  82.      NOTES:  IMLFA must be run from its own directory.  It does not
  83.              search paths for the IMLFA.* files.  Change to the IMLFA
  84.              directory before running this program.
  85.  
  86.              IMLFA does not modify InterMails log file in any way.  It
  87.              does however, expect the InterMail log file to contain
  88.              certain information.  This may mean that you will have to
  89.              modify your setup in IMSETUP to accomodate this program.
  90.              This is explained in detail in the IMLFA.CFG file.
  91.  
  92.              If you find that you aren't getting what you'd expect out
  93.              of this program, look in the IMLFA directory for a file
  94.              called IMLFA.ERR.  It will be created if trouble arises and
  95.              provide you with information as to what the problem was.
  96.  
  97.      
  98.                              *******************
  99.      
  100.  
  101.                               GETTING STARTED.
  102.  
  103.      1.  Create a directory on your hard disk called IMLFA.
  104.          MD\IMLFA
  105.  
  106.      2.  Copy all the files from this archive to that directory.
  107.          COPY *.* \IMLFA
  108.  
  109.      3.  Edit the IMLFA.CFG file to set up the system for the
  110.          type of reports you wish to produce, and path and filenames.
  111.          IMLFA.CFG is heavily commented and also serves as additional
  112.          documentation for the program.  Read it carefully and verify
  113.          that all the paths you specify actually exist and are spelled
  114.          correctly.
  115.  
  116.      4.  At the DOS prompt type in IMLFA -I and press return.  IMLFA will
  117.          read in your InterMail log file and store the data it will need
  118.          for your reports in a file called IMLFA.DBF.  The IMLFA.DBF file
  119.          is not included in the archive, but will be created during the
  120.          initial run.  Other misc files may be created from time to time.
  121.          Altering or removing any of them will bring unpredictable results.
  122.  
  123.      5.  You may now run IMLFA by passing any of the following command 
  124.          line parameters. 
  125.  
  126.          NOTE:  Stacking command line parameters is not permitted.
  127.  
  128.       o  IMLFA -?  produces a short screen of information on all 
  129.          available switches.
  130.  
  131.       o  IMLFA -I  processes all the data from the current IM log file.
  132.          This obviously should only be done once per day, and care should
  133.          be taken to insure that the log file is deleted or moved out of 
  134.          the way so that the data in it will not be imported again.  See
  135.          the -B switch below.
  136.  
  137.       o  IMLFA -1:355/559=JOHN   Will produce a detailed report of the
  138.          traffic between you and John at node 1:355/559.  Two reports
  139.          will be produced.  JOHN.IN and JOHN.OUT.  You may use any legal
  140.          file and path name you wish after the "=" sign, but use no
  141.          extension.  IMLFA -1:355/559=C:\BBS\TXTFILES\JOHN would create
  142.          the report in the directory where you keep your bbs displayable
  143.          text files. (C:\BBS\TXTFILES\)
  144.  
  145.       o  IMLFA -R will produce a single report of all the traffic between
  146.          you and all other nodes you have had contact with.  You specify
  147.          the filename of this report in the IMLFA.CFG file at the MAIL FILE
  148.          statement.  The filename will always be the same and paths are
  149.          supported here also.  Note that the report is cumulative and shows
  150.          all transfer information with your system since the IMLFA data 
  151.          files were created.
  152.  
  153.       o  IMLFA -B will back up the IM log file to the path specified in the
  154.          BACKFILE statement in the IMLFA.CFG file.   This option is very
  155.          handy in several ways.  First, after calling IMLFA -I to process
  156.          your IM log file, you need to make sure that the log file is no
  157.          longer available to be processed again.  Using the -B switch will
  158.          take care of that for you.  Secondly, it will give you a means
  159.          to recover your log file should you need to.
  160.          IMLFA uses a date nameing convention you can understand.  Assume
  161.          todays date is 01/02/93, it is just after midnight and you drop
  162.          out of the mailer to process the log file.  After running with the
  163.          -I switch, you run again with -B, and the IM.LOG file is renamed
  164.          to 01-01-93.LOG and is moved to the directory you specified in
  165.          IMLFA.CFG.  Once all your processing is complete and your batch 
  166.          file restarts IM, a new log file is created.
  167.  
  168.       o  IMLFA -N creates all new index files for the stored data.  If you
  169.          see data that doesn't look quite right, you could have a corrupt
  170.          index.  Run IMLFA with this switch and then try running for reports
  171.          again, to see if the problem has been corrected.
  172.  
  173.       o  IMLFA -Z may be useful for HUB's wishing to use the reports for
  174.          assisting in spreading out echo mail distribution costs.  Since
  175.          IMLFA stores data on all files transfered thru your system, the 
  176.          data regarding files other than echo mail, FREQ'ed files, is 
  177.          included in all reports.  Calling the -Z switch will remove all
  178.          files, containing the following extensions, from the stored data.
  179.                  
  180.                ZIP, PAK, ARC, LZH, ARJ, EXE, TXT, ZOO, TIC
  181.          
  182.          Use the -Z switch prior to running your reports and you will 
  183.          receive a truer picture of just how much echo mail distribution
  184.          your system is producing with each of your nodes.
  185.  
  186.       o  IMLFA -W will wipe out ALL stored data in the system, in effect,
  187.          giving you a clean slate.  CAREFULL!  There is no escape from this
  188.          switch.   Since you want to be able to run it from your batch file,
  189.          NO prompt will be given before the data is removed from the file,
  190.          and that data is gone forever.
  191.  
  192.  
  193.    Summary:
  194.      
  195.      You will probably want to call IMLFA several times in a session,
  196.      first to process and back up the latest InterMail log, then to 
  197.      create the reports.
  198.  
  199.      A typical session in your batch file might look something like:
  200.  
  201.    :IM_RUN
  202.       
  203.       REM   Change to the IMLFA directory.  Remember....It doesn't search
  204.       REM   your paths for its files.
  205.          CD\IMLFA
  206.       
  207.       REM   Read in the latest IM log info.
  208.          IMLFA -I
  209.       
  210.       REM   Backup the log file you just processed.
  211.          IMLFA -B
  212.  
  213.       REM   I'm a HUB so I want to Zap out all files not related to
  214.       REM   Echo Mail traffic.
  215.          IMLFA -Z
  216.  
  217.       REM   Produce a detailed report of traffic to and from 1:355/1
  218.          IMLFA -1:355/1=C:\BBS\TXTFILES\PETE
  219.  
  220.       REM   Produce a detailed report of traffic to and from 1:3611/1
  221.          IMLFA -1:3611/1=C:\BBS\TXTFILES\JERRY
  222.  
  223.       REM   DITTO
  224.          IMLFA -1:355/559=C:\BBS\TXTFILES\GORDON
  225.  
  226.       REM   Produce a summary report for all mail traffic with all nodes.
  227.       REM   This file is named and stored according to the information
  228.       REM   you provided in the IMLFA.CFG file.
  229.          IMLFA -R
  230.  
  231.       REM   Wipe out all data being stored by IMLFA.
  232.       REM   Use with caution as this is irreversable!
  233.       REM   Recommended that you do this in manual mode after you are
  234.       REM   certain that you have all the reports you wish from the 
  235.       REM   stored data.
  236.          IMLFA -W
  237.        
  238.       REM   Start up BBS/IM again.
  239.          GOTO RECYCLE
  240.  
  241.       The entire run above on a months worth of IM log data would only take
  242.       a few mins on a slow machine, but you'll probably want to run this
  243.       on a weekly basis, or more often if you have a busy system.  Mine runs
  244.       every night, but without the call to IMLFA -W.  I have that set up as
  245.       a seperate event occuring once a week, and I have sysop only menus to
  246.       read them all from a bbs logon.
  247.  
  248.       REGISTERED USERS:
  249.       It is recommended that you create an external event to exit at just 
  250.       after midnight to run the program, especially if you intend to use
  251.       the log file backup option.(-B switch.)  This would create a more
  252.       realistic backup based on the date used as the file name.
  253.  
  254.  
  255.                              *******************
  256.  
  257.                                 IMLFA SUPPORT
  258.  
  259.  
  260.       Support is provided via Net Mail or written request only.  Responses
  261.       via Net Mail are the fastest, usually within 48 hours of receipt here.
  262.  
  263.       I will also try to answer questions via my CompuServe address (listed
  264.       above) if you so choose, but responses may not be as timely.
  265.  
  266.       Please DO NOT use the FIDONET INTERMAIL echo for this purpose.  
  267.       I will not respond to questions or bug reports in that forum.
  268.  
  269.       I will provide any help I can at FIDONET 1:355/559 for as long as I 
  270.       remain in the FIDO organization.  I anticipate that being quite a
  271.       while. :-)
  272.  
  273.       Comments and or suggestions for new features are welcome at any time.
  274.       
  275.       See REGISTER.DOC, included in this archive, for information on 
  276.       fixes and or upgrades.
  277.       
  278.       Enjoy.....
  279.       Gordon
  280.  
  281.      
  282.