uharc_readme.doc

beat版 一看就懂

 UHARC 0.6b         high compression multimedia archiver           BETA version
 ==============================================================================

      ####    ####  ####    ####    ########    ###########    ##########
      ####    ####  ####    ####   ##########   ############  ############
      ####    ####  ####    ####  ####    ####  ####    ####  ####
      ####    ####  ############  ############  ###########   ####
      ####    ####  ############  ############  ###########   ####
      ####    ####  ####    ####  ####    ####  ####    ####  ####
      ############  ####    ####  ####    ####  ####    ####  ############
       ##########   ####    ####  ####    ####  ####    ####   ##########

 ==============================================================================
 Copyright(c) 1997-2005 by Uwe Herklotz     All rights reserved     01 Oct 2005

    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  !!!!!!     THIS IS A BETA VERSION AND MAY CONTAIN BUGS.  USE THIS     !!!!!!
 !!!!!!      ARCHIVER AT YOUR OWN RISK. UWE HERKLOTZ, THE AUTHOR OF      !!!!!!
 !!!!!!      UHARC, WILL NOT TAKE ANY RESPONSIBILITY FOR ANY DAMAGE      !!!!!!
  !!!!!!     OR DATA LOSS CAUSED BY USING OR MISUSING THIS SOFTWARE.    !!!!!!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!



 ===< 0. Contents >============================================================


   1. Introduction
   2. Usage
      2.1. Commands
      2.2. Switches
      2.3. Environment variable
   3. Examples
   4. History
   5. Legal info / Registration
   6. Contact info



 ===< 1. Introduction >========================================================


  UHARC is a high performance file archiver. This package contains 7 files:

    LICENSE.DOC    License information
    UHARC.EXE      program version for Win32 systems
    UHARCD.EXE     program version for Dos32 systems
    UHARCSFX.EXE   Sfx-Stub for Win32 systems
    UHARC.DOC      this documentation file
    UNUHARC.EXE    free extraction program for Win32 systems
    UNUHARCD.EXE   free extraction program for Dos32 systems

  What's new in version 0.6b ?

    - free extraction programs for Win32/Dos32 added - these programs can be
      used and distributed freely without any restrictions

  Note: UHARC 0.6b archives are compatible with v0.6 and v0.6a archives but
        NOT compatible with any previous version (version number < 0.6)!

  This program will run on any 386 or better computer. Memory requirements
  depend on selected compression mode. The number of files in one operation
  is only limited by available memory, however current version can't handle
  archives with more than 2 GB total unpacked size.



 ===< 2. Usage >===============================================================


  Usage: UHARC command [-switch..] archive[.uha] [file..@listfile..!exclude..]

  Commands:
  ~~~~~~~~~
    a   Create archive/Add files           e   Extract files to current dir
    m   Create archive/Move files          x   Extract files with full path
    l   List files in archive              t   Test files in archive

  Switches:
  ~~~~~~~~~
    ac[-,+]     Clear file archive attr    ae<attr>  Set attr exclusion mask
    b<n>        Set max filebuffer size    bpb[-,+]  bpb instead of % ratio
    d<0..2>     Set display mode           ed[-,+]   Store empty directories
    idle        Set idle process priority  lg<file>  Log output to <file>
    m<0..3,x,z> Set compression mode       md<n>     Set dictionary size
    mm[-,+]     MM-detection on/off        o[-,+,p]  Set overwrite mode
    pw[passwd]  Set password               p<-,r,f>  Set path handling
    r[-,+]      Recurse subdirectories     t<dir>    Set extract target dir
    vm[-,+]     Set virtual memory usage   y[-,+]    Assume yes on all queries


  * For commandline help type "UHARC" without any parameter.

  * The command character must be placed immediately after "UHARC".

  * The switches, if any, must follow the command character. UHARC supports
    the use of either "-" or "/" as the switch option character.

  * The UHARC archive name must be the first filename on the commandline.
    If there is no archive file extension specified, UHARC will add the
    default (".UHA") extension.

  * After the archive filename come the list of files for the given
    operation. One or more files containing a list of files to process
    can also be used by prefixing the list's filename with "@". It's
    possible to mix filenames and list files in any order. If a filename
    on commandline or in a list file has prefix "!", this means it will
    be excluded in processing. Allowed delimiters for filenames in list
    files are space, tab and newline. Filenames with spaces must be
    enclosed in double-quotes. The line size in list file must not
    exceed 4095 characters.

  * Filename wildcards are allowed in commandline and in list files,
    but not for archive filename. The use of wildcards follow MS-DOS
    convention. "*.*" means all files. "*.txt" means all files with an
    extension of ".TXT". "?B*.*" means all files with a second character
    of "B".

  * If there are no files specified at all, all files ("*.*") will be
    processed (use "-r" to recurse subdirectories).

  * UNUHARC versions have same commandline options like UHARC but support
    extraction and test commands only.



 ---< 2.1. Commands >----------------------------------------------------------


   a    Create archive and add matching files.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        If a file with the archive name already exists, UHARC will ask
        before overwriting this file, unless you change the default
        overwrite mode or use "-y".

        Following switches have effect: ac ae b bpb d ed lg m md mm o p pw r y


   e    Extract matching files to current directory.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        Stored pathnames will be ignored. Using the switch "-t", you can
        change the current directory for extracting.

        Following switches have effect: b d lg o pw t y


   l    List matching files in archive.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        Using switch "-y", UHARC will not pause after one page, else you
        can use the following keys:
             ESCAPE      =  Cancel (quit program)
             TAB         =  Disable pause
             RETURN      =  Next line
             other keys  =  Next page

        Using switch "-d2", filenames are not shortened and more
        information are displayed.

        Following switches have effect: b bpb d lg pw y


   m    Create archive and move matching files.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        If a file with the archive name already exists, UHARC will ask
        before overwriting this file, unless you change the default
        overwrite mode or use "-y". If compression was successful, UHARC
        will delete matching files on disk (but no directories).

        Following switches have effect: ae b bpb d ed lg m md mm o p pw r y


   t    Test integrity of ALL files in archive.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        Following switches have effect: b d lg pw y


   x    Extract matching files with full pathnames.
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        UHARC will use the pathnames stored in archive for extraction (if
        the archive was created with option "-pf", this also includes drive
        letters). Using the switch "-t", you can select the root-directory
        for all extracted dirs/files.

        Following switches have effect: b d lg o pw t y


   Note:  During all operations it's possible to terminate the process
          by pressing ESCAPE and answering the following question with
          "Y" (when listing files, there is no additional query).



 ---< 2.2. Switches >----------------------------------------------------------


  --           Stop switches scanning
               ~~~~~~~~~~~~~~~~~~~~~~
               This switch tells UHARC that there are no more switches to be
               processed. It's necessary if the archive name starts with a
               "-" character. Without "--" switch such name would be treated
               as a switch.


  -!<char>     Set exclude mask specifier
               ~~~~~~~~~~~~~~~~~~~~~~~~~~
               Defines the character that is used as exclude mask specifier.
               It should be used if a file name given in commandline or in
               list file starts with the default exclude mask character "!".
               If no character is given ("-!") then exclude mask processing
               will be disabled. This option should be used carefully.

               DEFAULT: -!!


  -@<char>     Set list file specifier
               ~~~~~~~~~~~~~~~~~~~~~~~
               Defines the character that is used as list file specifier.
               It should be used if a file name given in commandline or in
               list file starts with the default list file character "@".
               If no character is given ("-@") then list file processing
               will be disabled. This option should be used carefully.

               DEFAULT: -@@


  -ac[-,+]     Clear file archive attribute
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                 -ac[+]  Clear archive attribute of files stored in archive.
                 -ac-    Don't clear archive attribute.

               If this option is enabled and compression was successful,
               UHARC will clear the archive attribute of all files which
               are stored in archive (directories are not affected).

               This option has effect with add command only.

               DEFAULT: -ac-


  -ae<attr>    Set attribute exclusion filter
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               Defines the filter for exclusion based on file attributes.
               Files are excluded if specified attributes are set "+" or
               cleared "-". File attributes are:

                 "A"     archive attribute
                 "H"     hidden file attribute
                 "R"     read-only attribute
                 "S"     system file attribute

               Example: switch "-aeA-H+" means that files with archive
               attribute cleared or hidden attribute set are not included
               in the processing list.

               This option has effect with add or move commands only.

               DEFAULT: not specified


  -b<n>        Set maximum file buffer size (in KB).
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               After allocating all structures for (de)compression the
               remaining memory is used for file buffers, but never more
               than <n>. The minimum buffer size is 50 KB.

               DEFAULT: -b1024


  -bpb[-,+]    Show bpb instead of % ratio
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~
                 -bpb[+] Show compression ratio in bpb.
                 -bpb-   Show compression ratio in %.

               DEFAULT: -bpb-


  -d<0..2>     Set display mode.
               ~~~~~~~~~~~~~~~~~
                 -d0     Quiet mode (no process information, except queries).
                 -d1     Display some process information.
                 -d2     Show more information (file info, verbose listing).

               DEFAULT: -d1


  -ed[-,+]     Store empty directories
               ~~~~~~~~~~~~~~~~~~~~~~~
                 -ed[+]  Store also empty directories.
                 -ed-    Don't store empty directories.

               This option has effect with add or move commands only.

               DEFAULT: -ed-


  -idle        Set idle process priority (Win32 only)
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               This option forces UHARC to set its process in IDLE priority
               class, which means UHARC is executed as background task with
               only small effect on normal system operation (assumed there
               is enough memory available). This way UHARC can process very
               large data sets without blocking the system for long time.

               DEFAULT: not specified


  -lg<file>    Log UHARC output to specified <file>.
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               If UHARC fails to open <file>, no log is created (without an
               error message). The display mode setting has effect on log,
               too.

               DEFAULT: no log file


  -m<0..3>     Set compression mode.
               ~~~~~~~~~~~~~~~~~~~~~
                 -m0     Store files without compression.
                 -m1     Use ALZ:1 (fast) compression mode.
                 -m2     Use ALZ:2 (norm) compression mode.
                 -m3     Use ALZ:3 (best) compression mode.
                 -mx     Use PPM compression mode.
                 -mz     Use LZP compression mode.

               ALZ uses advanced LZ77 compression algorithm with arithmetic
               entropy coder. "-m1" is the fastest ALZ mode, sacrificing
               compression ratio to gain better speed. Mode "-m3" achieves
               best compression and needs most time. "-m2" is a compromise
               ratio/speed and is used as default mode. The decompression
               speed is nearly the same for all ALZ modes and it is much
               faster than compression.

               PPM mode uses an order-4-2-1-0 model with preliminary LZP
               pass. In most cases this mode provides the best compression
               results.

               LZP mode uses the same dictionary compression as in PPM mode
               but with much simpler order-1-0 literal model.

               There are also two extra modes (may be not supported in
               future versions):
                 -mr     Use simple RLE compression.
                 -mw     Use LZ78 with selectable dictionary size.

               DEFAULT: -m2


  -md<n>       Set maximum dictionary size (in KB).
               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
               If dictionary is disabled, this setting has no effect.
               Valid sizes:
                 -m1..3,-mx,-mz   n = power of 2 from 1 to 32768 or "a".."p"
                 -mw              n = power of 2 from 1 to 32    or "a".."f"

               A one-character shortcut can be used instead of size number,
               e.g. "-mda" instead of "-md1" or "-mdk" instead of "-md1024".

               Dictionary size selection:
                 1. Using option "-md<n>", UHARC will never select a
                    dictionary size greater than <n>. If "-md<n>" is not
                    used, UHARC will try to use default dictionary (n=4096).