home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / COMPR312.ZIP / COMPRESS.DOC next >
Encoding:
Text File  |  1993-03-12  |  12.0 KB  |  442 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                            Compress  v3.12    (Real Mode Version)
  7.                         Compress/286 v3.11    (Protect Mode Version)
  8.  
  9.                     By Ed Crissey, FidoNet 1:268/69
  10.  
  11.  
  12.        (C) Copyright 1990,1993 by Ed Crissey.  All Rights Reserved.
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                          March 13th, 1993
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. -----------------------------------------------------------------------------
  67. Compress v3.12                                                         Page 2
  68.  
  69.  
  70.  
  71.                              INTRODUCTION
  72.  
  73.        Compress is a utility that will allow users of many different
  74.      mailers and bulletin board systems to compress their log files, see
  75.      page 5 for a complete list of all supported systems.  If you run the
  76.      protect mode version,  You need at least a 286 to run it on.  The
  77.      protect mode version is better suited for running in multi-tasking
  78.      environments such as Windows, OS/2 DOS Box, Etc.  This will
  79.      elimate the need to delete these files every few days after they
  80.      have grown to monstrous proportions.  There is a Config file you will
  81.      will need to create for compress.  The default name of the file is
  82.      'Compress.cfg' and it must be placed in the same directory as the
  83.      Compress pgm unless you use the '-C' Command Line Option.  The format
  84.      of the config file is as follows:
  85.  
  86. Line1:   SysOp Name            (  If your copy is not registered then leave )
  87. Line2:   System Name           (  these three lines blank.  Compress is     )
  88. Line3:   Registration Code     (  fully functional either way               )
  89. Lines 4 - Eof:  Here you specify the command line(s) parameters.
  90.                 One line is for one type of Log.  With a few examples as
  91.                 Follows:
  92.  
  93. -tqbbs -d3 -pc:\qbbs\system.log
  94. -tdb -d6 -pc:\db\dbridge.log -q
  95.  
  96. The config file command line paramters are explained as follows on the
  97. next page:
  98.  
  99.                    COMMAND LINE PARAMETERS
  100.  
  101. Compress
  102.  
  103. This invokes Compress and scans the current drive for 'Compress.cfg'
  104.  
  105. Compress -cc:\bbs\jungle.man
  106.  
  107. The invokes Compress and uses Config File 'Jungle.man' in Directory c:\bbs
  108.  
  109. '-C' is currently the only command line parameter available.  All others
  110. specified will be ignored.
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132. -----------------------------------------------------------------------------
  133. Compress v3.12                                                        Page 3
  134.  
  135.  
  136.                      CONFIG FILE COMMAND LINE OPTIONS
  137.  
  138.         [-t] [-d] [-p] [-q] [-logdiag]
  139.  
  140.         -T
  141.         ---------------------------------------------------------
  142.         The -T parameter is to tell compress what log file format
  143.         to compress and the valid options thus far are
  144.         -TDB  to compress the DataBridge Log Format.
  145.         -TQBBS to compress the QuickBBS Log Format.
  146.         -TBINK to compress the BinkleyTerm Log Format.
  147.         -TRAEXP to compress the RemoteAccess Expanded Log Format.
  148.         -TRA to compress the RemoteAccess Compressed Log Format.
  149.         -TFRONT to compress the FrontDoor Log Format. (Or Ra Compressed Format)
  150.         -TDICT to compress the Dictator Log Format.
  151.         -TTICK to compress the Tick Log Format (Prior to V2.10)
  152.         -TZMAIL to compress the Zmail Log Format.
  153.         -TMSGRATIO to comrpess the MsgRatio Log Format.
  154.         -TQM to compress the Qmail Log Format.
  155.         -TMAX to compress the Maximus Log Format.
  156.         -TMSGTRACK to compress the Msgtrack Log Format.
  157.         -TXPRESS to compress the Xpress Log Format.
  158.         -TTM to compress the TeleMail Log Format.
  159.         -TIMAIL to compress the Imail Log Format.
  160.         -TGECHO to compress the Gecho Log Format.
  161.         -TOPUS to compress the Opus Log Format.
  162.         -TSQ to compress the Squish Log Format.
  163.         -TRY to compress the RyPacker Log Format.
  164.         -TRYBBS to compress the RyBBS Log Format.
  165.         -TTICK210 to compress the new Tick Log Format.
  166.         -TPB to compress the PowerBBS Log Format.
  167.         -TTELE to compress the TeleMate Log Format.
  168.         -TAF to compress the AreaFix Log Format.
  169.         -TFRED to compress the FredGate Log Format.
  170.         -TUUCP to compress the Waffle UUCP Log Format.
  171.         -TTRAN to compress the TranScan Log Format.
  172.         -TWC to comrpess the WildCat Log Format.
  173.         -TTNET to compress the TNET Log Format.
  174.         -TWM to compress the WildMail Log Format.
  175.         -TRC to compress the RoboComm Log Format.
  176.         -TDV to compress the DateView Log Format.
  177.         -TMC to compress the Message Comp Log Format.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.                               (Continued)
  198. -----------------------------------------------------------------------------
  199. Compress v3.12                                                        Page 4
  200.  
  201.         -D
  202.         ---------------------------------------------------------
  203.         The -D parameter tells Compress how many days worth of log
  204.         data that you wish to retain.  The valid range is from
  205.         0 to 255.   Compress will scan the log file for the
  206.         datestamp on each record and determine what the X newest
  207.         days are whether they be consecutive or not and purge the
  208.         rest.
  209.  
  210.  
  211.         -P
  212.         --------------------------------------------------------
  213.         The -P option is used to tell Compress the full path as to
  214.         where the log file is.
  215.  
  216.         -Q
  217.         --------------------------------------------------------
  218.         The -Q option tells Compress to be quiet.
  219.  
  220.         -LOGDIAG
  221.         --------------------------------------------------------
  222.         The -LOGDIAG option tells Compress to run in Diagnostic Mode.
  223.         This option does not compress the log.
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264. -----------------------------------------------------------------------------
  265. Compress v3.12                                                        Page 5
  266.  
  267.  
  268.   v1.01  -  To delete header title of QuickBBS log
  269.  
  270.   v1.02  -  Fix Bug in QuickBBS routine becuz of blank line after header
  271.  
  272.   v1.10  -  Added support for a online game called Dictator,BinklyTerm 2.40,
  273.             FrontDoor 1.99c, and Opus.  Since Remote Access uses the Opus or
  274.             FrontDoor Log style that will work as well.
  275.  
  276.   v1.11  -  Renamed the -TOPUS to -TRAOPUS since the routine works with the
  277.             Remote Access OPUS style log but not the OPUS log.  Do not use it
  278.             on an OPUS log.
  279.  
  280.   v1.20  -  Added support for Tick v2.00, Zmail v1.12, and MsgRatio v1.10
  281.  
  282.   v2.00  -  Performed a major rewrite of compress.  See Upgrade file for
  283.             details.  Added support for Qm and Maximus.  Added a Quiet Mode
  284.             Option also.  There is also a config file that needs to be created.
  285.  
  286.   v2.10  -  Added support for Msgtrack v3.10, Xpress v2.29, TeleMail v1.40.
  287.             Compress v2.10 was re-compiled with TP 6.0.
  288.  
  289.   v2.11  -  Increased the log record size from 80 bytes to 132 bytes.  This
  290.             should prevent information from being chopped out of the log.
  291.  
  292.   v2.20  -  Added Support for Remote Access v1.10 Expanded log format.  This
  293.             option is '-TRA' and you no longer need to run '-TFRONT' for the
  294.             Remote Access Expanded Log Format.  Renamed the '-TRAOPUS' to just
  295.             '-TRA' for the compressed format.  Also fixed a minor cosmetic bug
  296.             in the Qmail routine.
  297.  
  298.   v2.30  -  Added Support for Imail V1.21.
  299.  
  300.   v2.40  -  Added Support for Gecho v1.00 and Opus v1.73a.
  301.  
  302.   v2.50  -  Added Support for Squish v1.01.  Fixed a bug in the registered
  303.             routine.  If you have already registered, please contact me.
  304.  
  305.   v3.00  -  Re-Wrote in Object Oriented format.  Added support for Rypacker
  306.             v2.42 ,RyBBS v7.19, Tick v2.10, and PowerBBS v1.90 .  Also fixed a
  307.             few bugs so that Compress will look for the CFG and Key files in the
  308.             execution directory and not the current directory.  In other words,
  309.             move the compress files into the same directory as the exe file.
  310.  
  311.   v3.01  -  Just updated the Docs with new releases.
  312.  
  313.   v3.10  -  Added Support for WildCat v3.00, TeleMate v?.??, AreaFix v1.30,
  314.             FredGate v1.9h, Waffle UUCP v1.64, TranScan v3.02, TNET v3.00,
  315.             WildMail v2.00, RoboComm v4.2, DataView v3.1,
  316.             and Message Comp v1.00.  Compress was re-compiled with BP v7.0
  317.             Also fixed the mouse cursor appearing.
  318.  
  319.   v3.11  -  Fixed a bug in the QuickBBS log.  It was improperly reporting that
  320.             A QuickBBS log wasn't a QuickBBS log.  Also created a Protect Mode
  321.             that runs better in Multi-Tasking environments that will be shipped
  322.             seperately.
  323.  
  324.   v3.12  -  removed the 'Hi Mom'  Was using for testing and forgot to remove.
  325.             Sorry.
  326.  
  327.  
  328.  
  329.  
  330. -----------------------------------------------------------------------------
  331. Compress v3.12                                                        Page 6
  332.  
  333.  
  334.                  **  What is supported by Compress **
  335.  
  336.          1.  DataBridge        v1.51
  337.          2.  QuickBBS          v2.76
  338.          3.  Remote Access     v1.11
  339.          4.  BinkleyTerm       v2.50
  340.          5.  FrontDoor         v1.99c
  341.          6.  Dictator          v1.30
  342.          7.  Tick              v2.10
  343.          8.  Zmail             v1.25
  344.          9.  MsgRatio          v1.10
  345.         10.  Qmail             v1.00
  346.         11.  Maximus           v1.02
  347.         12.  MsgTrack          v3.10
  348.         13.  Silver Xpress     v2.29
  349.         14.  TeleMail          v1.40
  350.         15.  Imail             v1.21
  351.         16.  Gecho             v1.00
  352.         17.  Opus              v1.73a
  353.         18.  Squish            v1.01
  354.         19.  RyPacker          v2.42
  355.         20.  RyBBS             v7.19
  356.         21.  PowerBBS          v1.90
  357.         22.  WildCat           v3.00
  358.         23.  TeleMate          v?.??
  359.         24.  AreaFix           v1.30
  360.         25.  FredGate          v1.9h
  361.         26.  Waffle UUCP       v1.64
  362.         27.  TranScan          v3.02
  363.         28.  TNET              v3.00
  364.         29.  WildMail          v2.00
  365.         30.  RoboComm          v4.2
  366.         31.  DataView          v3.1
  367.         32.  Message Comp      v1.00
  368.  
  369.  
  370.   The above is what Compress has currently been tested with.  If you plan on
  371.   testing it with a new release or a product not mentioned above I suggest
  372.   making a backup of your log before trying Compress on it.  If you would like
  373.   to have another log format supported by Compress and you are a Registered
  374.   User.  Just sent me a copy of the log with a few days worth of data in it
  375.   and I'll get it into a future release.
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396. -----------------------------------------------------------------------------
  397. Compress v3.12                                                        Page 6
  398.  
  399.  
  400.  
  401.                        DOS ERRORLEVEL EXIT CODES
  402.  
  403.  
  404.      Compress will terminate with one of the following DOS errorlevels
  405.      set:
  406.  
  407.            0 .... Log File was successfully compressed.
  408.  
  409.            1 .... -T parameter not specified or is invalid.
  410.  
  411.            2 .... -D parameter not specified or is invalid.
  412.  
  413.            3 .... -P parameter not specified or is invalid.
  414.  
  415.            4 .... Log File was not found at specified path.
  416.  
  417.            5 .... I/O error on the Log File.
  418.  
  419.            6 .... Configuration File not found.
  420.  
  421.                                DISCLAIMER
  422.  
  423.  
  424.      This program is guaranteed to do absolutely nothing.  Use it at
  425.      your own risk.  No warranty is stated or implied.  The author shall
  426.      not be responsible for any damages resulting from it's use, directly
  427.      or indirectly.
  428.  
  429.      This software MUST be distributed free of charge.  UNDER ABSOLUTELY
  430.      NO CIRCUMSTANCES MAY IT BE SOLD!  It is copyrighted and is the sole
  431.      property of the author.  It may not be distributed in modified form.
  432.  
  433.      You may use the software only after agreeing upon the above terms.
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.                         ** End of Documentation **
  441.  
  442.