home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / archivers / packdir / !PACKDIR / DOCS / GUIDE next >
Text File  |  1993-10-06  |  12KB  |  317 lines

  1. >Guide
  2. _______________________________________________________________________________
  3.  
  4. PackDir 1.35                                        --------------------------
  5.                                                      This program is FREEWARE
  6. Version date : 06 Oct 1993                          --------------------------
  7.  
  8. ----------------
  9. - Introduction -
  10. ----------------
  11.  
  12. PackDir will archive an entire directory, including all its subdirectories,
  13. into a very compact archive file. Directories in archives may be completely
  14. restored at either their original path or a new path.
  15.  
  16. PackDir uses LZW compression (also widely used in most present day archivers)
  17. to substantially reduce the archive's size. It uses highly optimized ARM code
  18. compression and decompression routines, making it *very* fast, which was
  19. necessary to make it a viable alternative to the (excellent, but very slow)
  20. !Spark (de)archiving application by David Pilling.
  21.  
  22. I wrote PackDir only to facilitate really fast and compact backup, for hard
  23. discs and the like. PackDir is not meant to be an alternative to Spark in any
  24. other way, as the archives made by PackDir have an incompatible format.
  25.  
  26. Speed ?
  27.  
  28. PackDir archives around 3 times as fast as !Spark 2.22, and unpacks about 3.5
  29. times as fast, resulting in about the same size archives (actually 0.5%
  30. smaller). (!Spark 2.22 set to 13-bit 'Compress', no background mode, scrap on
  31. RAM disc, !PackDir to 13-bit. Testing was in mode 0 and on RAM disc.
  32.  
  33. These are ballpark figures. Depending on the contents and number of files
  34. speeds may be even higher (usually not lower because of PackDir's intelligent
  35. memory handling and usage).
  36.  
  37.  
  38. -------------------------
  39. - Using the application -
  40. -------------------------
  41.  
  42. To start up PackDir, either :
  43.  
  44. - Double-click on the '!PackDir' icon.
  45. - Double-click on a PackDir archive file, after !PackDir has been seen by the
  46.   filer.
  47.  
  48. It will install itself on the icon bar, and clicking MENU on PackDir's icon
  49. pops up the main menu, giving the usual 'Info' and 'Quit' options, and others,
  50. which will be discussed further on.
  51.  
  52.  
  53. -------------------------
  54. - Archiving a directory -
  55. -------------------------
  56.  
  57. To archive a directory, simply drag it onto PackDir's iconbar icon. A save
  58. window will appear. Dragging the archive icon to a directory viewer will start
  59. the archiving process.
  60.  
  61. By default, the leafname of the archive file is set to the directory's
  62. leafname. You may change this by entering another leafname into the writable
  63. icon below the archive icon.
  64.  
  65. NOTE : Pressing CTRL while dragging a directory to PackDir will archive the
  66. parent of the directory. This is to enable archiving of the root directory ($)
  67. of a disc. The default leafname will be 'Root', as '$' is an illegal filename.
  68.  
  69.  
  70. ------------------------
  71. - Unpacking an archive -
  72. ------------------------
  73.  
  74. To unpack an archive, drag it to PackDir's iconbar icon (PackDir archive
  75. files without the correct filetype will be checked and settyped automatically), or double-click on it (only for correctly filetyped archive files). A save
  76. window will appear. Dragging the directory icon in the save window to a
  77. directory viewer will start the unpacking process.
  78.  
  79. By default, the leafname of the directory is set to the leafname of the
  80. original directory. You may change this by entering another leafname into the
  81. writable icon below the directory icon.
  82.  
  83. Unpacking may also be to the original path (including filing system), which has
  84. been stored in the archive (see the 'Old path' option). In this case, no save
  85. window will appear, and unpacking starts immediately.
  86.  
  87.  
  88. --------------------------
  89. - The information window -
  90. --------------------------
  91.  
  92. Clicking on the iconbar icon with either SELECT or ADJUST will pop up a report
  93. window, in which continuous information is given about the actions performed
  94. during (de)archiving.
  95.  
  96. NOTE : Having this window open slows down the archiving/dearchiving processes
  97. *considerably* (factors of 2 to 3 are possible). It is recommended to have it
  98. closed in your everyday use.
  99.  
  100. 'Old path' indicates the full original path up to and including the directory
  101. to be archived or being unpacked. 'New path', when unpacking, shows the full
  102. path of the directory being recreated (i.e. the old path when the 'Old path'
  103. option is on).
  104.  
  105. Also shown are :
  106.  
  107. - The 'local' filename of the current file or directory being (un)archived
  108. - The length of the last (archiving) or current (unpacking) file or directory
  109. - The number of compression bits (being) used
  110. - The compression ratio achieved on the last (archiving) or current (unpacking)
  111.   file or directory
  112. - The total file data compression ratio so far (archiving), or the total ratio
  113.   (unpacking, shown only at the end)
  114. - A count of items (files and directories) (un)archived so far (including the
  115.   top directory itself)
  116. - A red bar representing an amount of original file data processed so far, with
  117.   behind it an amount in bytes.
  118.   When archiving, a full bar represents the total amount of original file data.
  119.   The beige part of the bar represents the size of the current file being
  120.   archived. The amount shows the total amount of original file data in bytes,
  121.   and is not updated.
  122.   When unpacking, the bar is not updated. The amount shows the total amount of
  123.   original file data unpacked so far.
  124. - A green bar representing an amount of archived file data processed so far,
  125.   with behind it an amount in bytes.
  126.   When archiving, a full bar represents the total amount of original file data.
  127.   If viewed together with the red bar, the relative sizes of the archived file
  128.   data and the original file data, processed so far, may be observed. The
  129.   amount shows the total amount of archived file data accumulated so far.
  130.   When unpacking, a full bar represents the total archive file size. The beige
  131.   part shows the size of the part of the archive that is currently being
  132.   processed. The amount shows the total amount of archived file data processed
  133.   so far.
  134.  
  135.  
  136. -----------------
  137. - The main menu -
  138. -----------------
  139.  
  140. This menu, popped up by clicking MENU on PackDir's iconbar icon, contains a
  141. number of icons (some of which lead to submenu's/windows). The functions of the
  142. icons will be discussed below.
  143.  
  144. The main purpose of the main menu is to provide access to PackDir's control
  145. window (via the 'Control' icon), which contains (in groups) most of the
  146. available options and controls.
  147.  
  148. -----------
  149. | Control |
  150. -----------
  151.  
  152. Gives access to PackDir's control window, which contains most of PackDir's
  153. options and controls, divided into groups.
  154.  
  155. Clicking on this icon will make this window permanent (but it can be closed
  156. again by clicking on its close icon).
  157.  
  158. Several types of icons appear in the control window :
  159.  
  160. - Toggle icons. These are square, and clicking on them switches the
  161.   corresponding option on (red square in its middle) or off ('closed' box).
  162. - Radio icon sets. Icons in these sets are diamond shaped, and act like the
  163.   toggle icons, but only one of them may be on. Switching any one on will
  164.   switch off all the others in the same set (hence the name 'radio' icons).
  165.  
  166. The functions of the icons in the control window are discussed below. Icons are
  167. identified by giving their 'path', i.e. group name (name on the border
  168. surrounding the group), if appropiate followed by sub-category (medium grey
  169. heading), followed by the icon's own name, seperated by '|'s.
  170.  
  171. \\\\\\\\\\\\\
  172.  Compression  ***
  173. /////////////
  174.  
  175. This set of radio icons enables you to select the maximum number of bits used
  176. in LZW compression when archiving a directory.
  177.  
  178. There is a choice of none, 12, 13, 14, 15 and 16 bits. More bits usually
  179. results in better compression. This is especially true on large text files.
  180. When 'none' is selected, no compression is attempted.
  181.  
  182. The disadvantage of using more bits is that it also requires more memory to
  183. archive/unpack. In general, for compression (archiving) 12*2^bits and for
  184. decompression (unpacking) 9*2^bits bytes, i.e. from 48/36K for 12-bit up to
  185. 786/576K for 16-bit.
  186.  
  187. When memory allows, choose the lowest number of bits that yields the highest
  188. compression ratio. Experimentation is the key here.
  189.  
  190. \\\\\\\
  191.  Store  ***
  192. ///////
  193.  
  194. This set of radio icons deter