home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / p / packdir / !PackDir / Docs / Guide next >
Encoding:
Text File  |  1996-10-13  |  10.4 KB  |  255 lines
  1.  
  2. __________________
  3.  
  4. PackDir user guide
  5. __________________
  6.  
  7.  
  8. User, please note
  9. =================
  10.  
  11. PackDir is Freeware, i.e. it is free software.
  12.  
  13. Copyright notice
  14. ================
  15.  
  16. The copyright (c) of this program belongs to John Kortink. All rights are
  17. reserved.
  18.  
  19. You may not change this program (except for documented configuration
  20. changes). You may not use any part of this program in any other program or
  21. product without my written approval. You may spread this program freely, but
  22. only in complete and unchanged form, and only against bare distribution costs
  23. (if any). This program is provided 'as is'. No fitness of this program for
  24. any particular purpose is implied. Using this program is entirely at your own
  25. risk.
  26.  
  27.  
  28. //
  29. //
  30. // Introduction
  31. //
  32. //
  33.  
  34. PackDir is an *extremely* fast file archiver. It can take a set of files and
  35. put them all together in a single archive file. It can also perform the
  36. reverse process, i.e. it can exactly recreate the original set of files from
  37. the archive file. To make archive files as small as possible, PackDir can
  38. perform lossless compression on file data, which reduces the archive's size
  39. typically to about 50% (or even much less, depending on the nature of the
  40. file data).
  41.  
  42. PackDir is *extremely* quick. All archiving and unarchiving is performed by
  43. 100% ARM assembler code that cuts every possible corner to maximize
  44. processing speed. The data compression and decompression routines are highly
  45. optimized and are even considerably faster than Acorn's Squash routines
  46. contained in RISC OS. On a RISC PC, archiving or unarchiving a directory
  47. (with compression enabled) is even faster than making a copy of that
  48. directory ('faster' mode on) ! Also, on some rough tests with typical file
  49. sets, PackDir has been found to be between 5 and 10 times as fast as Spark,
  50. the 'de-facto' archiver for Acorn machines. Test and compare and you'll
  51. quickly be convinced !
  52.  
  53. PackDir is not meant to fully replace existing archivers because it lacks
  54. some 'convenience' features. But if you regularly need to lug around a lot of
  55. data, e.g. if you regularly exchange data with your friends or if you
  56. regularly make and restore backups of your data, PackDir is an ideal tool. It
  57. will save you a *lot* of time. If you also need Filer-like read access to
  58. PackDir archives you may want to use SparkFS, a commercial product made by
  59. David Pilling. Newer versions of this program can read PackDir archives.
  60.  
  61. PackDir always archives and unarchives a single, complete directory. It does
  62. not provide for archiving of a specific selection of objects or for adding
  63. objects to or removing objects from an existing archive.
  64.  
  65.  
  66. //
  67. //
  68. // Using PackDir
  69. //
  70. //
  71.  
  72. On PackDir's iconbar menu the usual 'Info' and 'Quit' icons can be found. In
  73. addition, 'Control' gives access to the 'PackDir control' window (click on
  74. 'Control' to make the window permanent) and 'Status' gives access to the
  75. 'Status' menu. The 'Progress ...' and 'Statistics ...' icons open the
  76. 'PackDir progress' and 'PackDir statistics' windows respectively. The
  77. 'PackDir control', 'PackDir progress' and 'PackDir statistics' windows and
  78. the 'Status' menu are described below.
  79.  
  80. Dragging a directory to PackDir's icon will initiate archiving. Dragging a
  81. PackDir archive file to PackDir's icon, or double-clicking on a PackDir
  82. archive file will initiate unarchiving. Archive files which do not have the
  83. correct filetype are also recognized (and filetyped correctly).
  84.  
  85. NOTE : to archive a '$' directory (which cannot be displayed in a Filer
  86. window and hence cannot be dragged to PackDir), hold down CTRL and instead
  87. drag any object in that '$' directory (note that the default name of the
  88. resulting archive file is 'Root', as '$' is an illegal filename).
  89.  
  90.  
  91. //
  92. //
  93. // The 'PackDir control' window
  94. //
  95. //
  96.  
  97. In this window, you will find five parts, called 'Compression', 'Store',
  98. 'Extract', 'Extract to' and 'Image file'.
  99.  
  100. A few words about what is stored in a PackDir archive and how I refer to the
  101. items. For example, if the directory archived is 'RAM:$.Glpfz.Biqx', the
  102. resulting PackDir archive will store information on the 'RAM:$.Glpfz.Biqx'
  103. directory, and on all objects encountered by recursing 'RAM:$.Glpfz.Biqx'.
  104. For all files encountered, information & contents (data) are stored. For all
  105. directories encountered, only information is stored (as directories store no
  106. actual data). 'Information' consists of everything relevant to recreate the
  107. object, e.g. name, date stamp, size, filetype and so on.
  108.  
  109. The 'Compression' part allows you to specify the compression method to be
  110. used on file data when a directory is being archived :
  111.  
  112. - 'None' disables compression. File data will be stored in the archive in
  113.   uncompressed form. Note that the resulting archive has a '12-bit LZW'
  114.   format, even though no compression has been used on the file data. This is
  115.   to retain backward compatibility with older versions of PackDir.
  116. - 'n-bit LZW' (where n = 12, 13, 14, 15, 16) orders PackDir to attempt n-bit
  117.   LZW compression on file data. If the compression does not result in size
  118.   reduction (which can occur on some data, e.g. if it is already compressed),
  119.   file data will be stored in the archive in uncompressed form.
  120.  
  121. LZW (Lempel Zev Welch) is an efficient compression algorithm, and is very
  122. widely used in the computing world. It is used (in a variety of subtly
  123. different forms) in nearly all archiving programs available, regardless of
  124. platform. 'n-bit' indicates that the compression codes output by the
  125. algorithm are 9..n bits long. In general, 16-bit LZW results in the best
  126. possible compression and therefore the smallest archives. However, as 'n'
  127. increases, more and more workspace memory is needed to perform the algorithm.
  128. 16-bit LZW compression needs around 740k of workspace to compress, and around
  129. 320k to decompress, while 12-bit LZW needs only around 45k to compress, and
  130. around 20k to decompress. The differences in processing speed between all of
  131. the 'n-bit LZW' compression methods are negligible. It is recommended to use
  132. 16-bit LZW wherever possible.
  133.  
  134. The 'Store' part allows you to restrict what is stored in an archive file
  135. when a directory is being archived :
  136.  
  137. - 'All' results in everything relevant being stored in the archive.
  138. - 'Skeleton' results in everything relevant being stored in the archive,
  139.   except for file data. This setting is sometimes useful to make a compact
  140.   'snapshot' of a directory tree structure. Unarchiving this archive
  141.   recreates the directory structure (but, obviously, not the file data).
  142.  
  143. The 'Extract' part allows you to restrict what is extracted from an archive
  144. file when a directory is being unarchived :
  145.  
  146. - 'All' results in everything relevant being extracted from the archive.
  147. - 'Envelope' results in everything relevant being extracted from the archive,
  148.   except for file data. Note that while file data is not restored, the file
  149.   size is, i.e. the resulting file contents will be undefined (as after a
  150.   *Create command).
  151. - 'Skeleton' is like 'Envelope', except that all file sizes are forced to 0
  152.   (so files will not take up any media space).
  153.  
  154. The 'Extract to' part allows you to specify the destination directory when a
  155. directory is being unarchived :
  156.  
  157. - 'New path' pops up a 'save' window. You can drag the directory icon to a
  158.   Filer directory viewer to indicate the destination and start unarchiving.
  159. - 'Old path' does not pop up a 'save' window, but unarchives straight to the
  160.   original 'root' directory (which is stored in the archive). E.g. if you had
  161.   archived directory 'RAM:$.Glpfz.Biqx', then 'RAM:$.Glpfz.Biqx' is also the
  162.   destination directory.
  163.  
  164. The 'Image file' part allows you to specify how PackDir should handle image
  165. files. Image files are special files, usually archives of some sort (i.e.
  166. they contain directories and files). In normal situations, an image file
  167. behaves just like any other file. However, once an appropriate Image Filing
  168. System is loaded, and it recognizes the format of the image file, the image
  169. file behaves differently. It can then be accessed both as a file and as a
  170. directory. PackDir needs to know which too choose.
  171.  
  172. - 'File' makes PackDir see image files as files. While archiving, when an
  173.   image file is encountered, it is stored in the archive as a single file.
  174. - 'Directory' makes PackDir see image files as directories. While archiving,  
  175.   when an image file is encountered, it is stored in the archive as a
  176.   directory. I.e. the image file is broken down into subdirectories and
  177.   files, and these are stored seperately in the archive.
  178.  
  179. Note that PackDir archives are also image files. When you are running an
  180. Image Filing System that recognizes PackDir archives, e.g. SparkFS, and you
  181. have 'Image file' set to 'Directory', you should keep in mind that PackDir
  182. then sees its own archives as directories and will not unarchive them. To
  183. avoid confusing situations like this, it is recommended to keep 'Image file
  184. is' set to 'File', or stop the Image Filing System from recognizing PackDir
  185. archives.
  186.  
  187.  
  188. //
  189. //
  190. // The 'PackDir progress' window
  191. //
  192. //
  193.  
  194. This window will show a graphic representation of the progress of the
  195. archiving or unarchiving process.
  196.  
  197. The meaning of most of the contents of this window is obvious and will not be
  198. explained. Note that the beige parts of the sliders represent the data being
  199. processed, the red and green parts represent data that has already been
  200. processed.
  201.  
  202. NOTE : When this window is open PackDir's performance drops considerably, due
  203. to the overheads incurred in updating the window. Therefore, only open this
  204. window if you really need to observe progress and speed is of lesser
  205. importance !
  206.  
  207.  
  208. //
  209. //
  210. // The 'PackDir statistics' window
  211. //
  212. //
  213.  
  214. This window will show statistics for a PackDir archive file dragged to it.
  215.  
  216. The meaning of the contents of this window is obvious and will not be
  217. explained.
  218.  
  219.  
  220. //
  221. //
  222. // The 'Status' menu
  223. //
  224. //
  225.  
  226. In this menu you can manipulate PackDir's 'status', which consists of a
  227. number of configuration settings.
  228.  
  229. - 'Save' will save the current status.
  230. - 'Load' will load the saved status.
  231. - 'Default' will load the default status.
  232. - 'Kill' will remove the saved status.
  233.  
  234. When PackDir starts up it loads the saved status, or the default status if
  235. there is no saved status.
  236.  
  237. The status consists of the 'Compression', 'Store', 'Extract', 'Extract to'
  238. and 'Image file' settings.
  239.  
  240.  
  241. //
  242. //
  243. // Epilogue
  244. //
  245. //
  246.  
  247. Updates of PackDir will be made available by (in order of preference) :
  248.  
  249. - World Wide Web, on www.inter.nl.net/users/J.Kortink.
  250. - Electronic mail, to kortink@inter.nl.net.
  251. - Snail mail, to : John Kortink, Nutterbrink 31, 7544 WJ Enschede, The
  252.   Netherlands. Include a DD or HD floppy, return envelope and one
  253.   International Reply Coupon (IRC).
  254.  
  255.