home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / wuz131.zip / WUZ.Doc < prev    next >
Text File  |  1994-05-30  |  12KB  |  262 lines
  1. --------------------- Workplace Shell UnZip  version 1.1 ---------------------
  2. --------------------- (c) Copyright 1994 Scott Maxwell. ----------------------
  3. -------------------------- by: scottmax@netcom.com ---------------------------
  4.  
  5.  
  6. If you don't want to read this big file right now, read Readme.WUZ
  7. instead.  You might want to read this later, though.
  8.  
  9.  
  10.  
  11. Welcome to WPS UnZip!
  12.  
  13. Actually, it does more than just unzip.  It can also handle ARC, ARJ, LZH,
  14. TAR, Z and ZOO files.  You need to have unpackers for each format but then
  15. WPS Unzip will handle the rest.  WUZ is already set up to use OS/2 versions
  16. of Zoo 2.1, Info-Zip's Unzip 5.0, UnArj 2.41, LH2 2.14, Gnu Tar and Compress.
  17. It will also auto-detect if you are using PKZip/PKUnZip instead.
  18.  
  19. If you want to use a different dearchiver or add another archive type, you
  20. may have to make some changes to Wuz.Cmd.  See "Adding a New Archive Type" at
  21. the end of this file.  The default dearchiver is UnZip if the file extension
  22. is not recognized.  I use this to drag-and-drop QWK files when I just want to
  23. look at my bulletins.
  24.  
  25. To install, just type INSTALL and select a directory for the executable files
  26. from the menu.  Then enter the name of the directory where you want temporary
  27. directories to be made.  I use E:\Download\Temp.  This will copy all of the
  28. executable and icon files to the specified directory and create an icon on the
  29. desktop called "WPS Unzip" which is associated with *.arc, *.arj, *.lzh, *.tar,
  30. *.z, *.zif, *.zip and *.zoo.  It will also create a second icon for zipping
  31. up whole directories in place called "Zip Directory".  To uninstall, simply
  32. rerun INSTALL and select uninstall from the menu.
  33.  
  34. Now all of your archive files should have a cool zipper icon.  If you don't
  35. see the zipper right away, try clicking the right button over the file icon
  36. and it should change.
  37.  
  38. You can open an archive in one of three ways:
  39. 1) Double click on the file icon.
  40. 2) Drag the file icon to the WPS Unzip icon
  41. 3) Type WUZ <filename> from a command line
  42. Note: Technique 2 or 3 may be used to extract self-extracting archives (*.EXE)
  43.  
  44. WUZ will then create a directory of the same name as the archive in whatever
  45. directory you told it to during the install, in my case E:\Download\Temp.
  46. After creating the directory, WUZ will extract the archive file into it, open
  47. the directory as a folder on the Desktop and open a separate OS/2 window
  48. set to the new directory.  This will give you easy access from both the WPS
  49. and the command line.  Also, since each archive creates its own extract
  50. directory, you can open as many archives at the same time as you like.
  51. If you are using 4OS2, the command-line window will be opened as local so
  52. it won't use any of your aliases.  WUZ needs to do this so it can create
  53. some custom keyboard aliases.
  54.  
  55. To remove the extracted files and the temporary directory, you can type ZClr.
  56. ZClr -x will close the OS/2 window as well.  If you are using 4OS2, you can
  57. just type Alt-x.
  58.  
  59. If you are using ZIP archives, two other options are available: updating and
  60. refreshing.  ZUPDATE will add any new files you have added to the extract
  61. directory to the original archive and optionally remove any files that you
  62. have deleted.  For instance, rename Try.Cmd to Tried.Cmd and do ZUPDATE and
  63. you will be asked if you want to delete Try.Cmd from the archive.  Then
  64. Tried.Cmd will be added to the archive.  If you are using 4OS2, just hit
  65. Alt-u.  ZFRESH will update only those files that already exist in the
  66. archive and have changed in the extract directory.  Alt-f for 4OS2 users.
  67.  
  68. I don't like seeing ZClr.Cmd, ZFresh.Cmd and ZUpdate.Cmd all the time, so I
  69. have hidden them.  If you want to unhide them so that you can use them
  70. from the WPS, just comment out the lines in Wuz.Cmd that hide them.
  71.  
  72. NOTE: If you double-click on ZClr.Cmd from the WPS while the command-line
  73.       window is still open and in the extract directory, OS/2 will not be
  74.       able to remove the extract directory.
  75.  
  76.  
  77. Zipping Directories in Place
  78. ----------------------------
  79.  
  80. Sometimes I have whole directories I don't really need but I don't really
  81. want to erase either.  The most common example of this is games that I've
  82. finished but still might want to show to friends some time.  For situations
  83. like these, use Zip Directory.
  84.  
  85. You can use Zip Directory in one of two ways:
  86. 1) Open the drive tree from Drives and drag-and-drop the icon of the
  87.    subdirectory you want to zip up onto your "Zip Directory" icon.
  88. 2) Type ZIP-DIR <subdirectory-name> from a command line
  89.  
  90. This will not only move the whole directory into an icon, it will also
  91. change the folder icon into a zipped folder icon.  If you were to open the
  92. folder now, you would find a file called <subdirectory-name>.ZIF.
  93.  
  94. You can unzip this in one of five ways:
  95. 1) Drag the zipped folder icon from your drive tree to "WPS Unzip"
  96. 2) Drag the .ZIF file to "WPS Unzip"
  97. 3) Double click on the .ZIF file
  98. 4) Type WUZ <subdirectory-name> from a command line
  99. 5) Type WUZ <.ZIF filename> from a command line
  100.  
  101. After unzipping the files, WUZ will change the icon from a zipped folder to
  102. an unzipped folder.  If you rezip the directory, Zip Directory will simply
  103. update any files that have changed or been added and remove everything else so
  104. rezipping should be much faster.
  105.  
  106.  
  107. Other Goodies
  108. -------------
  109.  
  110. This archive also includes Open-Dir.Cmd which opens the specified directory
  111. as a folder on the desktop and Kill-Dir.Cmd which deletes the specified
  112. directory and all of its files.  These are pretty useful in their own right.
  113. Open-Dir.Cmd is also installed as OD.Cmd so typing "od subdirectory" will
  114. do it.
  115.  
  116. ZipStrip.Cmd may also be of interest.  It compares the files in the current
  117. directory to those in any ZIP file and offers to remove files from the ZIP
  118. that do not exist in the current directory or one of its subdirectories.
  119. This can take a little while.  I will probably rewrite this in C++ when
  120. I get a chance.
  121.  
  122.  
  123. Things You Might Want to Change
  124. -------------------------------
  125.  
  126. If you don't want a command-line, you can set KeepCommandLineWindow to 0
  127. at the top of Wuz.Cmd.  If you want Wuz to open the command-line and folder
  128. on the desktop before it is finished unpacking the archive, set WaitForUnzip
  129. to 0.  If you want WUZ to unzip the archive in the first window, set
  130. UnzipInCommandLineWindow to 0.
  131.  
  132. If you don't want to watch the archive being unpacked, you can open the
  133. settings page of "WPS Unzip", select Session and set Start Minimized then set
  134. UnzipInCommandLineWindow to 0 in WUZ.Cmd.  If you do this and set
  135. KeepCommandLineWindow to 0 in Wuz.Cmd, WUZ will only create the folder.
  136. While your at it, you could set Start Minimized on "Zip Directory" as well.
  137. For WPS purists, this is the way to go!
  138.  
  139. If you would rather the command-line always load another program, i.e. a text
  140. file viewer, etc. set FinalCommand to whatever you like in Post-Wuz.Cmd.  If
  141. you want to add any other commands to be executed every time, add them between
  142. the two comment lines at the top of Post-WUZ.Cmd.  This is a good place to
  143. load aliases for 4OS2 users since SHRALIAS is disabled for WUZ command line
  144. windows.
  145.  
  146. IMPORTANT:  INSTALL will automatically preserve any of these changes that
  147.         you make if you reinstall.  Therefore, never modify these files
  148.         in the directory you are installing from.  Always modify them
  149.         in the executable directory.
  150.  
  151.         I will always keep these variables intact in new versions so you
  152.         should never have to worry about losing your changes when
  153.         reinstalling unless you modify something other than what I
  154.         have mentioned above.
  155.  
  156.  
  157. Coming Soon
  158. -----------
  159.  
  160. I will probably rewrite ZipStrip in C++ for speed.
  161.  
  162. Also, I will probably try to figure out a way to add Update and Refresh
  163. choices to the folder menu so that this feature can be accessed more easily
  164. form the WPS.
  165.  
  166. I should also be releasing my Extended Folder real-soon-now.  It will
  167. eventually provide an enhanced icon folder but currently it just adds
  168. Open Parent and Open Command-Line to the object menu of every folder.
  169. I will almost certainly need to use this to add Update and Refresh to the
  170. object menus of extract directories.
  171.  
  172.  
  173. For Rexx Programmers
  174. --------------------
  175.  
  176. First of all, I believe the install program "Install.Cmd" is pretty
  177. intelligent.  I hereby donate it to the public domain.  Use it freely
  178. and with no restrictions.  I would appreciate it if you credit me as
  179. the original author, though.
  180.  
  181. There are two routines here that you might want to put in your REXX
  182. library.  One is Check4OS2 which returns 1 if the current shell is 4OS2
  183. instead of CMD.  The other is DIRECTORY which simply makes the standard
  184. DIRECTORY command always append a '\' and accept directory names with a
  185. trailing backslash.  The standard DIRECTORY command chokes on trailing
  186. backslashes unless you are specifying the root and it never returns
  187. a name with a trailing backslash unless the current directory is the root.
  188. My routine makes everything a bit more consistent and robust.
  189.  
  190. One other routine that you might want to check out is GetDriveSpec in Wuz.CMD.
  191. This will take a filename and return FullPath, FullName, Ext and NameOnly.
  192. This can even handle relative paths on different drives without changing
  193. your current directory on any drive.
  194.  
  195.  
  196.  
  197. Adding a New Archive Type
  198. -------------------------
  199.  
  200. If you want to add a different archiver, here is what you need to do.
  201. Edit Wuz.Cmd and go down to the Extractor.Ext = whatever section.
  202. The following explanation will make a lot more sense if you are looking
  203. at Wuz.Cmd as you read this.
  204.  
  205. A generic archiver definition consists of the following specifications:
  206.  
  207. Extractor.<ext> = '<dearchiver>'- where Ext is the actual extension you want
  208.                   to use and <dearchiver> includes any
  209.                   necessary switches.  You should always
  210.                   setup your dearchiver to extract subdirec-
  211.                   tories and automatically overwrite if
  212.                   possible.
  213. CopyTo.<ext>    = Yes/No    - Some dearchivers must extract to the same
  214.                   directory that the archive is in.  These
  215.                   will require that the archive be copied to
  216.                   the extract directory first.  Usually,
  217.                   however, this will be no.
  218. Update.<ext>    = '<archiver>'    - This should be your archive command with
  219.                   switches to update files and work
  220.                   recursively.
  221. UpdateP.<ext>    = '<exclude>'    - This is a switch to stick on to the tail
  222.                   end of the archive command to exclude
  223.                   ZCLR.CMD, ZUPDATE.CMD and ZFRESH.CMD.
  224. Fresh.<ext>    = '<archiver>'    - This should be your archive command with
  225.                   switches to update only those files that
  226.                   have changed and already exist in the
  227.                   archive.  Don't forget any necessary
  228.                   switches to work recursively through any
  229.                   subdirectories.
  230.  
  231.  
  232. Legalities
  233. ----------
  234.  
  235. Okay, now for the legal stuff.  I use these routines constantly and have had
  236. no problems.  If you do, let me know.  However, I can not be held liable if
  237. anything nasty happens.  This software is strictly of the "USE AT YOUR OWN
  238. RISK" variety.
  239.  
  240. I am asking $20 for WPS Unzip.  I think this is probably fair.  If you make
  241. a lot of money and WUZ saves you tons of time you could send me more.
  242. On the other hand, if you are a starving student, just send me email telling
  243. me what you think and we'll call it even.  I am currently living in Japan
  244. so I know how hard it can be to send checks from outside the U.S.  If you
  245. are an international user, send me either cash or email.  If your local
  246. currency is pretty major, send me that and I'll try to exchange it.
  247. Any checks should be made out to my mother:
  248.  
  249.   Patricia Maxwell
  250.   1587 E. Modesto Ave.
  251.   Camarillo, CA 93010
  252.   U.S.A.
  253.  
  254. It costs me about $20 to cash a check in Japan, so this makes more sense
  255. for me.
  256.  
  257. Comments are welcome.  I hope these REXX routines are as useful for you
  258. as they have been for me.  I haven't found any easier way to explore
  259. archives.  Send comments to me at scottmax@netcom.com.
  260.  
  261. --------------------- Usenet: scottmax@netcom.com ---------------------
  262.