home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / d / dicottery / !Dicottery / !Help next >
Text File  |  1996-05-11  |  14KB  |  303 lines
  1. !Help for !Dicottery v3.07
  2.  
  3.  
  4. -----------------------------------------------------------
  5.  Interactive Help now supported!!! (in English and Dutch!)
  6. -----------------------------------------------------------
  7.  
  8.  
  9. -----------------------------------------------------------
  10.  Virus checking and cheesy external decompression working!
  11. -----------------------------------------------------------
  12.  please see the 'New' file for information by clicking on
  13.             the version button in the info box.
  14.  
  15.  
  16. Going Dutch
  17. -----------
  18.  
  19. Dicottery has gone Dutch!  Thanks to Zorack and indy911 of #acorn (IRC), I
  20. have almost everything in Dutch as well as English now.  I haven't got Dutch
  21. versions of the error messages, but they should follow soonish.
  22. Unfortunately, I've had to implement the Dutch version as a bit of a hack.
  23. There is a system variable 'Netherlands$Country' set in the !Run file, which
  24. will tell Dicottery whether to use Dutch or not.  I would read the country
  25. set up by the configure options, but there isn't one mentioned for Dutch,
  26. so I can't use this.
  27. If anyone speaks any other languages fluently, like French or German for
  28. example, and has an email address, please get in contact with me.  I am
  29. interested in getting as many languages into Dicottery as possible, but I
  30. can't do it on my own - I know a little French, and can buy a baguette quite
  31. happily, but other than that, I'm a little stuck ;-).
  32.  
  33.  
  34.  
  35. Emailing lists
  36. ==============
  37.  
  38. I have set up two emailing lists for Dicottery users.  All those on the
  39. first list will be emailed when a new version of Dicottery comes out, with
  40. information on new features etc.  Those on the second list will be emailed
  41. a uuencoded copy of new versions of Dicottery aswell.  If you want to be
  42. included on either or both of these lists, please email me to say so.  Also,
  43. if you tell me what version of Dicottery you are currently using, I'll
  44. send you the latest version if it's been updated since then.
  45. I am afraid that I can't extend this service to normal mail, since I simply
  46. don't have the money, being a student, for discs, envelopes and stamps.
  47. It's all being saved up for next year when I'll need it for food!
  48.  
  49.  
  50.  
  51. What is Dicottery?
  52. ------------------
  53.  
  54. The most important question first, eh?  Well, I had been getting really sick
  55. of the fact that every time I downloaded anything off the internet, I had to
  56. work out which decompressor to use, and then decompress it.  This often took
  57. several attempts, sometimes crashed the computer and ALWAYS took a long
  58. time.  I therefore decided to alleviate this problem, and have written
  59. Dicottery.
  60.  
  61. Dicottery is another compression program, but one different from the others
  62. because you won't need to hunt around for the right decompressor for its
  63. archives, since the archives decompress themselves!  The 'Dicottery SEA's
  64. (Self-Extracting Archives) will run as any other program, with a simple
  65. double-click, and will supply a save box for you to decide where to
  66. decompress the file, application or directory to.
  67.  
  68. Self-extracting archives are not a new idea by any means.  Probably the most
  69. famous on the Acorn scene is the BASIC file on Acorn's ftp area which
  70. produces a copy of !SparkPlug in your current directory when it's run.
  71. However, I have managed to add a few extra features, the best of which is
  72. drag-and-drop decompression.  Quite simply, when a Dicottery SEA is loaded,
  73. it initialises itself as a wimp application, and pops up a save box,
  74. enabling you to decide where to put the decompressed data.
  75.  
  76.  
  77.  
  78. How to use Dicottery
  79. --------------------
  80.  
  81. There are two main ways of compressing things with Dicottery: you may either
  82. use the !Dicottery application, or the Dicottery utility.  The two different
  83. methods are supplied so that the user has an easy and user-friendly way of
  84. using Dicottery (the application) and so that other applications can use
  85. Dicottery as a * command (the utility).
  86.  
  87. Using the application
  88. - - - - - - - - - - -
  89. The application initialises as any other, and places an icon on the icon
  90. bar.  You can access the menu from here, and view my wonderful Info box, and
  91. also set or unset the 'Faster' option (this works like the filer windows'
  92. faster option), and even Quit from it if you really want to.  To compress
  93. something, simply drag a directory, application etc onto the ibi (icon bar
  94. icon) and drag the file thingy off the save box and onto a filer window or
  95. whatever.  After a brief amount of clicking (Dicottery is determining the
  96. size of what you want compressed) a window will appear showing Dicottery's
  97. progress as a green slider bar.  It also shows the item you're compressing
  98. and what file it's being compressed to at the top, and a picture of the
  99. application or file's icon at the top-right.  Lower down there is another
  100. display field which shows the file that Dicottery is handling at the moment
  101. ONLY if the Faster option is NOT selected.  And, of course, there are the
  102. 'Abort' and 'Pause' buttons.
  103.  
  104. If you try to compress something else while Dicottery is still compressing
  105. something, a save box will appear again, and when you drag off the SEA, it
  106. actually loads a second copy of Dicottery.  I'm sorry this happens, since it
  107. should really be the same program handling both, but at the moment, the
  108. Dicottery compression code is written recursively, which makes it nearly
  109. impossible to get the same application to do both compression jobs at once.
  110.  
  111. However, you don't really need to worry about this second copy of Dicottery
  112. loading, since it doesn't create an ibi and automatically quits as soon as
  113. it's finished.  So really, you need never know that there are two copies of
  114. Dicottery loaded unless you look in the Task Manager window.
  115.  
  116. Using the Utility
  117. - - - - - - - - -
  118. The Dicottery utility is provided mainly for programmers, but can also, of
  119. course, be used by someone using the OSCLI, or from an Obey file etc etc.
  120. It is a bit quicker than the application, since it doesn't have to multitask
  121. or redraw any windows.  However, it lacks the functionality of the
  122. application, since you cannot pause it, it doesn't multitask and you can
  123. only have one compression task going at once.
  124.  
  125. In its normal mode, the utility will use the hourglass to display the
  126. percentage of the file sizes which have been compressed (calculated the same
  127. way as is the application's slider bar), but this can be switched off.
  128. Switching this option off does not affect the speed of the program when it
  129. is compressing things, but it doesn't bother to find out the full size of
  130. the data you are compressing, which for large directory structures saves
  131. quite a bit of time, and especially so on floppy discs.  The full syntax for
  132. using the Dicottery utility is as follows:
  133.  
  134. *Dicottery [-faster] input_object output_filename
  135.  
  136. Using a Dicottery SEA
  137. - - - - - - - - - - -
  138. This is by far the simplest part of Dicottery to use.  It has deliberately
  139. been made easy so that anyone with some knowledge about Acorn machines (ie
  140. how to use save boxes, how to run a program etc) will be able to use it
  141. quickly and easily.
  142.  
  143. To load a Dicottery SEA into memory, simply make sure it's filetype is
  144. Absolute (&FF8) and double-click on it.  A nearly-standard save box will
  145. appear, containing a display icon showing the name of the compressed item,
  146. and a file icon, showing either a filetype or a 'directory' or 'application'
  147. sprite.  Applications' own sprites are not used, since if you're
  148. decompressing an application, the chances are that your computer hasn't seen
  149. it before, in which case no sprite will appear at all.  Note that you cannot
  150. change the name in the display icon.  This is partly because it would add to
  151. the size of the Dicottery SEAs, and partly because with applications this
  152. isn't a good idea, since you'd get no icon in the filer windows.
  153.  
  154. To decompress the object, all you do is to drag the sprite icon from the
  155. window and onto a filer window.  The Dicottery SEA will then decompress to
  156. the relevant position, and will quit immediately afterwards.  If you change
  157. your mind and decide not to decompress the object, simply click on the close
  158. icon of the window and the application will terminate.  Please read the
  159. 'know bugs and problems' section, since there's something else you sho