home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / archiver / rvs101.arj / RVS.DOC < prev    next >
Encoding:
Text File  |  1992-07-21  |  9.4 KB  |  240 lines
  1. RVS-RView Shell, Version 1.01                          21-Jul-92
  2.  
  3.  
  4. Shell for listing and viewing the contents of several archive types. 
  5. Employs external extractors and an external viewer (all user-selectable) to
  6. extract and view compressed files from within the program.  Currently
  7. supported are ARC, ARJ, LZH, LZS, PAK, ZIP and ZOO.  Displays either ZIP- or
  8. LZH-style compression ratios.  Various sort options.
  9.  
  10. Contents:
  11. =========
  12. Purpose
  13. Display
  14. Syntax
  15. Switches
  16. Configuration
  17. Commands
  18. Troubleshooting
  19.  
  20. Purpose:
  21. ========
  22. I've never been a fan of any of the existing archive shells.  No criticism
  23. intended, simply a matter of taste.  On the other hand, there are times when
  24. I find my own command-line RView program (RV) inappropriate.  Thus, I
  25. designed RVS to complement my use of RV, and to work the way I want it to. 
  26. My preferences probably don't even remotely resemble those of the
  27. mainstream, so I don't expect RVS to become a mainstream archive shell. 
  28. It's a program which I find useful, and I offer it to others who may want to
  29. share its use with me.
  30.  
  31. As with RV, filename extensions are ignored in determining archive types.
  32.  
  33. RVS is a free program.
  34.  
  35. Display:
  36. ========
  37. The program displays either in color or "black-and-white" based on the video
  38. mode at program start-up.  However, if the user has a color graphics card,
  39. but no color monitor, the display may be improved by using the DOS command
  40. "MODE BW80".  Conversely, color mode may be forced on by using "MODE CO80".
  41.  
  42. A command-line switch is also available to force black-and-white mode (see
  43. "Switches").
  44.  
  45. EGA/43- and VGA/50-line modes are supported.  At program start-up, an
  46. attempt is made to detect the actual number of lines on the screen, up to a
  47. maximum of 50, and to adjust the display accordingly.
  48.  
  49. Refer to RV.DOC, distributed with the current release of RV, for a
  50. discussion of RV's display (similar to that of RVS).
  51.  
  52. Syntax:
  53. =======
  54.  
  55.         Usage:  RVS [switches] [filespec]
  56.  
  57. If no extension is specified for "filespec", ".*" is assumed.  If a valid
  58. filename is specified unambiguously, the file is immediately displayed. 
  59. Either specifying "filespec" using wildcards, or specifying a drive or
  60. directory name causes a scrollable directory window to pop up.  Simply
  61. typing the program name is the same as specifying "*.*".
  62.  
  63.         Examples:       RVS C:          <- current directory of drive C:
  64.                         RVS D:\         <- root of drive D:
  65.                         RVS \PCPLUS\DL  <- DL subdirectory of \PCPLUS
  66.  
  67. Switches:
  68. =========
  69.  
  70. /A        Alternate compression ratio.  ZIP-style compression ratios are
  71.           displayed by default.  Use this switch to display LZH-style
  72.           ratios.  (Tip:  Include this switch in RVS.CFG to always display
  73.           LZH-style ratios.)
  74.  
  75. /BW       Black-and-White mode.  Provided as an alternative to using DOS's
  76.           "MODE BW80" command.
  77.  
  78. /Fx       Where 'x' represents 0/1/2/3, as follows:
  79.  
  80.           F0 - don't filter (fastest/default)
  81.           F1 - check only for normal archive extensions
  82.           F2 - same as F1, but do a thorough check of .COM and .EXE files
  83.           F3 - check all files for valid archives (slowest)
  84.  
  85. /O[path]  Output path for extractions ("out_path").  For use in conjunction
  86.           with the "%o" format specifier (see "Configuration").  If no path
  87.           is specified, the current directory is used.  Also specifies which
  88.           directory to use for temporary extractions when viewing, if /T is
  89.           not used.
  90.  
  91. /Sx[-]    Where 'x' represents N/E/D/O/P/R/U, as follows:
  92.  
  93.           SN - Sort by Name (default)
  94.           SE - Sort by Extension
  95.           SD - Sort by Date/time
  96.           SO - Sort by Original size
  97.           SP - Sort by Packed size
  98.           SR - Sort by compression Ratio
  99.           SU - leave Unsorted
  100.  
  101.           Appending a hyphen '-' to the above switches will reverse the
  102.           sense of the sort from ascending to descending.
  103.  
  104. /T[path]  Temporary extraction path for viewing ("temp_path").  For use in
  105.           conjunction with the "%o" format specifier (see "Configuration"). 
  106.           This could point to a RAM-disk, for instance.  This overrides the
  107.           directory implied by the "/O" switch when viewing.
  108.  
  109. Tip:  When using the /O or /T switch, it might be better to end each "path"
  110. designation with a backslash, '\'.  Note that, if "C:\TEMP" is the name of
  111. your temporary extraction directory, "PKUNZIP archive.zip D:\temp" will work
  112. but "LHA e archive.lzh D:\temp" will not.  For LHA, the trailing backslash
  113. is mandatory.
  114.  
  115. Either '/' or '-' may be used to specify switches.
  116.  
  117. Entering an invalid switch causes the program to display a brief help screen
  118. then exit.
  119.  
  120.         Examples:       RVS /h
  121.                         RVS -?
  122.  
  123. Configuration:
  124. ==============
  125. An optional configuration file containing user-selected default switches may
  126. be created or edited with any editor or word processor which can save pure
  127. ASCII text files.  This file should be named "RVS.CFG" and placed in the
  128. same directory from which RVS.EXE will be loaded (DOS 3.0 and above).
  129.  
  130. Switches, including switch options, may be separated by spaces or placed on
  131. separate lines.
  132.  
  133. In addition to specifying "true" switches, RVS.CFG should also contain lines
  134. assigning which command to use for viewing extracted files, and which
  135. commands to use for extracting files from archives.
  136.  
  137. The syntax for specifying the *single* view command is:
  138.  
  139. /V="command"
  140.  
  141. Where:  "command" should be set to the command line, including arguments, of
  142.           the view command you wish to run.
  143.  
  144. "command" should at least include the "%f" format specifier, which
  145. represents the currently highlighted compressed file.
  146.  
  147. Example:        /V="LIST %f"
  148.  
  149. The syntax for specifying the extract commands is:
  150.  
  151. /E<xxx>="command"
  152.  
  153. Where:  <xxx> is "arc", "arj", "lzh", "lzs", "pak", "zip" or "zoo".
  154.         "command" should be set to the command line, including arguments, of
  155.           the extraction command you wish to run for that archive type.
  156.  
  157. "command" would typically include both the "%a" and "%f" format specifiers,
  158. which represent the archive name and selected compressed file, respectively.
  159.  
  160. The "%o" format specifier may also be embedded in extract commands.  It
  161. indicates where in "command" either "out_path" or "temp_path" (see
  162. "Switches") should be inserted when "command" is executed.  Please bear in
  163. mind that some unarchivers may not support redirection of extractions to
  164. different drives or directories.
  165.  
  166.         Examples:       /Earj="ARJ e %a %f"
  167.                         /Elzh="LHA e %a %o %f"
  168.                         /Ezip="PKUNZIP %a %o %f"
  169.  
  170. True switches should be placed on separate lines from those assigning
  171. commands.
  172.  
  173. Incompatible switches used on the command line will override switches
  174. included in RVS.CFG.  Switches are evaluated from left to right.
  175.  
  176. A sample RVS.CFG file is included in the distribution archive for RVS, which
  177. the user may edit to "customize" RVS's behavior.
  178.  
  179. Commands:
  180. =========
  181. While viewing the contents of an archive, the following commands may be
  182. used:
  183.  
  184. Pressing <F1> or the letter 'H' will display a brief help screen summarizing
  185. commonly used commands.  Press any key to close the help window.
  186.  
  187. Pressing <F2> or the letter 'X' will cause the currently selected file(s) to
  188. be eXtracted by the appropriate extraction program specified in RVS.CFG.
  189.  
  190. By "currently selected" is meant either any tagged files, or the currently
  191. highlighted file, if no files are tagged.
  192.  
  193. Files may be tagged either individually or by wildcard selection.  The <Ins>
  194. key may be used as a toggle to select and unselect individual files. 
  195. Pressing <Ins> on an unselected file selects it.  Pressing <Ins> on a
  196. selected file unselects it.  To select a group of files using DOS-type
  197. wildcards, press the plus ('+') key.  This opens up an input window into
  198. which a file specification may be entered.  To unselect a group of files,
  199. press the minus ('-').  This opens up an input window similar to the one for
  200. selection.  The suggested keys are the gray plus and minus keys found near
  201. the numeric keypad of many keyboards.
  202.  
  203. Pressing <F3> or the letter 'V' will cause the currently highlighted file to
  204. be extracted and displayed by the appropriate commands specified in RVS.CFG. 
  205. The extracted file will be erased after exiting the view program.
  206.  
  207. Pressing <F4> or the letter 'T' will toggle the display between the default
  208. listing and one showing full pathnames.  This command is only available for
  209. supported archives types with paths stored.
  210.  
  211. Pressing <F5> or the letter 'O' will allow the user to edit "out_path" on
  212. the fly.  Useful for temporarily overriding the /O switch setting specified
  213. either in RVS.CFG or from the command line.
  214.  
  215. Pressing <Esc>, <F10> or the letter 'Q' will exit the program.
  216.  
  217. Troubleshooting:
  218. ================
  219. This is by no means an exhaustive list, but here are some common problems
  220. and their possible solutions:
  221.  
  222. LHA doesn't recognize either "out_path" or "temp_path":  Make sure your path
  223. specifications for /O and /T end with the backslash, '\'.
  224.  
  225. "Sharing violation" when trying to extract or view an LZH file.  If
  226. possible, try restarting the system without loading SHARE.EXE.  LHA, at
  227. least up to Version 2.13, appears to open files in "Compatibility" mode. 
  228. When both RVS and LHA tries to look at the same file at the same time with
  229. SHARE.EXE loaded, this error results.  If all else fails, use LHA from the
  230. command-line.
  231.  
  232. --
  233.  
  234.                 Raymond T. Kaya
  235.                 P. O. Box 1436
  236.                 Honolulu, HI  96806
  237.  
  238.                 CompuServe:  71230,2500
  239.                 GEnie     :  R.KAYA1
  240.