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