home *** CD-ROM | disk | FTP | other *** search
/ Lion Share / lionsharecd.iso / utils_mz / rvs100.zip / RVS.DOC < prev    next >
Text File  |  1992-06-27  |  10KB  |  233 lines

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