home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / COMPRESS / RV230.ZIP / RV.DOC < prev    next >
Encoding:
Text File  |  1990-03-06  |  14.6 KB  |  333 lines
  1.                         March 6, 1990
  2.  
  3.  
  4. RView 2.30 - Directory lister & utility for ARC LZH LZS PAK ZIP ZOO.  This
  5. version has been rewritten in C from scratch.  New features:  An in-memory
  6. sort is performed before listing archives.  Filenames are now positioned on
  7. the left.  Redirection to printer or file results in more legible output.
  8. The syntax for /C has been extended to include the pathname of a file
  9. containing comments to be attached to ZIP files.  The /T option is greatly
  10. expanded.
  11.  
  12. Contents:
  13. =========
  14. Disclaimer
  15. Purpose
  16. Displayed data
  17. Commands
  18. Other programs
  19. Closing remarks
  20.  
  21. Disclaimer:
  22. ===========
  23. I have tried my best to make RV well-behaved and have included what I
  24. believe to be reasonable checks into the program.  However, it is the
  25. user's responsibility to read and understand the documentation and take any
  26. necessary precautions, including backups, if irreplacable files are
  27. accessible during RV's operation.  It is possible that files may be
  28. modified by RV's doing something other than you expect.
  29.  
  30. RV and this documentation are offered as is.  Neither I, nor anyone else
  31. distributing this software, should be held liable for the software not
  32. performing as you expect.
  33.  
  34. Purpose:
  35. ========
  36. To provide a single program capable of displaying the directories of
  37. archives of the more popular formats.  The filename extension is ignored
  38. for purposes of determining the archive type, e.g. a ZIP file with the .LZH
  39. extension is acceptable.
  40.  
  41. Also an attempt has been made to include in this one utility various
  42. features that weren't conveniently provided elsewhere at the time of their
  43. inclusion in RV.
  44.  
  45. RV is a free program.  You may use it or give it away as you like.  Please
  46. include this DOC file if you do pass it along.
  47.  
  48. Displayed data:
  49. ===============
  50. This program displays percentages indicating degrees of compression using
  51. the following formula:
  52.  
  53.              100 - ( CompressedSize / OriginalSize * 100 )
  54.  
  55. Thus, the larger the number, the more disk space saved by compressing.
  56.  
  57. If an archive is determined to be self-extracting, then the letters "SFX"
  58. follow the name of the base archive type.  The program also distinguishes
  59. between small- and large-model LZH self-extracting archives.
  60.  
  61. The program displays a report of the total amount of disk space needed to
  62. extract listed members of an archive to an optionally specified drive.  If
  63. no drive is specified, the current drive is used.  In computing the
  64. required disk space, the actual disk cluster size of the source or selected
  65. disk is used.  The program also reports whether or not there is enough disk
  66. space for the extraction.
  67.  
  68. The date and time indicated on the "Totals" line for the default mode when
  69. viewing an archive represent the date and time of the most recently created
  70. or modified member of each archive.  These are the values used by the /R
  71. switch in resetting the archive date and time.
  72.  
  73. After displaying the contents of SFX files, RV displays the size of the SFX
  74. header in bytes.
  75.  
  76. Commands:
  77. =========
  78. Usage:  RV [switches] archive_name [d:] [member_name...]
  79.  
  80. Switches: /W        Wide display
  81.           /T        Technical display
  82.           /B        Brief filenames, without path
  83.           /P        Pause display when screen fills
  84.           /N        Natural order listing
  85.           /R        Reset date and time of archive
  86.           /D        Directory sort of ZIP file
  87.           /L        Lax checking
  88.           /S        Subdirectory search
  89.           /O        Old-format ZIP selection
  90.           /U[path]  Un-SFX self-extracting archive
  91.           /C[file]  Strip/Add ZIP file comment
  92.           /X        Strip extra bytes from end of archive
  93.           /A        Strip all - same as /U /C /X
  94.  
  95. Switches may appear in almost any position on the command line.  The
  96. character '-' may be used in place of '/' wherever DOS will allow.
  97.  
  98. Examples:       RV /t backup.exe /p *.zip
  99.                 RV/w bigfile.lzh
  100.                 RV /b/t/p recurse.dir
  101.                 RV *.* -w-p
  102.                 RV /w/u self.exe
  103.  
  104. In the command format above, 'archive_name' may optionally include a drive
  105. and/or path designation.  An 'archive_name' specified without an extension
  106. will result in a search for all extensions.  Thus typing "RV filename" is
  107. equivalent to "RV filename.*".  Furthermore, typing "RV *" is equivalent to
  108. "RV *.*", and will result in a search through all files in the current
  109. directory.
  110.  
  111. If you wish to search for selected members within an archive, specify the
  112. members to search for after the archive name.
  113.  
  114. Example:        RV source.zip *.h *.c
  115.  
  116. Result:         Causes RV to search within source.zip for C header and
  117.                 source files.
  118.                 
  119. You may specify an optional drive immediately after the archive name to
  120. have the program check for extraction sizes to the indicated drive.
  121.  
  122. Example:        RV backup.lzh a: *.dbf
  123.  
  124. Result:         Causes RV to display the .DBF members of BACKUP.LZH and
  125.                 compute extraction sizes for drive A:.
  126.  
  127. Use the /W switch to list the names only of files included in an archive.
  128. Names are displayed up to five per line.
  129.  
  130. Use the /T switch to get detailed technical information about each file
  131. contained in the archive.
  132.  
  133. Use the /B switch if the archive being listed includes pathnames and you
  134. wish to focus on just the filenames.  This option has no effect when used
  135. with the /W switch, as the Wide option does not include pathnames by
  136. default.
  137.  
  138. Use the /P switch to pause the display after each screenful of information.
  139. After pausing, the program will prompt for a key press.  Pressing <Esc> at
  140. this point will terminate the program.  Any other key will display another
  141. screenful of output, with an overlap of one line, provided there is enough
  142. output to fill another screen.
  143.  
  144. Use the /N switch if you prefer to list archives in the order they are
  145. stored on disk.  If you want this to be the default mode, place the /N
  146. switch in RV.CFG (described below).
  147.  
  148. The /R option sets the date and time of the archive to match the date and
  149. time of the most recently created or modified file contained in the
  150. archive.
  151.  
  152. Use the /D switch to perform a Directory sort of a ZIP file.  This feature
  153. was added by user request.  Wildcards may be used to select multiple files
  154. for sorting.  During the sort, a temporary work file is created on disk.
  155. If you do not have enough free disk space to contain a second copy of the
  156. ZIP file, the sort won't take place.  RV doesn't attempt to sort an already
  157. sorted ZIP file.  Using this option is faster than extracting the contents
  158. of a ZIP file, sorting the directory entries, and then rezipping the files
  159. up again.  Also, ZIP file comments and pathnames can be preserved this way,
  160. if you wish to keep them.  The sorted file will have the same date and time
  161. as the unsorted file.
  162.  
  163. The /L option has been added by user request.  This Lax option relaxes RV's
  164. otherwise strict checking for reasonable values (e.g. reasonable filesizes,
  165. dates and times, etc.) and may allow unusual or damaged files to be listed.
  166. If RV's default mode isn't able to list what you believe to be an archive,
  167. try using this switch.
  168.  
  169. WARNING:  Use the /L option sparingly, especially when used in conjunction
  170. with other options which actually modify archives.  Strict checking is on
  171. by default for your protection.
  172.  
  173. Beginning with Version 2.20 the /S switch has been added.  Proper use of
  174. the /S switch effectively turns RV into a "file finder" for archives and/or
  175. their included members.
  176.  
  177. Example:        RV /s *.zip address.dbf
  178.  
  179. Result:         RV searches all .ZIP files in the current directory, and
  180.                 all directories below the current one, for any file(s)
  181.         named ADDRESS.DBF.
  182.  
  183. Example:        RV /s * lh* pk*
  184.  
  185. Result:        Searches all files in the current directory, and all
  186.         included subdirectories, for any archives containing files
  187.         matching LH*.* or PK*.*.
  188.  
  189. Example:        RV * lh* pk*
  190.  
  191. Result:        Same as for the previous example, except that the search is
  192.         limited to the current directory only.
  193.  
  194. Example:        RV \123\data\*.arc budget.wk1 /s
  195.  
  196. Result:        Searches directory \123\DATA, and any directories below it,
  197.         through all files with the .ARC extension for any archived
  198.         members with the name BUDGET.WK1.
  199.  
  200. Example:        RV d:\* unique. /s
  201.  
  202. Result:        Searches through all files on drive D: for archives
  203.         containing the filename "UNIQUE" (no extension).
  204.  
  205. Example:        RV \* /s
  206.  
  207. Result:        This will search for and list archives found throughout the
  208.         entire current drive.  After all the found archives have
  209.         been listed, the program will report on the total number of
  210.         files searched and the number of archives found.
  211.  
  212. Use the /O switch to limit your search to ZIP files using old-style ZIP
  213. compression methods (Reduce1, Reduce2, Reduce3 and Reduce4).  This is a
  214. relatively less permanent option than the others and it is anticipated
  215. that, after an indeterminate period of time, this switch will be
  216. discontinued.  This feature was added by user request for BBS work.
  217.  
  218. Qualification:  It is _possible_ for pre-ZIP 1.01 type ZIP archives not to
  219. contain any files compressed with Reduce-type methods.  However, it is
  220. believed that any such files missed by RV's search for obsolete types will
  221. be minimal.
  222.  
  223. Used in combination with the /S switch, you can use the /O switch to find
  224. all the ZIP archives on your hard disk containing these obsolete
  225. compression types.
  226.  
  227. Example:    RV \* /o /s
  228.  
  229. Result:        RV will start at the root directory of the current disk and
  230.         search _all_ files in all directories for ZIP archives
  231.         containing members compressed with obsolete methods.
  232.  
  233. Example:    RV D:\DOWNLOAD\*.ZIP /o /s /w
  234.  
  235. Result:        This will narrow the search to files on drive D:, in the
  236.         DOWNLOAD directory and also any directories below that, for
  237.         files with just the .ZIP extension (.EXE files will not be
  238.         searched), and will list the pertinent members in wide
  239.         format.
  240.  
  241. Use the /U switch to convert a self-extracting (SFX) archive to a normal
  242. archive.  This option is included as a faster alternative to extracting the
  243. contents from an SFX file and re-archiving them to form a regular archive.
  244. A new file will be created with the same name as the SFX file but with the
  245. appropriate extension (.ARC, .LZH, .LZS, .PAK, .ZIP, .ZOO), provided a file
  246. with the same name doesn't already exist.  If such a file already exists,
  247. you are prompted whether to overwrite it or not.  The reconstructed archive
  248. will have the same date and time as the SFX file.
  249.  
  250. Starting with version 1.20, the syntax for the /U switch has been extended
  251. to allow specification of a target drive/directory.  If /U is specified
  252. alone, then the /Un-SFXed file will be written to the current directory.
  253. If you wish to select a different target directory, specify the desired
  254. drive and/or path immediately following /U (no intervening spaces allowed).
  255. Even if you use the /A switch, as described below, you must still use the
  256. /U switch if you wish to write to a target directory different from the
  257. current one.
  258.  
  259. Use the /C switch with no arguments to strip ZIP file comments from ZIP
  260. files.  If there are no comments, or if the archive is not a ZIP file, this
  261. switch has no effect.  If a comment is found, this option will also strip
  262. any extra bytes found at the end of the file.  If a valid pathname is
  263. specified immediately after "/C" (no intervening spaces allowed), then
  264. comments contained in that file will be attached to any ZIP files specified
  265. on the command line.  The date and time before modification will be
  266. preserved.
  267.  
  268. Use the /X switch to strip 'eXtra' or 'eXcess' bytes from the ends of LZH
  269. and ZIP archives, often resulting from XMODEM-type file transfer protocols.
  270. This will truncate the archive to reflect its "true" size.  The date and
  271. time before modification will be preserved.
  272.  
  273. WARNING:  Whereas the /U switch creates a new file by copying, both the /C
  274. and /X switches actually modify the original archive itself.  The /D option
  275. for ZIP files also leaves only a single modified copy after a successful
  276. sort.  As a security measure, you may wish to retain a backup copy of any
  277. file on which you wish to use these switches, until you are sure that the
  278. resulting changes are what you want.
  279.  
  280. Using the /A switch is equivalent to specifying /U /C /X.  The program
  281. first strips any extra bytes from LZH and ZIP files, then strips ZIP file
  282. comments, if applicable.  If the file is a self-extracting archive, RV then
  283. creates a new file that is stripped of all extra trappings.  See the
  284. warning above on using the /C and /X switches, as the original file will be
  285. modified as indicated above.
  286.  
  287. Typing just the program name alone will display a simple help screen.
  288.  
  289. Beginning with Version 2.00, you may create a "free-form" configuration
  290. (.CFG) file containing your choice of default switches.  This .CFG file
  291. should be named RV.CFG and may be created or edited with any editor or word
  292. processor which can handle pure ASCII text files.  The format is
  293. "free-form" in the sense that you may include comments in the .CFG file,
  294. for example.  Be aware that only the first 1024 characters of RV.CFG are
  295. significant, and that you should avoid the use of the '/' and '-'
  296. characters in your comments, as these may be interpreted as switches.  A
  297. sample .CFG file is included in the distribution archive for RV.
  298.  
  299. RV will search for the RV.CFG first in the current directory.  If it is not
  300. found there, then the directories on your PATH are searched.  Switches used
  301. on the command line will override switches included in RV.CFG.
  302.  
  303. Closing remarks:
  304. ================
  305. Although I make my free programs available to anyone who wants to use them,
  306. please be aware that these programs are really written and updated for two
  307. groups of people:  1) myself, because I am also a user, and 2) those who
  308. have used my programs, found any of them of value, and _communicates_ their
  309. comments and suggestions to me.
  310.  
  311. As a corollary to this, if you find some value to any of my free programs,
  312. but feel that certain features are awkward or lacking, and you _don't_
  313. communicate this to me, you have only yourself to blame.
  314.  
  315. Another way of looking at this is:  Since I receive no monetary
  316. compensation from my "freeware", a short note from you, either by mail or
  317. electronically, qualifies as your "registration fee" for using my programs.
  318.  
  319. You may contact me at the addresses below:
  320.  
  321.  
  322.                 By conventional mail:
  323.                 ---------------------
  324.                 Raymond T. Kaya
  325.                 P. O. Box 1436
  326.                 Honolulu, HI  96806
  327.  
  328.  
  329.                 By electronic mail:
  330.                 -------------------
  331.                 CompuServe:  71230,2500
  332.                 GEnie:       R.KAYA1
  333.