home *** CD-ROM | disk | FTP | other *** search
/ ftp.rarlab.com / 2014.05.ftp.rarlab.com.tar / ftp.rarlab.com / rar / rcvtw32.rar / Rcvt.txt < prev   
Text File  |  2002-05-17  |  7KB  |  187 lines
  1.  
  2.    The RAR Convertor
  3.    ~~~~~~~~~~~~~~~~~
  4.    Archive Conversion Utility
  5.    ~~~~~~~~~~~~~~~~~~~~~~~~~~
  6.    User manual
  7.    ~~~~~~~~~~~
  8.  
  9.    The RCVT Archive Conversion utility provides conversion of different
  10.    archive types to one, master type.
  11.  
  12.    RCVT extracts files from the source archive and packs them into the
  13.    new archive, removing the original archive provided the output archive
  14.    was successfully created.
  15.  
  16.    The configuration file RCVT.CFG contains archive types and options.
  17.    Archive types are defined with archiver program calls to pack, extract
  18.    and test the corresponding archives.
  19.  
  20.    The utility has been specially developed to convert archives of different
  21.    types to RAR archives in order to obtain a higher compression ratio for
  22.    your data.  However it is possible to re-configure RCVT to another master
  23.    archive type. This is achieved by placing the definition of the master
  24.    archive type before others in the configuration file.
  25.  
  26.  
  27.       1. The configuration file RCVT.CFG
  28.  
  29.    The RCVT configuration file RCVT.CFG is a plain text file containing
  30.    options and archive type definitions.  RCVT.CFG must be in the same
  31.    directory as RCVT.EXE.
  32.  
  33.    Strings starting with the semi-colon character ';' are comments and are
  34.    ignored by RCVT.EXE.
  35.  
  36.  
  37.       1.1. Options
  38.  
  39.    OnError  NextArchive | Abort
  40.  
  41.    The value of this option defines how RCVT is to proceed when an error
  42.    in the current archive is reported by the archiver. Set this option to
  43.    'Abort' if you want RCVT to stop processing archives when an error
  44.    occurs.
  45.  
  46.  
  47.    RepackRatio <Percent>
  48.  
  49.    Specifies the lowest acceptable compression ratio after repacking.
  50.  
  51.  
  52.    Add <filename>
  53.  
  54.    Specifies the name of the file which must be added to every repacked
  55.    archive.  Full pathname should be provided.  Multiple "Add" strings are
  56.    allowed.
  57.  
  58.  
  59.    Del <filename>
  60.  
  61.    Specifes file(s) that should not be placed into the repacked archive.
  62.    Wildcards may be used.  Root directory of the archive is assumed
  63.    if no full path given.  Multiple "Del" strings are allowed.
  64.  
  65.  
  66.    Scan <filename-to-run>
  67.  
  68.    You can set up a program call to process files extracted from the source
  69.    archive before repacking them into new archive. For instance, an
  70.    antivirus program to scan files for computer viruses may be defined.
  71.    Should the program return non-zero exit code (ERRORLEVEL) the source
  72.    archive will not be repacked and a corresponding message will be
  73.    placed into the log file RCVT.LOG.  Multiple "Scan" strings are allowed.
  74.  
  75.  
  76.    Filelist <filename>
  77.  
  78.    Specifies the file where source archives are listed.  The name of the
  79.    source archive, after successful conversion, is replaced with the new
  80.    name as well as the actual file size if possible.  If a full path is
  81.    not given, the filelist is expected to be in the same directory as the
  82.    archive. Multiple "Filelist" strings are allowed.
  83.  
  84.  
  85.       1.2. Archive definitions
  86.  
  87.    Each archive definition consists of 4 strings.
  88.  
  89.    The first string declares archive type - the archive file extension and
  90.    optional archive signature - a mask containing up to the first 32 generic
  91.    bytes of the archive file as hexadecimal numbers, for instance:
  92.  
  93.     ; Converting from old (prior to version 1.50) RAR format
  94.     .RAR 52457E5E
  95.  
  96.    The archive signature is optional, so the archive files could be
  97.    distinguished only by the extension, for instance:
  98.  
  99.     ; Converting from zip format
  100.     .ZIP
  101.  
  102.    The remaining strings define program calls for the archive type to pack,
  103.    extract and test the archive:
  104.  
  105.     PACK <command-line>  to pack files to the archive (create the archive)
  106.     EXTR <command-line>  to extract files from the archive
  107.     TEST <command-line>  to test files in the archive
  108.  
  109.    Following example is a complete definition of the RAR archive type:
  110.  
  111.     ; Master archive definition: converting to RAR format
  112.  
  113.     .RAR
  114.     PACK RAR a -s -std -c- -r -z$CMT$
  115.     EXTR RAR x -std -c- -y -av-
  116.     TEST RAR t -std -c-
  117.  
  118.    (See the RAR user's manual for the full description of command line
  119.    options.)
  120.  
  121.    When processing .RAR, .ARJ and .ZIP archives, the comment from the
  122.    source archive is placed into a temporary file which will then be
  123.    repacked to the new archive.  To denote the archive comment file, in
  124.    the archiver command line, the name '$CMT$' is used.  RCVT replaces
  125.    it with actual comment file name when repacking to the new archive
  126.    type.
  127.  
  128.    NOTE: The PACK and EXTR archiver command lines should be defined to
  129.    recurse subdirectories.
  130.  
  131.    The TEST command line is optional. It is used to verify the freshly
  132.    created archive (checking that files can be extracted without errors).
  133.    In case the program returns a non-zero exit code (ERRORLEVEL) the
  134.    repacked archive is discarded and the source archive is not removed,
  135.    a corresponding messages are placed into the log file RCVT.LOG.
  136.  
  137.    If no TEST command line is defined the repacked archives are assumed
  138.    to have been successfully created without checking them, however it
  139.    is highly recommended to use the TEST command if possible.
  140.  
  141.    NOTE: Archiver programs described in command lines of RCVT.CFG must be
  142.    in the current path to be called from RCVT.
  143.  
  144.  
  145.       2. Usage
  146.  
  147.  
  148.       To run RCVT use following syntax:
  149.  
  150.         RCVT [-switch[-]] <archive>
  151.  
  152.       You need only supply the archive name (wildcards allowed).
  153.       Optional switches:
  154.  
  155.             -r[-]: convert archives in subdirectories
  156.             -n[+]: convert nested archives
  157.             -k[+]: keep archive time
  158.  
  159.       Examples:
  160.  
  161.         Convert all archives on the current disk:
  162.         RCVT -r *.*
  163.  
  164.         Convert the archive book.lzh:
  165.         RCVT book.lzh
  166.  
  167.    Extraction is performed to a temporary directory created in the
  168.    current path.  Files are scanned, if the SCAN option is set.
  169.    Files indicated with the DEL option are not included to the
  170.    converted archive. Files indicated with the ADD option are added
  171.    to the converted archive.
  172.  
  173.    After new archive has been successfully created (and tested by the
  174.    TEST command line) the source archive file is removed. If the file
  175.    contains Nested archives (archives within archives), these are also
  176.    repacked unless the switch '-n-' has been given on the command line.
  177.  
  178.    Archive comments are restored in the repacked archive if the master
  179.    archiver has the option to add archive comment "$CMT$".  Volume
  180.    labels and other specific information are ignored and not repacked.
  181.  
  182.    If the archiver reports an error and the option 'OnError Abort' is
  183.    set in the configuration file, RCVT stops processing archives. All
  184.    errors are reported in the file RCVT.LOG, which is located in the
  185.    same directory as RCVT.EXE.
  186.  
  187.