home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / archiver / boozgem3 / boozgem.doc < prev    next >
Text File  |  1993-07-07  |  8KB  |  192 lines

  1.                     GEMBOOZ.PRG
  2.  
  3.         Legal Stuff:
  4.  
  5. First, I'll get the legal stuff out of the way:
  6.  
  7.     I will not be liable for the proper working of this program, and
  8.     will not be held responsible for any damage that may ensue upon
  9.     its use or misuse.
  10.  
  11. Now, with that little sop to our litigation-happy soceity out of
  12. the way, I'll get to the programs.
  13.  
  14.         History:
  15.  
  16. Booz is designed to be a basic, memory-efficient extractor for
  17. Zoo files.  It's designed to be run from the command line, and
  18. has a minimum of options--just l, t, and x, to list, test, and
  19. extract files, respectively.  It currently has some limitations.
  20. The biggest one is that it doesn't handle directories, *at
  21. all*.  It *does* handle the high-compression Zoo 2.1 files.
  22.  
  23. All well and good.  I got the sources, and compiled them with
  24. HSC 1.40 from Ian Lepore (which is the successor to Heat-N-Serve
  25. Sozobon 1.33i and currently in beta-testing--the name change was
  26. made to (hopefully) avoid confusion with Sozobon 2.0, which is
  27. by the original Sozobon crew).
  28.  
  29. I personally have gone through numerous periods in which I have
  30. used either GEM or CLI's almost exclusively.  Being in one of my
  31. GEM phases, I decided to wrap a GEM interface around Booz, in
  32. the hopes that it would appease some of the people that decry
  33. Zoo's (sometimes Byzantine) command-line.  It would also make my
  34. life a bit easier.
  35.  
  36.         Operation:
  37.  
  38. When you run BoozGEM.prg, you'll be greeted by a familiar menu
  39. interface.  The options are (I hope) self-explanitory.  If you
  40. select the About... option, you'll get a little message with
  41. credits in it.
  42.  
  43. Under "File", there are five options:  List, Test, Extract,
  44. Batch Extract, and Quit.  Quit should be obvious.  List just
  45. lists the contents of the archive, using a standard GEM file
  46. selector to prompt you for the file.  Test tests the integrity
  47. of the archive, prompting you for the name of the file with a
  48. file selector.
  49.  
  50. Extract is a bit more complex, but not much--It first prompts
  51. you for the file you want to extract.  Then it prompts you for a
  52. directory to extract to (this is a big plus over the "real"
  53. Zoo.ttp, which doesn't let you tell it where to extract files). 
  54. Then it extracts the file to that directory.
  55.  
  56. If, during extraction, BoozGEM.prg finds that a file it is
  57. trying to extract already exists, it'll prompt you.  You have
  58. the choice to either keep the original file, which will skip
  59. extracting the file in question, or you can overwrite one file,
  60. which will extract this file over the file that already exists,
  61. or you can choose to overwrite all, which means that BoozGEM.prg
  62. will no longer prompt you if it finds a file that already
  63. exists--it will overwrite files with impunity.
  64.  
  65. Batch extract is something I've wanted for a long time.  What it
  66. does is allow you to select a subdirectory with a bunch of .ZOO
  67. files in it.  Then you select a destination subdirectory.  It
  68. will then extract all the files to like-named subdirectories
  69. within the destination subdirectory.  Like magic, it'll extract
  70. a bunch of .ZOO files unsupervised.
  71.  
  72. The other menu, "Options" only has one entry.  If "Extract to
  73. subdirectories" is selected, the behavior of the normal extract
  74. command is similar to that of the "Batch Extract" Option, in
  75. that BoozGEM.prg will create a named subdirectory within the
  76. destination subdirectory, and extract the files to there.
  77.  
  78. That's it for operation.
  79.  
  80.         To Do:
  81.  
  82. This version is marked *BETA* in the about box.  That's not as
  83. horrifying as it sounds.  I marked it that way because it still
  84. doesn't do some of the things I'd like it to.  Among these
  85. are:
  86.  
  87.     Accept a command line -- I'd like for people to be able to
  88. double-click on a .ZOO file and have it automatically extract. 
  89. I'm not sure whether it will default to extracting to the
  90. current directory or ask you for a destination directory.
  91.  
  92.     Full directory support -- This will probably come last,
  93. since it will involve ripping huge festering hunks of the
  94. original Zoo source code out, in order to be able to support
  95. Zoo's directory-storage scheme.
  96.  
  97. [Editor's note:  The next two have already been implemented]
  98.  
  99.     Create directories automatically -- I'd like to be able to
  100. set a flag (constant from one run to the other) so that
  101. BoozGEM.prg will automatically create a directory to put the
  102. extracted files in.  That way, if you were extracting a file
  103. called "wombat.zoo", you could set a "root" directory (say, c:\
  104. tmp) and BoozGEM would create c:\tmp\wombat and put all the
  105. extracted files there.
  106.  
  107.     Batch extraction -- I'd like to be able to have a whole
  108. directory full of .ZOO files, and just click on one menu entry
  109. and have them extracted automatically into named subdirectories
  110. below the directory where they are (or where you tell them to
  111. go...).  This is obviously dependent upon the previous "wish".
  112.  
  113. Heck, while i'm at it:
  114.  
  115.     Full archive creation support (i.e. A GEM version of Zoo
  116. itself) -- This may happen, but it won't be monstrously soon, so
  117. don't hold your breath.  It will take work, though a couple of
  118. other guys I know have said that they'd help, it'll still take a
  119. while.  Maybe a lot of encouragement from people in the Atari
  120. community would speed this up.  It's always nice to get
  121. encouragement and hear from people who are using tools that
  122. you've created.
  123.  
  124.     Why there isn't source code:
  125.  
  126. The source code to Booz is freely available--I think I got mine
  127. from the Unix RT on GEnie.  It's on the Internet, I've seen it. 
  128. So releasing the source to the text-mode Booz would be
  129. silly--it's already out there, and it was only 15 minutes of
  130. work to get it functioning with HSC, which isn't even an ANSI
  131. compiler.
  132.  
  133. The source code to BoozGEM.prg will get out there eventually. 
  134. The problem is, it's still pretty messy, and it is pretty
  135. dependant upon both HSC 1.40 (which is still in Beta) and my own
  136. winx_lib.a, a library of windowed-text output routines that is
  137. still in beta, as well as being dependent upon the GemFast 1.8
  138. libraries that are also in beta and only (at this time)
  139. available to HSC 1.40 beta-testers (since they're both by the
  140. same guy, Ian Lepore).  How's that for a house of Greek cards,
  141. huh?
  142.  
  143. Once it's cleaner, and HSC 1.40's out there, and GemFast 1.8,
  144. and my own winx_lib.a, I'll release it.  Hopefully most of my
  145. wish list will be in by that time, too.
  146.  
  147.         Thanks:
  148.  
  149. To Rahul Dhesi, without whom Zoo and Booz wouldn't exist.
  150.  
  151. To Ian Lepore, without whom I would never have started on this
  152. project--it started as a big beta-test suite, and grew.
  153.  
  154. To Steve Yelvington, CBARRON, and Chris Herborth for hints, tips
  155. and encouragement, and for keeping me off Ian's back when the
  156. program bombed because they found the bugs I missed.
  157.  
  158. To John Stanley, for the same services as above, as well as
  159. MicroEMACS 2.19b, the editor I'm using and have fallen in love
  160. with.
  161.  
  162. Also to Anne Klinefelter, for not getting testy when I spent
  163. hours slaving away at a computer instead of doing important
  164. things like baking bread.
  165.  
  166.         How to contact me:
  167.  
  168. If you have something that you'd like to see done (if it isn't
  169. in the to do: list) or if you (heaven forbid) find a bug, please
  170. contact me, and I'll try to fix it.  Honest.
  171.  
  172. My various electronic addresses are:
  173.  
  174. M.DORMAN2 on GEnie
  175. mad@sss.cba.ua.edu on the Internet (only til August)
  176.  
  177.         Revision notes:
  178.  
  179. Version 2.1.1:
  180.     This was supposed to be the first public release, but I
  181. forgot to include the .rsc file when I uploaded it to GEnie. 
  182. Oops.  By the time I realised it, though, I had already made so
  183. many changes that I decided to work some more, since they were
  184. going well.  Hence came...
  185.  
  186. Version 2.1.3:
  187.     This is the version you have in your hands right now.  It
  188. includes the ability to extract to subdirectories, as well as a
  189. "batch extraction" mode.  Two things on the to do: list down.  I
  190. also updated this doc and caught a couple of tiny, likely
  191. non-destructive bugs.
  192.