home *** CD-ROM | disk | FTP | other *** search
/ dark domain - the artpacks.acid.org collection / darkdomain.iso / programs / dos / archivers / arj281a.exe / REARJ.TXT < prev    next >
Text File  |  2002-06-12  |  23KB  |  538 lines
  1.  
  2.      User's Manual for the REARJ archive conversion program, September 2001
  3.  
  4.  
  5.         REARJ software and manual copyright (c) 1991-2001 by ARJ Software, Inc.
  6.         All rights reserved.
  7.  
  8.         REARJ version 2.43 release
  9.  
  10.  
  11.  
  12.      INTRODUCTION:
  13.  
  14.      REARJ is an archive conversion program designed to facilitate the
  15.      conversion of LZH, ZIP, PAK, ARC, DWC, HYP, LZS, and ZOO archives to
  16.      the ARJ format.
  17.  
  18.      Registered ARJ users receive an improved version of REARJ that
  19.      offers !listfile selection and exclusion, file date-time selection,
  20.      REARJ_SW environment variable support, skipping a conversion when
  21.      the converted archive is larger, and other features.
  22.  
  23.  
  24.      MAJOR FEATURES:
  25.  
  26.      Supports all major archiver programs (PAK, LHARC, PKZIP, ZOO, ARJ,
  27.      PKPAK, DWC, HYPER, LARC, LHA, RAR).
  28.  
  29.      Supports Windows 95/98 long filenames.
  30.  
  31.      Supports file attributes within archives.
  32.  
  33.      Supports directories within archives.
  34.  
  35.      Supports converting archives within archives (ZIPs in a ZIP).
  36.  
  37.      Ensures reliable archive conversion with a file count and total size
  38.      check.
  39.  
  40.      Supports the use of virus checkers and BBS ad removers.
  41.  
  42.      Supports recursive scanning through subdirectories.
  43.  
  44.      Optional logging of conversions.
  45.  
  46.  
  47.      ********************
  48.      * WORDS OF CAUTION:*
  49.      ********************
  50.  
  51.      If you plan to convert many archives at one time, it is STRONGLY
  52.      suggested that you make a backup of your hard disk.  This is a wise
  53.      precaution to take any time that you make major modifications to data
  54.      on your hard disk drive.
  55.  
  56.      The standard REARJ conversion DOES NOT convert any archive comments
  57.      and volume labels.  They will be lost.
  58.  
  59.      The standard REARJ conversion DOES NOT convert chapters in an chapter
  60.      archive.  Only the last chapter will be converted.
  61.  
  62.      The REARJ.CFG text file should be MODIFIED to include the FULL 
  63.      PATHNAMES of the archiver executables.
  64.      
  65.      Any archives that contain long filenames MUST be converted under
  66.      Windows 95/98 to retain the long filenames during conversion.  Please
  67.      note that most DOS archivers cannot handle archives with long names.
  68.  
  69.      Some of the other archivers have significant bugs which can cause data
  70.      loss that REARJ cannot detect.  It is not the purpose of this document
  71.      to point out other program's shortcomings.  We suggest logging the
  72.      conversion output to a printer to facilitate checking for errors.
  73.  
  74.      If the archives you are converting will ONLY extract to absolute
  75.      paths, you must use the /w option to set the working directory to an
  76.      empty root directory such as a RAMDRIVE.  This will allow extraction
  77.      to the root.
  78.  
  79.      REARJ and the archiver executables must be located in the DOS PATH
  80.      directories.  This is due to REARJ creating and using a temporary
  81.      directory.
  82.  
  83.      If you have changed the MS-DOS switch character from "/" to another
  84.      character via an undocumented MS-DOS interrupt or the TurboC
  85.      setswitchar() function, REARJ may not work properly with the default
  86.      REARJ.CFG configuration file.
  87.  
  88.      The most thorough testing was done with ARJ as the target format and
  89.      ZIP as the original format.  In any case, you should verify that the
  90.      extract commands of your favorite archive formats in the configuration
  91.      file are correct.  The extract commands are the most important to get
  92.      right because REARJ has a built-in verification procedure to ensure
  93.      that the ADD commands executed properly.
  94.  
  95.      You should NOT set the "-t1" option for ARJ in ARJ_SW or in the
  96.      REARJ.CFG configuration file.  This may cause file size mismatches.
  97.  
  98.      Be sure you have enough disk space on your working directory to
  99.      extract the largest archive that you want to convert!!!
  100.  
  101.  
  102.      The versions of archivers tested:
  103.  
  104.      ARJ   1.00, 1.10, 2.00, 2.10, 2.20, 2.21, 2.30, 2.41a, 2.50a,
  105.            and current release
  106.      JAR   1.0
  107.      LHA   2.12, 2.13
  108.      PAK   2.51
  109.      PKZIP 1.10, 2.04, 2.50
  110.      PKPAK 3.61
  111.      ZOO   2.01, 2.10
  112.      DWC   A5.01
  113.      LARC  3.33
  114.      HYPER 2.5
  115.  
  116.  
  117.      INSTALLATION:
  118.  
  119.      Copy REARJ.EXE and REARJ.CFG to one of the DOS PATH directories.  They
  120.      do not have to be placed in the same directory.  The PATH directories
  121.      are usually set by the PATH command in your AUTOEXEC.BAT file.  At
  122.      this version of REARJ, changing its name to something else will cause
  123.      operation difficulties.
  124.  
  125.      Be sure the archiver programs (ARJ, PAK, PKZIP, PKUNZIP, etc.) and
  126.      virus scanner are installed in a DOS PATH directory!  It is STRONGLY
  127.      recommended that the REARJ.CFG be modified to use FULL PATHNAMES to
  128.      specify all archiver executables.
  129.  
  130.      This version assumes that you have the new SCAN version 80 and use
  131.      the new option /sub to scan subdirectories.  This version's
  132.      configuration file also assumes that SCAN.EXE is installed in
  133.      the directory C:\BIN.
  134.  
  135.  
  136.      OPERATION OF REARJ:
  137.  
  138.      REARJ will build a temporary directory in the current directory and
  139.      extract the archive(s) to this directory.  REARJ will then build the
  140.      target archive(s) with the files in this directory.  If the target
  141.      archiver does not support reading of hidden or system files, REARJ
  142.      will reset those bits and then re-archive the files without those
  143.      attributes.  If the original archive has directories in it, REARJ will
  144.      extract it with full paths and re-archive it with full paths if the
  145.      target archiver supports directories.  In this case, if the archiver
  146.      does not support directories, REARJ will skip converting this archive.
  147.  
  148.      If the "/a" option has been selected, REARJ will execute REARJ to
  149.      convert any internal archives of the same type to the target format.
  150.      Any "/s" option will be carried over to the recursive REARJ command.
  151.  
  152.      As an extra test, REARJ will count the files extracted from the
  153.      original archive and total their sizes.  Then REARJ will extract the
  154.      new archive and count the files and total the sizes.  If the count and
  155.      size do not match, REARJ will skip converting the archive.
  156.  
  157.      REARJ assumes that the supported archivers will pass a non-zero error
  158.      code when there is an operation failure.
  159.  
  160.  
  161.      COMMAND SYNTAX:
  162.  
  163.      REARJ [switch options] filespec(s) or wildspec(s)
  164.  
  165.      You can specify one or more filespecs on the command line.  These
  166.      filespecs can have paths and wildcards.  Up to 100 filespecs can be
  167.      accepted by REARJ.  If you specify *.* as a wildspec, REARJ will look
  168.      at all filenames, but will skip those filenames not ending in standard
  169.      archive suffixes.  If you specify the /r switch, REARJ will look for
  170.      filenames matching the filespec(s) in the current directory and all
  171.      subdirectories of the current directory.
  172.  
  173.      The switch options and filespecs can be entered in any order.  REARJ
  174.      uses the default MS-DOS switch character "/".  REARJ uses the Turbo
  175.      C++ function getswitchar() to determine the MS-DOS switch character.
  176.      If the switch character is "-", REARJ will translate any UNIX style
  177.      pathnames to MS-DOS syntax ("dir/file" to "dir\file").
  178.  
  179.  
  180.      SWITCH OPTIONS:
  181.  
  182.      /a - convert archives within archives
  183.  
  184.           This option causes REARJ to recursively execute REARJ to convert
  185.           any archives of the original type found within the original
  186.           archive (ex. ZIPs within a ZIP).  This option requires additional
  187.           memory to execute successfully.
  188.  
  189.           You may specify the type of internal archive to convert with the
  190.           "/a" option.
  191.  
  192.           Examples:  REARJ *.zip /aLZH  convert only internal LZH archives.
  193.                      REARJ *.zip /a*    convert any internal archive.
  194.  
  195.           If you use the "/a*" option, you may need to also specify "/u"
  196.           because of nested archives of the target type.
  197.  
  198.      /b - execute command before extracting files
  199.  
  200.           This option is used to specify a DOS command to be executed before
  201.           extracting the original archive.
  202.  
  203.           In addition, REARJ passes the name of the original archive to
  204.           this command as a command line argument when executing it.  This
  205.           may cause a problem with DOS commands that expect no arguments.
  206.           A workaround would be to install the DOS command in a batch file.
  207.  
  208.           This feature is to allow the user to prep the environment before
  209.           extracting the archive.  This can be used to prep for archive
  210.           comments or volume labels, etc.
  211.  
  212.      /c - execute command on extracted files before counting them
  213.  
  214.           This option is used to specify a DOS command to be executed upon
  215.           the extracted files before REARJ counts them for later
  216.           verification.  This is to allow executing a DOS or batch command
  217.           to clean up the extracted files (remove BBS advertisements, etc).
  218.           REARJ does not check for any returned error code from the
  219.           executed command.
  220.  
  221.           In addition, REARJ passes the name of the original archive to
  222.           this command as a command line argument when executing it.  This
  223.           may cause a problem with DOS commands that expect no arguments.
  224.           A workaround would be to install the DOS command in a batch file.
  225.  
  226.      /d - delete the original archive
  227.  
  228.           This option causes REARJ to delete the original archive after a
  229.           successful conversion to the target format.  This option will NOT
  230.           delete read-only archives.
  231.  
  232.      /e - do not return error if no archives were found
  233.  
  234.           This option is used by the internal recursive REARJ.  This option
  235.           will cause REARJ to return a zero exit code if no matching
  236.           archives were found.  Usually, REARJ returns a non-zero exit
  237.           code for this condition.
  238.  
  239.      /f - convert diskette archives
  240.  
  241.           This option is used to facilitate the conversion of archives on a
  242.           diskette.  If you do not have sufficient space on the diskette to
  243.           keep the original archives, you MUST specify the "/d" option as
  244.           in "REARJ A:*.zip /f /d".
  245.  
  246.           This option causes REARJ to build the target archive in the
  247.           CURRENT directory (not the working temporary directory).  After
  248.           verification, REARJ will, if specified, delete the original
  249.           archive and then copy the new archive to the diskette.  You
  250.           should make sure that the current directory does not contain any
  251.           archives before executing REARJ.
  252.  
  253.      /i - check program integrity
  254.  
  255.           This option causes REARJ to validate the REARJ program on disk.
  256.           If you are using a pre-3.0 MS-DOS revision, you will have to
  257.           specify the full program name as in "REARJ /i\util\rearj.exe".
  258.  
  259.      /l - write conversion data to log file
  260.  
  261.           This option causes REARJ to open a log file and record each
  262.           successful conversion in the log file.  The default log filename
  263.           is REARJ.LOG.  You can specify the log filename as in
  264.           "REARJ /lfilename *.ZIP".  If the log file already exists, REARJ
  265.           will append logging data to it.
  266.  
  267.      /o - overwrite existing target archive
  268.  
  269.           This switch is used to delete already existing target archives.
  270.           This is not used for updating archives.  Use the /u option for
  271.           updating an archive.
  272.  
  273.      /p - ignore long filenames under Windows 95
  274.  
  275.           This switch is used to disable long filename handling under
  276.           Windows 95.  By default under Windows 95, REARJ will access all
  277.           filenames and directories by their Windows 95 long filename
  278.           equivalents.  This switch is needed under Windows 95 when using
  279.           archivers that cannot handle Windows 95 long filenames such as
  280.           PKZIP 2.04 (DOS version), LHA 2, ARC, and RAR 1.
  281.  
  282.      /q - query for each archive to convert
  283.  
  284.           This switch causes REARJ to pause and prompt the user for
  285.           permission to convert individual archives.  Note that REARJ will
  286.           not prompt when skipping archives.
  287.  
  288.      /r - recurse through subdirectories
  289.  
  290.           This switch causes REARJ to look for archives in all included
  291.           subdirectories as well as in the current directory.  This switch
  292.           allows the user to convert all archives on a hard disk with one
  293.           command.
  294.  
  295.      /s - skip verify of file count and total size
  296.  
  297.           Skip the overhead of the file count and total size verification
  298.           process.  This verification costs an extra extraction, but this
  299.           check is worth the time, especially when converting a large
  300.           number of archives.
  301.  
  302.      /t - specify the target archive type
  303.  
  304.           The default target archive format is normally ARJ.  This can be
  305.           changed by building an external REARJ.CFG file.  The first
  306.           archive type is always the default format.  To override the
  307.           default format, the user can specify the /t switch as in
  308.           "REARJ *.ZIP /tlzh".  The previous example has specified that LZH
  309.           is the target format.
  310.  
  311.      /u - allow update of archive with backup
  312.  
  313.           This switch is used to re-archive an archive, possibly to take
  314.           advantage of improved compression.  The original archive is
  315.           backed up by renaming it with the backup suffix which by default
  316.           is "BAK".  You may specify another backup suffix with the /u
  317.           option as in "REARJ *.ARJ /uar$" where the backup suffix is
  318.           "ar$".  Since this option creates a brand new archive, archive
  319.           comments will be lost.  Do NOT specify a "." in the suffix.
  320.  
  321.      /v - execute configured command on extracted files
  322.  
  323.           This switch is used to execute a configure command on the files
  324.           extracted from the original archive.  The intent is to allow
  325.           virus scanning of the archive contents.  The command must be
  326.           specified in the REARJ.CFG file.
  327.  
  328.           The command may be placed in the REARJ.CFG file by inserting one
  329.           line ahead of the archive commands.  The line must start with the
  330.           word "VIRUS" followed by a blank and the external command.
  331.  
  332.           Example:  VIRUS scan /nomem *.*
  333.  
  334.           If the invoked command returns a non-zero error code, REARJ will
  335.           skip the conversion of that archive and log the error as code 13.
  336.  
  337.           REARJ *.* /v
  338.  
  339.      /w - set working directory
  340.  
  341.           By default, REARJ creates a temporary working directory in the
  342.           current directory.  This option allows you to specify the working
  343.           directory.  The working directory must be EMPTY when invoking
  344.           REARJ.  This directory is used to hold the extracted files.
  345.           This is NOT considered the current directory for /f use.
  346.  
  347.           Example:  REARJ *.* /wd:\
  348.  
  349.           This option helps solve the absolute pathname extraction problem
  350.           that some archivers have.  If you set the working directory to an
  351.           empty root directory, the archiver can extract to the root and
  352.           REARJ will be able to find all of the files to re-archive them.
  353.           However, this option will NOT work for internal archives that
  354.           extract to absolute paths.
  355.  
  356.      /x - exclude filenames or wildnames from the conversion process
  357.  
  358.           You can exclude one or more files from the conversion process.
  359.           The filenames can contain wildcards.
  360.  
  361.           REARJ *.ZIP /xONE.ZIP /xTWO.ZIP
  362.  
  363.      /z - simulate conversion process
  364.  
  365.           This switch causes REARJ to simulate the conversion process.  No
  366.           archives will be extracted, built, or deleted.
  367.  
  368.  
  369.      EXAMPLES:
  370.  
  371.      REARJ *.ZIP                   this converts all ZIP files in the current
  372.                                    directory to ARJ files.
  373.  
  374.      REARJ *.ZIP *.ARC             this converts ZIP and ARC files to ARJ
  375.                                    files.
  376.  
  377.      REARJ SOFT.ZIP                this converts only SOFT.ZIP to SOFT.ARJ.
  378.  
  379.      REARJ A:*.ZIP /f /d           convert ZIPs on A drive with deletion of
  380.                                    each original archive upon successful
  381.                                    conversion.
  382.  
  383.      REARJ *.ARC /r                this converts all ARC files in the current
  384.                                    directory and in subdirectories of the
  385.                                    current directory to ARJ files.
  386.  
  387.      REARJ SOFT.ARJ /tZIP          this converts SOFT.ARJ to SOFT.ZIP.
  388.  
  389.      REARJ *.ARJ /u                re-archive all ARJ archives.
  390.  
  391.      REARJ *.* /v /wd:\            re-archive all archives and execute
  392.                                    configured command on extracted files
  393.                                    using d:\ as the temp directory.
  394.  
  395.  
  396.      EXTERNAL CONFIGURATION FILE
  397.  
  398.      REARJ comes with a configuration file, REARJ.CFG, which supports
  399.      conversion between the ARJ, ARC, LZH, PAK, ZIP, DWC, LZS, HYP, and ZOO
  400.      formats.  The commands PKPAK and PKUNPAK are used for ARC files.  The
  401.      command LHA is used for LZH files.  You can change these defaults by
  402.      editing the configuration file.
  403.  
  404.      The format of the configuration file is fairly simple.
  405.  
  406.      The first line can optionally specify an external command to be
  407.      executed by REARJ when the "/v" option is selected.  This line must
  408.      start with the word "VIRUS" minus the quotes, followed by a space,
  409.      followed by the external command.  The external command MUST contain
  410.      a fully specified pathname for security reasons. 
  411.  
  412.      Example:  VIRUS C:\BIN\SCAN /nomem *.*
  413.  
  414.      If you do not want to configure this item, DO NOT insert a blank line.
  415.      Just leave it out.
  416.  
  417.      Each archive format requires four lines in the file.
  418.  
  419.      The first line is the format suffix.
  420.  
  421.      The second line is the archive ADD command with a %s in the place of
  422.      the archive name.  Any other percent signs in the command must be
  423.      preceded by "\" as in "\%".  The ADD command should support directory
  424.      inclusion and reading of hidden and/or system files.  REARJ will parse
  425.      this command line using the space character as the token separator.
  426.  
  427.      If you expect to handle Windows 95 long filenames with embedded
  428.      blanks, you must enclosed the %s in quote marks as in "%s".
  429.  
  430.      If your ADD command requires DOS piping as the ZOO archiver requires,
  431.      you must precede the ADD command with the text "COMMAND /C ".
  432.  
  433.      Example:  ARJ a -a -r -jt %s
  434.                COMMAND /C STUFF *.* | ZOO aI %s
  435.  
  436.      The third line is the archive EXTRACT command with a %s in the
  437.      place of the archive name.  Any other percent signs in the command
  438.      must be preceded by "\" as in "\%".  The EXTRACT command should
  439.      support directory recreation if the archive contains directories.
  440.      The extraction of directories must be to child directories within the
  441.      current directory.  REARJ will parse this command line using the space
  442.      character as the token separator.
  443.  
  444.      If your EXTRACT command requires DOS piping, you must precede the
  445.      EXTRACT command with the text "COMMAND /C ".  Beware that command exit
  446.      codes are not passed back to REARJ when using COMMAND /C.
  447.  
  448.      The fourth line contains the letters "A" and/or "D" or no letters.
  449.      The "A" stands for the ability to process files with the hidden and/or
  450.      system attribute.  The "D" stands for full support of directory trees
  451.      within archives.  No letters (blank line) stands for no support for
  452.      hidden or system files or for archive containing directories.
  453.  
  454.      There must be NO EXTRA blank lines or comments in the file.  You may
  455.      use leading blanks for clarity.
  456.  
  457.      See the supplied REARJ.CFG for the current configuration.
  458.  
  459.      If you use a different archiver program, you will need to either
  460.      rename the program to one of the supported ones or you will need to
  461.      modify the installed REARJ.CFG file.
  462.  
  463.      If your original archive format supports extraction to absolute
  464.      directory paths as opposed to relative directory paths and you have
  465.      such archives containing absolute paths, you should not put directory
  466.      extraction in the REARJ.CFG file unless you use the /w option to set
  467.      the working directory to an empty root directory.
  468.  
  469.      You can add comment handling to the ARJ command by adding the
  470.      "-zcomment.txt" option.  This is supported at ARJ 2.20 and above.
  471.  
  472.  
  473.      LOG FILE DATA
  474.  
  475.      When logging is enabled, REARJ will log the action on each selected
  476.      file.  For successful conversions, REARJ logs the date-time, target
  477.      archive type, original archive size, new archive size, bytes saved,
  478.      and original archive name.
  479.  
  480.      When selected files are skipped for any reason, REARJ will log an
  481.      entry in the log file (when logging is enabled) which specifies the
  482.      reason code for skipping the file.  The following are the codes:
  483.  
  484.      1  = File not found
  485.      2  = File is not a configured archive type
  486.      3  = Target archive already exists
  487.      4  = Not enough disk space
  488.      5  = User skipped or user did not select update option
  489.      6  = UNPACK error
  490.      7  = PACK error
  491.      8  = Target cannot support directories
  492.      9  = Wrong file count
  493.      10 = Wrong total size
  494.      11 = Internal archive REARJ error
  495.      12 = Rename archive error
  496.      13 = Invoked /v command error (found a virus?)
  497.  
  498.  
  499.      LICENSE POLICY:
  500.  
  501.      For personal (not at the office) use, the shareware version of
  502.      REARJ may be freely used only by ARJ users.  An ARJ user is one who
  503.      uses ARJ on a regular basis.  Others who wish to use REARJ must
  504.      purchase a registration or site license for the ARJ package.
  505.  
  506.      Please refer to the LICENSE.TXT for more license information.
  507.  
  508.  
  509.      TECHNICAL SUPPORT:
  510.  
  511.      Please report any bugs.  We will try to fix them.  See ARJ.TXT for
  512.      details on how to contact us.
  513.  
  514.  
  515.      HISTORY:
  516.  
  517.      2.43 - Fixed work directory handling with RAM disks.
  518.      
  519.      2.41 - Merged source code to simplify support issues.
  520.             Fixed REARJ32 Win32 processing.
  521.  
  522.      2.29 - Added functionality to better support Win32 in REARJ32.
  523.  
  524.      2.27 - Fixed deletion of archives under Windows 95.
  525.  
  526.      2.26 - Added Windows 95 long filename handling and /p option.
  527.  
  528.      2.25 - Added pathname requirement for VIRUS configuration option.
  529.  
  530.      2.24 - Fixed /f /d /u processing when updating an archive.
  531.  
  532.      2.23 - Fixed /z processing with /f option.
  533.             Added -jg+ to ARJ in REARJ.CFG
  534.  
  535.  
  536.      end of document
  537.  
  538.