home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / dicottery / Dicottery / !Help next >
Text File  |  1996-04-29  |  10KB  |  227 lines
  1. !Help for !Dicottery v3.04
  2.  
  3. What is Dicottery?
  4. ------------------
  5.  
  6. The most important question first, eh?  Well, I had been getting really sick
  7. of the fact that every time I downloaded anything off the internet, I had to
  8. work out which decompressor to use, and then decompress it.  This often took
  9. several attempts, sometimes crashed the computer and ALWAYS took a long
  10. time.  I therefore decided to alleviate this problem, and have written
  11. Dicottery.
  12.  
  13. Dicottery is another compression program, but one different from the others
  14. because you won't need to hunt around for the right decompressor for its
  15. archives, since the archives decompress themselves!  The 'Dicottery SEA's
  16. (Self-Extracting Archives) will run as any other program, with a simple
  17. double-click, and will supply a save box for you to decide where to
  18. decompress the file, application or directory to.
  19.  
  20. Self-extracting archives are not a new idea by any means.  Probably the most
  21. famous on the Acorn scene is the BASIC file on Acorn's ftp area which
  22. produces a copy of !SparkPlug in your current directory when it's run.
  23. However, I have managed to add a few extra features, the best of which is
  24. drag-and-drop decompression.  Quite simply, when a Dicottery SEA is loaded,
  25. it initialises itself as a wimp application, and pops up a save box,
  26. enabling you to decide where to put the decompressed data.
  27.  
  28.  
  29.  
  30. How to use Dicottery
  31. --------------------
  32.  
  33. There are two main ways of compressing things with Dicottery: you may either
  34. use the !Dicottery application, or the Dicottery utility.  The two different
  35. methods are supplied so that the user has an easy and user-friendly way of
  36. using Dicottery (the application) and so that other applications can use
  37. Dicottery as a * command (the utility).
  38.  
  39. Using the application
  40. - - - - - - - - - - -
  41. The application initialises as any other, and places an icon on the icon
  42. bar.  You can access the menu from here, and view my wonderful Info box, and
  43. also set or unset the 'Faster' option (this works like the filer windows'
  44. faster option), and even Quit from it if you really want to.  To compress
  45. something, simply drag a directory, application etc onto the ibi (icon bar
  46. icon) and drag the file thingy off the save box and onto a filer window or
  47. whatever.  After a brief amount of clicking (Dicottery is determining the
  48. size of what you want compressed) a window will appear showing Dicottery's
  49. progress as a green slider bar.  It also shows the item you're compressing
  50. and what file it's being compressed to at the top, and a picture of the
  51. application or file's icon at the top-left.  Lower down there is another
  52. display field which shows the file that Dicottery is handling at the moment
  53. ONLY if the Faster option is NOT selected.  And, of course, there are the
  54. 'Abort' and 'Pause' buttons.
  55.  
  56. If you try to compress something else while Dicottery is still compressing
  57. something, a save box will appear again, and when you drag off the SEA, it
  58. actually loads a second copy of Dicottery.  I'm sorry this happens, since it
  59. should really be the same program handling both, but at the moment, the
  60. Dicottery compression code is written recursively, which makes it nearly
  61. impossible to get the same application to do both compression tasks at once.
  62.  
  63. However, you don't really need to worry about this second copy of Dicottery
  64. loading, since it doesn't create an ibi and automatically quits as soon as
  65. it's finished.  So really, you need never know that there are two copies of
  66. Dicottery loaded unless you look in the Task Manager window.
  67.  
  68. Using the Utility
  69. - - - - - - - - -
  70. The Dicottery utility is provided mainly for programmers, but can also, of
  71. course, be used by someone using the OSCLI, or from an Obey file etc etc.
  72. It is a bit quicker than the application, since it doesn't have to multitask
  73. or redraw any windows.  However, it lacks the functionality of the
  74. application, since you cannot pause it, it doesn't multitask and you can
  75. only have one compression task going at once.
  76.  
  77. In its normal mode, the utility will use the hourglass to display the
  78. percentage of the file sizes which have been compressed (calculated the same
  79. way as is the application's slider bar), but this can be switched off.
  80. Switching this option off does not affect the speed of the program when it
  81. is compressing things, but it doesn't bother to find out the full size of
  82. the data you are compressing, which for large directory structures saves
  83. quite a bit of time, and especially so on floppy discs.  The full syntax for
  84. using the Dicottery utility is as follows:
  85.  
  86. *Dicottery [-faster] input_object output_filename
  87.  
  88. Please note that the -faster option, if present, must be before the input
  89. and output objects.  I am VERY SORRY about this - it will be sorted out soon
  90. - but it's due to me having little experience with SWI"OS_ReadArgs".  I will
  91. have a look at the PRMs about it soon, but until then, I'm afraid this
  92. horrible lapse in programming will have to stay.
  93.  
  94. Using a Dicottery SEA
  95. - - - - - - - - - - -
  96. This is by far the simplest part of Dicottery to use.  It has deliberately
  97. been made easy so that anyone with some knowledge about Acorn machines (ie
  98. how to use save boxes, how to run a program etc) will be able to use it
  99. quickly and easily.
  100.  
  101. To load a Dicottery SEA into memory, simply make sure it's filetype is
  102. Absolute (&FF8) and double-click on it.  A nearly-standard save box will
  103. appear, containing a display icon showing the name of the compressed item,
  104. and a file icon, showing either a filetype or a 'directory' or 'application'
  105. sprite.  Applications' own sprites are not used, since if you're
  106. decompressing an application, the chances are that your computer hasn't seen
  107. it before, in which case no sprite will appear at all.  Note that you cannot
  108. change the name in the display icon.  This is partly because it would add to
  109. the size of the Dicottery SEAs, and partly because with applications this
  110. isn't a good idea, since you'd get no icon in the filer windows.
  111.  
  112. To decompress the object, all you do is to drag the sprite icon from the
  113. window and onto a filer window.  The Dicottery SEA will then decompress to
  114. the relevant position, and will quit immediately afterwards.  If you change
  115. your mind and decide not to decompress the object, simply click on the close
  116. icon of the window and the application will terminate.  Please read the
  117. 'know bugs and problems' section, since there's something else you should
  118. know.
  119.  
  120.  
  121. Copyright
  122. ---------
  123.  
  124. I hold all copyright to Dicottery (both the application and utility), the
  125. Dicottery SEA and all documentation supplied with them.  I reserve the right
  126. to do anything I like relating to the Dicottery package.  Dicottery (this
  127. refers the the entire package in this section) is freeware, and no charge
  128. can be made for the package other than a small and reasonable charge for
  129. postage, packing and handling by pd libraries and the like.  It is illegal
  130. to either distribute Dicottery incomplete or to distribute it as part of any
  131. other package (commercial or not) without my express permission.  If you're
  132. going to put Dicottery on a CD-ROM, cover disc etc, please contact me for
  133. the latest version (or look at my web page - it'll be on there).
  134.  
  135. I can also not be held responsible for any damaged caused by Dicottery, or
  136. your use or misuse of it.
  137.  
  138. If you've ever written a !Help file, you'll know that copyright sections are
  139. the worst parts to write.  Though I say I'm not responsible for any damage
  140. caused by Dicottery, if Dicottery has a bug which does nasty things (or any
  141. bug for that matter), please complain bitterly to me about it.  After all, I
  142. DID write it, and if anything goes wrong, while legally I can't be sued
  143. (it's provided as-is BTW), morally I am in the wrong.  I recognise this, and
  144. promise to do anything I can to rectify problems.  However, don't sue me,
  145. because I'm a student, and simply can't afford it.
  146.  
  147.  
  148. Contacting me
  149. -------------
  150.  
  151. I can be contacted in many ways.  The first is email, which I prefer to
  152. normal mail - it's so much quicker and cheaper!
  153.  
  154. p.c.f.norman@ex.ac.uk    ( or py95pcfn@ex.ac.uk )
  155.  
  156. snail mail is ok though, though please include an SAE (and a disc if you
  157. want a new version of Dicottery) if you want a reply - mon