home *** CD-ROM | disk | FTP | other *** search
/ C/C++ 3D Game Tools / C-C++ 3D Game Tools.iso / ziptools / arj / rv250.arj / RV.DOC < prev    next >
Encoding:
Text File  |  1993-03-20  |  8.1 KB  |  204 lines
  1. RV-RView, Version 2.50                                  20-Mar-93
  2.  
  3.  
  4. Customizable archive lister & utility.  Currently supported are ARC, ARJ,
  5. HYP, LZH, LZS, PAK, SQZ, ZIP & ZOO.  Displays ZIP- or LZH-style compression
  6. ratios.  Various sort options.  Converts self-extracting archives back to
  7. normal.  Misc. other features.
  8.  
  9. Contents:
  10. =========
  11. Disclaimer
  12. Purpose of program
  13. Display
  14. Command-line syntax
  15. Valid switches
  16. Configuration file
  17. Keyboard program-pausing
  18.  
  19. Disclaimer:
  20. ===========
  21. This program and the accompanying documentation are offered as is.  This
  22. program may be used to modify external files.  The user bears the entire
  23. risk of this software not performing as expected.
  24.  
  25. Purpose of program:
  26. ===================
  27. To provide a single, stand-alone program capable of listing directories of
  28. several archive formats.  Since filename extensions are ignored in
  29. determining archive types, this program may be used to determine the type of
  30. archive even if the filename extension is missing, or inappropriate.
  31.  
  32. This utility also contains various features not conveniently provided
  33. elsewhere at the time of their inclusion.
  34.  
  35. RView is a free program.
  36.  
  37. Display:
  38. ========
  39. The type of archive is shown before listing each archive.  For
  40. self-extracting archives, the letters "SFX" follow the name of the base
  41. archive type.
  42.  
  43. For ZIP 2.0-type archives, the four different variations for "deflating" are
  44. reported as "Deflate", "DeflateX", "DeflateF" and "DeflateS" for normal,
  45. maXimal, Fast and Super-fast compressions, respectively.
  46.  
  47. The Compression Ratio Percentage ("CR%") displayed by the program is one of
  48. two types:
  49.  
  50.      ZIP-style (default):
  51.      --------------------
  52.      100 - ( PackedSize / OriginalSize * 100 )
  53.  
  54.      LZH-style:
  55.      ----------
  56.      PackedSize / OriginalSize * 100
  57.  
  58. Since ZIP-style is the default, use the /A switch to select LZH-style.
  59.  
  60. The date and time indicated on the "totals" line represent the date and time
  61. of the most recently created or modified member of each archive.  These are
  62. the values used by /R in resetting the archive date and time.
  63.  
  64. RView displays the total number of bytes required to contain the listed
  65. files if extracted to a selected drive.  If no drive is selected, the drive
  66. containing the archive being listed is used.  In making this computation,
  67. RView takes actual disk cluster sizes into account.
  68.  
  69. Command-line syntax:
  70. ====================
  71.  
  72.         Usage:  RV [switches] archive [d:] [file...]
  73.  
  74. Switches may appear in almost any position on the command line.  '-' may be
  75. substituted for '/' wherever DOS allows.
  76.  
  77. An archive name specified without an extension will result in a search for
  78. all extensions.  Thus typing "RV filename" is equivalent to "RV filename.*". 
  79. Also, "RV *" is equivalent to "RV *.*".
  80.  
  81. An optional drive may be included immediately after the archive name to
  82. check for extraction sizes to the indicated drive.
  83.  
  84. Example:        RV backup.lzh a:
  85.  
  86. Result:         Causes RView to compute extraction sizes for drive A:.
  87.  
  88. File specifications following the archive name will limit the listing to
  89. only those files matching any of these specifications.  The /U and /D
  90. switches will be ignored in this case.
  91.  
  92. Example:        RV source.zip *.h *.c
  93.  
  94. Result:         Causes RView to list only C header and source files
  95.                 contained within SOURCE.ZIP.
  96.                 
  97. Valid switches:
  98. ===============
  99. /A        Alternate compression ratio.  ZIP-style compression ratios are
  100.           displayed by default (see above).  Use this switch to display
  101.           LZH-style ratios.  (Tip:  Include this switch in RV.CFG to always
  102.           display LZH-style ratios.)
  103.  
  104. /B        Brief filenames.  Use this switch to suppress the display of full
  105.           pathnames, i.e. only the filename.ext parts of full pathnames will
  106.           be shown.
  107.  
  108. /C[file]  strip/attach zip file Comment.  Strips file comments from ZIP
  109.           files.  If a valid filename immediately follows "/C" (no
  110.           intervening spaces), then comments contained in that file will be
  111.           attached to the specified ZIP file(s).
  112.  
  113. /D        sort lzh and zip files on Disk.  LZH and ZIP files are written
  114.           back to disk in the order implied by the /S family of switches. 
  115.           Nothing is done for already-sorted archives.  Sorting to disk is
  116.           available so that LZH and ZIP files will be displayed in sorted
  117.           order by listers that don't do in-memory sorts.  Also,
  118.           disk-sorting is useful for LZH SFX's when telops ('!' files) are
  119.           used.
  120.  
  121. /E        remove extra spaces before the Extension in filenames.  By
  122.           default, the part of the filename before the extension is padded
  123.           with spaces if less than 8 characters.  Thus "NAME    .EXT"
  124.           becomes "NAME.EXT".
  125.  
  126. /I        Ignore rv.cfg file.  This option was added by user request to
  127.           provide a means of overriding the defaults specified in RV.CFG.
  128.  
  129. /P        Pause display after each screenful.  After pausing, pressing
  130.           almost any key causes another screenful to be displayed.
  131.  
  132. /Q        Quiet (suppress) listing.  Added by user request to speed file
  133.           processing by BBS SysOps.  Primarily intended for use in
  134.           conjunction with other switches which modify archives.
  135.  
  136. /R        Reset date and time of archive.  The date and time used will be
  137.           those of the most recently created or modified file in each
  138.           archive.
  139.  
  140. /Sx[-]    Where 'x' represents N/E/D/O/P/R/U, as follows:
  141.  
  142.           SN - Sort by Name (default)
  143.           SE - Sort by Extension
  144.           SD - Sort by Date/time
  145.           SO - Sort by Original size
  146.           SP - Sort by Packed size
  147.           SR - Sort by compression Ratio
  148.           SU - leave Unsorted
  149.  
  150.           Appending a hyphen '-' to the above switches will reverse the
  151.           sense of the sort from ascending to descending.
  152.  
  153. /U[path]  Un-sfx self-extracting archive.  Converts self-extracting (SFX)
  154.           archives to normal archives.  A new file will be created with the
  155.           same name as the SFX file but with the appropriate extension
  156.           (".ARC", ".LZH", etc.).  The normal archive is written to the
  157.           current directory by default.  "/U" followed immediately by a
  158.           valid path (no intervening spaces) allows writing to the specified
  159.           target drive/directory.
  160.  
  161. /V        enable Verbose mode.  Enables the display of comments and various
  162.           statistics related to the archive as a whole.  
  163.  
  164. /W        Wide display format.  Displays up to five names per line.
  165.  
  166. /X        strip eXtra bytes from end of archive.  XMODEM-type file transfer
  167.           protocols often pad transferred files with added bytes.  This will
  168.           truncate ARJ, LZH, LZS, PAK and ZIP archives to reflect their
  169.           "true" sizes.
  170.  
  171. Configuration file:
  172. ===================
  173. An optional configuration file containing user-selected default switches may
  174. be created or edited with any editor or word processor which can save pure
  175. ASCII text files.  This file should be named "RV.CFG" and placed in the same
  176. directory from which RV.EXE is loaded (DOS 3.0 and above).
  177.  
  178. Switches, including switch options, may either be separated by spaces or
  179. placed on separate lines.
  180.  
  181. Incompatible switches used on the command line will override switches
  182. included in RV.CFG.  Switches are evaluated from left to right on the
  183. command line.
  184.  
  185. A sample RV.CFG file is included in the distribution archive for RView. 
  186. After extracting the contents of the distribution archive, RV.CFG may be
  187. deleted if RView's defaults are satisfactory.
  188.  
  189. Keyboard program-pausing:
  190. =========================
  191. By user request, beginning with Version 2.34, the single-key,
  192. program-pausing feature has been added back.  While RView is displaying an
  193. archive, pressing <Esc> will terminate execution.  Almost any other key will
  194. pause the display.  After pausing, pressing <Esc> will terminate execution. 
  195. Again, almost any other key will resume execution.
  196.  
  197. --
  198.  
  199.                 Raymond T. Kaya
  200.                 P. O. Box 1436
  201.                 Honolulu, HI  96806
  202.  
  203.                 CompuServe:  71230,2500
  204.