home *** CD-ROM | disk | FTP | other *** search
/ Carsten's PPE Collection / Carstens_PPE_Collection_2007.zip / S / STATSQ1D.ZIP / CLEANUPQ.DOC < prev    next >
Text File  |  1995-03-01  |  10KB  |  198 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                              CleanUpQ for QFront (QSCAN)
  8.  
  9.           ═════════════════════════════════════════════════════════════════
  10.  
  11.               CleanUpQ does not run without the registration of StatusQ!
  12.  
  13.                CleanUpQ was written to reduce the size of the QFront log(s)
  14.           to speed up  the running of StatusQ as well  as reducing the size
  15.           of the QFront log(s) for editing, etc. This program is written to
  16.           be run  in conjunction with my  StatusQ program and is  not to be
  17.           run  as a  separate  program. To  do  so is  in  violation of  my
  18.           copyright. 
  19.  
  20.                This archive should contain the following files:
  21.  
  22.                CLEANUPQ.EXE.......... QFront log reduction utility
  23.                CLEANUPQ.DOC.......... Instructions for running CleanUpQ
  24.                DOORS.TXT............. Current list James Huckabey doors
  25.                FILE_ID.DIZ........... BBS description file
  26.                SOFTWARE.TXT.......... Information about shareware
  27.                HUCKABEY.TXT.......... Current list of all James Huckabey
  28.                                       software.
  29.                READ.ME............... Update/changes information
  30.                STATUSQ.EXE........... Actual program
  31.                STATUSQ.DOC........... Instructions for running StatusQ
  32.                STATUSQ.CFG........... Sample configuration file     
  33.                STATUSQ2.CFG.......... Sample configuration file
  34.                STATUSQ3.CFG.......... Sample configuration file
  35.                ARCHIVE.TXT........... This list of files
  36.  
  37.  
  38.                                ******* WARNING *******
  39.  
  40.                A word of caution: Because garbage can get into any/all logs
  41.           it is possible to have CleanUpQ chop off your log with an invalid
  42.           end  of file marker.  That is the  garbage can contain  a " " and
  43.           CleanUpQ  believes that this is the end  of the file and cuts off
  44.           the log  at this point.  There is no  way to program  around this
  45.           problem. Once the marker is found the file is set as the  end and
  46.           no  way I  can work  out and  over come  a premature end  of file
  47.           marker. I am still trying to work this out.
  48.  
  49.                                   ******* o *******
  50.  
  51.  
  52.                Syntax:   CLEANUPQ [path]QSCAN.LOG [path][OTHER.CFG]
  53.  
  54.  
  55.                Where QSCAN.LOG is your QFront log file name.
  56.  
  57.                Where  [path][OTHER.CFG)   is  the  name   of  your  StatusQ
  58.           configuration  if you are not using 'STATUSQ.CFG' for the name of
  59.           the configuration file(s). If you do  not supply the name you use
  60.           CleanUpQ aborts if it cannot find the default STATUSQ.CFG file.
  61.  
  62.  
  63.  
  64.  
  65.  
  66.                For best results CleanUpQ should be run before StatusQ. That
  67.           way on the  day of the rollover the LOG(s)  are at their smallest
  68.           possible  size.  If  you run  CleanUpQ  a  second time  on  a log
  69.           produced by rollover it does a hasty exit if the first date found
  70.           is the current date. No harm done!
  71.  
  72.                After  rollover you can run CleanUpQ on your previous log to
  73.           remove  the last day's activity.  To do this  you would unarchive
  74.           the rollover archive, run CleanUpQ  on your log(s) and  rearchive
  75.           the logs. This  way the  log only contains  conference names  and
  76.           Import  / Export totals with header (start date) and trailer (end
  77.           date). If you were  viewing previous activity this would  make it
  78.           much easier to read and total up. It would be possible to  make a
  79.           "Previous Month's" activity bulletin out of the rolled  over log.
  80.           At least the data would be all there and compacted.
  81.  
  82.                CleanUpQ must be  in current directory or  somewhere in your
  83.           path statement.  You may include a full name and path to your log
  84.           file. It  removes everything but the current  activity and writes
  85.           out  the   current  import   and  export  information   for  each
  86.           conference.
  87.  
  88.                At the end of activity the program displays the starting and
  89.           ending  log  file sizes,  starting  and  ending  line count.  The
  90.           process may  be lengthy  depending on  the size  of your log.  It
  91.           should be  run daily. All  that is needed  to run CleanUpQ  is as
  92.           much free  space on the log file drive as  the size of the log or
  93.           the program does not create a new log.
  94.  
  95.                If your  BBS system  is critical on  free space you  can run
  96.           CleanUpQ everyday to reduce  the size of your QFront  log(s). The
  97.           program removes  unneeded lines and  does nothing to  the current
  98.           day's portion of the log. It stops processing data  when it finds
  99.           the log date equal to the system date.
  100.  
  101.                If your hard drive space it not at a premium or speed is not
  102.           critical  then you  really do  not have  to run  CleanUpQ. Or  of
  103.           course  you want all  information to remain in  the log. The main
  104.           savings on time, both  CleanUpQ and StatusQ, would be  gained the
  105.           most near  month's end.  It takes  StatusQ  time to  read in  and
  106.           process logs when they are larger. Lines can reach 18,000 or more
  107.           on a system with a lot of conferences and/or messages.
  108.  
  109.                What CleanUpQ does is  read in all lines separating  out the
  110.           conference names  and number of messages  per conference (running
  111.           total  for each conference). When  the program finds  the date in
  112.           the log matches the system date, or reaches end of log, it starts
  113.           writing  out   the  conference  names  and   total  messages  per
  114.           conference to a  new log. If  it has found  today's date then  it
  115.           appends  the  rest of  the  current data  to  the  new log.  When
  116.           finished it erases the old log.
  117.  
  118.                This leaves you  with a new log showing only  the totals per
  119.           conference,  in sorted order, then the start of the current day's
  120.  
  121.  
  122.  
  123.  
  124.  
  125.           activity (unaltered). CleanUpQ only needs to be run once per day.
  126.           If you  run it  additional times  nothing is changed  in the  log
  127.           although  it  does keep  writing out  a  new one.  Any additional
  128.           information  written to the log  will not be  processed until the
  129.           next day.
  130.  
  131.                If the month rolls over in the log CleanupQ does nothing and
  132.           exits immediately. StatusQ then does the rollover during it's own
  133.           activities.
  134.  
  135.                Regardless of  what is deleted the  current day's activities
  136.           are not altered in any way (unless premature end of file marker).
  137.  
  138.  
  139.                    Special Bulletins Showing Totals Each Conference
  140.  
  141.                It  is  possible  to  make  a  "Previous  Month's"  activity
  142.           bulletin out of the  rolled over log(s). At least  the data would
  143.           be all there  and compacted. All you have to do is make a special
  144.           STATUSQ.CFG file with the name of the bulletins for these special
  145.           monthly Bulletins. You could  do one each month for  the previous
  146.           month. The bulletin for the Last Import could just  be written to
  147.           the  current directory  and  not  used.  For  a  full  month  the
  148.           Bulletins  would have something like 01-01-95 to 01-31-95 for the
  149.           time period as this would be the dates in a log for January 1995.
  150.  
  151.                Of course  the  above would  work even  if you  did not  run
  152.           CleanUpQ.
  153.  
  154.  
  155.                                      This Program
  156.  
  157.                If you don't like the program please write to me and explain
  158.           why. Send me any suggestions you might have. If they enhance  the
  159.           overall program I will try to incorporate part, some, all, in the
  160.           next release.
  161.  
  162.  
  163.                                         Errors
  164.  
  165.                Errors are written to the current directory in a file called
  166.           CLEANUPQ.ERR. If  the file  already exists additional  errors are
  167.           appended to the end of the file. It may be deleted after you have
  168.           made note  of any errors.  It's existence it not  required by the
  169.           program.  Current directory  is  wherever  you call  CLEANUPQ.EXE
  170.           from.
  171.  
  172.                CleanUpQ  must   find  a   valid  and  registered   copy  of
  173.           STATUSQ.EXE either in the  current directory, path or set  in the
  174.           environment  according  to  the StatusQ  documentation.  CleanUpQ
  175.           reads  in   the  STATUSQ.CFG  file,  or   optional  command  line
  176.           configuration  file. I did this because some people might want to
  177.           run  this program  on their  log file  without having  StatusQ on
  178.           their system. This is in violation of my copyrights. This program
  179.  
  180.  
  181.  
  182.  
  183.  
  184.           can only be run in conjunction with STATUSQ.EXE. 
  185.  
  186.                CLEANUPQ.EXE  or any of the  other files in  the archive may
  187.           not  be distributed in any  form other than  the original archive
  188.           and unaltered.
  189.  
  190.                Please  support  my  efforts  and  register  StatusQ,  which
  191.           includes  making   CleanUpQ  operational.  See   STATUSQ.DOC  for
  192.           details.
  193.  
  194.                James Huckabey
  195.                3621-A Fraser Street
  196.                Bellingham, Washington 98226-2473 U.S.A.
  197.                (360) 671-2868 (voice, Pacific)
  198.                I do have a US Robotics HST DS 14.4 v32, v42, v42Bis modem!