home *** CD-ROM | disk | FTP | other *** search
/ Windows News 1997 January / WnewsNo40.iso / Utilburo / rkive14 / README.TXT < prev    next >
Text File  |  1996-10-30  |  8KB  |  215 lines
  1.        *************************************************************
  2.        **************    ===RKIVE file archiver===    **************
  3.        *************************************************************
  4.             
  5.             Copyright (c)1996 Malcolm Taylor All Rights Reserved
  6.  
  7.  
  8.       RKIVE is a high performance shareware file archiver which uses many 
  9.    of the latest techniques to gain a high level of compression while
  10.    maintaining a reasonable decompression speed.
  11.  
  12.    This is version 1.4 - released on 30th October 1996.
  13.  
  14. * Features:
  15.  
  16.    RKIVE now supports a full range of standard archiver features - these
  17.    are:
  18.  
  19.          - Support for file attributes.
  20.          - Support for file date/time stamps.
  21.          - Support for CRC32 checksums to verify file integrity.
  22.          - Support for Win95 long filenames.
  23.          - Better compression than almost any other archiver.
  24.          - Environment variable argument passing.
  25.  
  26.  
  27. * Requirements:
  28.  
  29.    This program will run on any 386 or better computer. 4Mb of memory is
  30.    required but 16Mb is recommended for the high compression modes.
  31.  
  32.  
  33. * Format and future:
  34.  
  35.    The format and compression algorithm being used by RKIVE changes
  36.    significantly between versions as I investigate ways of improving the
  37.    compression. Because of this, the versions are not backwardly compatible
  38.    (an archive compressed by v1.3 will not be able to be decompressed by
  39.    v1.4). This version will give an indication of the version required to
  40.    decompress any incompatible archive files.
  41.  
  42.    Because of the problems that this causes I am aiming to freeze the
  43.    algorithm and format once I've finished investigating the algorithm
  44.    and have completed a full feature set. This will then be released as
  45.    v2.0 of RKIVE with the stipulation that any subsequent versions will
  46.    be backwardly compatible.
  47.  
  48.  
  49. * Shareware info:
  50.  
  51.    If you find this program useful then please register it by sending
  52.    US$20 to the address given below.
  53.  
  54.  
  55. * Legal info:
  56.  
  57.    The Author takes no responsibility for any damages resulting from the
  58.    use or misuse of this program.
  59.    USE THIS PROGRAM AT YOUR OWN RISK.
  60.  
  61.    This software is distributed as Shareware and is Copyright (c) 1996
  62.    Malcolm Taylor, all rights reserved.
  63.  
  64.  
  65.    Having said this if you have any problems then please feel free to 
  66.    contact me at the e-mail address below.
  67.  
  68.  
  69. * Usage:
  70.  
  71.    The usage of the archiver is fairly self explanatory:
  72.  
  73.       rkive [options] filename[.rkv] [files ... @list]
  74.  
  75.    The options are:
  76.       -c           to compress (defaults to this if no options given).
  77.       -e           to expand without paths.
  78.       -x           to expand with paths.
  79.       -i           to perform an integrity check.
  80.       -v           to view the files.
  81.       -r           recurse through sub-directories.
  82.       -p[0,r,f]    store pathnames:
  83.                       0 - no pathnames.
  84.                       r - relative pathnames (default).
  85.                       f - full pathnames.
  86.       -s[0,t,e,n]  sets the sorting method to:
  87.                       0 - no sorting.
  88.                       t - sort by file type (default).
  89.                       e - sort by extension.
  90.                       n - sort by name.
  91.       -m[f,b,t[x]] sets the compression mode (see below).
  92.       -mm[0..2]    sets the multi-media compression mode to:
  93.                       0 - no multi-media compression.
  94.                       1 - file-type selected multi-media compression.
  95.                       2 - forced all files multi-media compression.
  96.       -o[+/-]      turns the compression optimisations on or off.
  97.       -j[rsh][+-]  includes files with given attributes.
  98.       -tNNNN       sets the table size (sets compression level).
  99.       -bNNNN       sets the buffer size (see below).
  100.  
  101.    After the options come the archive filename and then the list of files
  102.    for the given operation. A file containing a list of files to compress
  103.    can also be used by prefixing the list's filename with '@'.
  104.  
  105.  
  106. * Compression modes:
  107.  
  108.    There are four main compression modes that have been designed to give
  109.    a wide range of speed and compression. These are:
  110.  
  111.    -mf
  112.       This mode is the fastest mode, sacrificing compression ratio to
  113.    gain better speed (despite this the compression is often better than
  114.    many other popular archivers).
  115.  
  116.    -mb
  117.       This is the default mode, and is best on binary files. On all files
  118.    this gives the best compression for a reasonable speed.
  119.  
  120.    -mt[x]
  121.       These modes both require 16Mb of physical memory to perform at their
  122.    top speed, otherwise they can often be significantly slower. These modes
  123.    both give excelent text compression, however on some binary file types
  124.    (most notably executables and object code) they perform about 1% worse
  125.    than -mb. The -mt mode is the fastest of the two modes, providing
  126.    almost as good compression as -mtx but taking about 30% less time.
  127.  
  128.    There are also available options to change the sizes of internal tables,
  129.    allowing slightly better compression in some cases. In most cases
  130.    changing these values has a slight negative effect, so these are
  131.    normally best left alone.
  132.  
  133.  
  134. * Examples of use:
  135.  
  136.       rkive archive *.txt *.exe @list
  137.  
  138.    This will compress all *.txt, *.exe and the files listed in the file
  139.    'list' to the archive file archive.rkv using the default binary mode.
  140.  
  141.       rkive -jr+s-h -mtx archive *.txt *.doc "Win95 long name.txt"
  142.  
  143.    This will compress all *.txt, *.doc and the file 'Win95 long name.txt'
  144.    including files with the read-only attribute and hidden attribute but
  145.    not files with the system attribute to the archive file archive.rkv
  146.    using the max-text mode.
  147.  
  148.       rkive -x archive
  149.  
  150.    This will extract all files in archive including any stored pathnames.
  151.  
  152.    NB. There does not need to be any files listed to extract, as in this
  153.        case all files are extracted.
  154.  
  155.  
  156. * Memory:
  157.  
  158.    Given below is a list of the approximate memory requirements for each
  159.    mode.
  160.  
  161.       Mode         Mem for compr.     Mem for extract.
  162.       -mf              3.3Mb              3.0Mb
  163.       -mb              6.4Mb              5.8Mb
  164.       -mtf            11.4Mb             11.1Mb
  165.       -mt             13.6Mb             13.0Mb
  166.  
  167.    If you do not have this much available memory (ie. free _PHYSICAL_
  168.    memory) then speed can be significantly hurt. The archiver will still
  169.    function though.
  170.  
  171.  
  172. * Environment variable:
  173.  
  174.    Whenever RKIVE is executed it looks for the environment variable
  175.    'RKIVE_OPT' and parses the value of this variable as though it were
  176.    command line arguments. This enables the default behaviour of RKIVE
  177.    to be changed, or favourite modes to be set automatically. Any
  178.    arguments in the environment variable can be overridden on the command
  179.    line.
  180.  
  181.    eg. SET RKIVE_OPT=-p0 -sn -mt
  182.  
  183.    Will make RKIVE use the text mode, store no paths and sort by name
  184.    by default when rkive is next executed.
  185.  
  186.  
  187. * Contact info:
  188.  
  189.    You can contact me if you have any advice, comments or requests for
  190.    info via the Internet at:
  191.       malcolm@manawatu.gen.nz
  192.  
  193.    My snail mail address is:
  194.       Malcolm Taylor
  195.       19 Koromiko Road
  196.       Wanganui
  197.       New Zealand
  198.  
  199.  
  200. * Acknowledgments:
  201.  
  202.    I'd like to acknowledge some people for their help in creating RKIVE.
  203.  
  204.    The most notable is Charles Bloom without whose helpful pointers,
  205.    information and homepage I would never have been able to write RKIVE.
  206.  
  207.    Philip Lai and Joe Negron need special thanks for the generous
  208.    donation of their time in testing pre-release versions of RKIVE and
  209.    helping me locate bugs.
  210.  
  211.    A general thanks as well to all others who have sent me mail about
  212.    bugs or suggestions for new features.
  213.  
  214.  
  215.