home *** CD-ROM | disk | FTP | other *** search
/ PC World 1998 June / PCWorld_1998-06_cd.bin / software / sharware / utility / PACKERS / RAR / RCVT100D.EXE / rar / RCVT.DOC < prev    next >
Text File  |  1995-08-02  |  7KB  |  182 lines
  1.  
  2.  ██████╗   █████╗  ██████╗     The RAR Convertor
  3.  ██╔══██╗ ██╔══██╗ ██╔══██╗    ~~~~~~~~~~~~~~~~~
  4.  ██████╔╝ ███████║ ██████╔╝    Archive Conversion Utility version 1.00
  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.    Add <filename>
  48.  
  49.    Specifies the name of the file which must be added to every repacked
  50.    archive.  Full pathname should be provided.  Multiple "Add" strings are
  51.    allowed.
  52.  
  53.  
  54.    Del <filename>
  55.  
  56.    Specifes file(s) that should not be placed into the repacked archive.
  57.    Wildcards may be used.  Root directory of the archive is assumed
  58.    if no full path given.  Multiple "Del" strings are allowed.
  59.  
  60.  
  61.    Scan <filename-to-run>
  62.  
  63.    You can set up a program call to process files extracted from the source
  64.    archive before repacking them into new archive. For instance, an 
  65.    antivirus program to scan files for computer viruses may be defined. 
  66.    Should the program return non-zero exit code (ERRORLEVEL) the source 
  67.    archive will not be repacked and a corresponding message will be 
  68.    placed into the log file RCVT.LOG.  Multiple "Scan" strings are allowed.
  69.  
  70.  
  71.    Filelist <filename>
  72.  
  73.    Specifies the file where source archives are listed.  The name of the
  74.    source archive, after successful conversion, is replaced with the new 
  75.    name as well as the actual file size if possible.  If a full path is 
  76.    not given, the filelist is expected to be in the same directory as the
  77.    archive. Multiple "Filelist" strings are allowed.
  78.  
  79.  
  80.       1.2. Archive definitions
  81.  
  82.    Each archive definition consists of 4 strings.
  83.  
  84.    The first string declares archive type - the archive file extension and
  85.    optional archive signature - a mask containing up to the first 32 generic
  86.    bytes of the archive file as hexadecimal numbers, for instance:
  87.  
  88.     ; Converting from old (prior to version 1.50) RAR format
  89.     .RAR 52457E5E
  90.  
  91.    The archive signature is optional, so the archive files could be
  92.    distinguished only by the extension, for instance:
  93.  
  94.     ; Converting from zip format
  95.     .ZIP
  96.  
  97.    The remaining strings define program calls for the archive type to pack,
  98.    extract and test the archive:
  99.  
  100.     PACK <command-line>  to pack files to the archive (create the archive)
  101.     EXTR <command-line>  to extract files from the archive
  102.     TEST <command-line>  to test files in the archive
  103.  
  104.    Following example is a complete definition of the RAR archive type:
  105.  
  106.     ; Master archive definition: converting to RAR format
  107.  
  108.     .RAR
  109.     PACK RAR a -s -std -c- -r -z$CMT$
  110.     EXTR RAR x -std -c- -y -av-
  111.     TEST RAR t -std -c-
  112.  
  113.    (See the RAR user's manual for the full description of command line
  114.    options.)
  115.  
  116.    When processing .RAR, .ARJ and .ZIP archives, the comment from the
  117.    source archive is placed into a temporary file which will then be
  118.    repacked to the new archive.  To denote the archive comment file, in 
  119.    the archiver command line, the name '$CMT$' is used.  RCVT replaces
  120.    it with actual comment file name when repacking to the new archive 
  121.    type. 
  122.  
  123.    NOTE: The PACK and EXTR archiver command lines should be defined to
  124.    recurse subdirectories.
  125.  
  126.    The TEST command line is optional. It is used to verify the freshly
  127.    created archive (checking that files can be extracted without errors).
  128.    In case the program returns a non-zero exit code (ERRORLEVEL) the 
  129.    repacked archive is discarded and the source archive is not removed, 
  130.    a corresponding messages are placed into the log file RCVT.LOG. 
  131.  
  132.    If no TEST command line is defined the repacked archives are assumed
  133.    to have been successfully created without checking them, however it 
  134.    is highly recommended to use the TEST command if possible. 
  135.  
  136.    NOTE: Archiver programs described in command lines of RCVT.CFG must be
  137.    in the current path to be called from RCVT.
  138.  
  139.  
  140.       2. Usage
  141.  
  142.  
  143.       To run RCVT use following syntax:
  144.  
  145.         RCVT [-switch[-]] <archive>
  146.  
  147.       You need only supply the archive name (wildcards allowed).
  148.       Optional switches:
  149.  
  150.             -r[-]: convert archives in subdirectories
  151.             -n[+]: convert nested archives
  152.             -k[+]: keep archive time
  153.  
  154.       Examples:
  155.  
  156.         Convert all archives on the current disk:
  157.         RCVT -r *.*
  158.  
  159.         Convert the archive book.lzh:
  160.         RCVT book.lzh
  161.  
  162.    Extraction is performed to a temporary directory created in the
  163.    current path.  Files are scanned, if the SCAN option is set.
  164.    Files indicated with the DEL option are not included to the 
  165.    converted archive. Files indicated with the ADD option are added
  166.    to the converted archive. 
  167.  
  168.    After new archive has been successfully created (and tested by the 
  169.    TEST command line) the source archive file is removed. If the FILE 
  170.    contains Nested archives (archives within archives), these are also 
  171.    repacked unless the switch '-n-' has been given on the command line. 
  172.  
  173.    Archive comments are restored in the repacked archive if the master
  174.    archiver has the option to add archive comment "$CMT$".  Volume 
  175.    labels and other specific information are ignored and not repacked. 
  176.  
  177.    If the archiver reports an error and the option 'OnError Abort' is
  178.    set in the configuration file, RCVT stops processing archives. All
  179.    errors are reported in the file RCVT.LOG, which is located in the
  180.    same directory as RCVT.EXE.
  181.  
  182.