home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / util / arc / Repack3_3.lha / repack.doc.English next >
Text File  |  1995-12-01  |  13KB  |  312 lines
  1.     ********                                                   **
  2.     *********                                                  **
  3.     **     ***                                                 **
  4.     **      **                                                 **
  5.     **      **      ****      ** ****       *****       *****  **   **
  6.     **     ***     ******     ********     *** ***     ******* **  **
  7.     *********     **    **    ***   **     **   **     **   ** ** **
  8.     ********      **    **    **     **        ***    **       ****
  9.     **     **     ********    **     **     ******    **       *****
  10.     **     **     **          **     **    ***  **    **       ** **
  11.     **      **    **          **     **    **   **    **       **  **
  12.     **      **    ***   **    ***   **     **   **     **   ** **  ***
  13.     **      **     *******    ********     *** ***     ******* **   **
  14.     **      **      ****      ** ****       *** **      *****  **   ***
  15.                               **
  16.                               **
  17.                               **
  18.                               **
  19.  
  20.     *     *                 *
  21.     *     *
  22.      *   *   **   * *  **   *   ***  * **              **       ** 
  23.      *   *  *  *  **  *  *  *  *   * **  *            *  *     *  *
  24.      *   *  ****  *    **   *  *   * *   *              *        * 
  25.       * *   *     *      *  *  *   * *   *               *        *
  26.       * *   *  *  *   *  *  *  *   * *   *            *  *     *  *
  27.        *     **   *    **   *   ***  *   *             **   *   ** 
  28.  
  29.          Copyright (c) 1995 Andrea Vallinotto, All rights reserved.
  30.  
  31.  *** Repack 1.0 and 2.0 by Mat Bettinson of the Plot Hatching Factory '95  ***
  32.      *** Repack 3.0 and above by Andrea Vallinotto of Nowhere software ***
  33.  
  34. *_*_*_* PLEASE READ THE COPYRIGHT NOTICE AT THE END OF THIS DOCUMENT ! *_*_*_*
  35.  
  36.  
  37. ************
  38. *Disclamier*
  39. ************
  40.  
  41. There is no warranty for this software package. Although the author has tried
  42. to prevent errors, he can't guarantee that the software package described in
  43. this document is 100% reliable. YOU ARE THEREFORE USING THIS MATERIAL AT YOUR
  44. OWN RISK. The author cannot be made responsible for any damage which is caused
  45. by using this software package.
  46.  
  47. **************
  48. *Introduction*
  49. **************
  50.  
  51. What is Repack?
  52.  
  53. Repack stands for: Recursive Enhanced Pratical Archive Conversion Kit.
  54. (Everybody say "Ooohhh!" :-) )
  55.  
  56. Repack is quite simple. All it does is to extract most of the known archive
  57. types in the specified dir and repack with JFs LZX which is substantially
  58. better. It then deletes the original archives when the LZX archiving is
  59. finished.
  60.  
  61. Many other scripts already does this, but Repack has some options and
  62. capabilities that no other program has; most important, Repack will convert the
  63. archives RECURSIVELY! So, if you have an LHA archive that contains files like
  64.  
  65. file1
  66. file2
  67. dir1/file3
  68. file.lha
  69. dir2/file.zip
  70. file.arj
  71.  
  72. it will be converted to an LZX archive that looks like this:
  73.  
  74. file1
  75. file2
  76. dir1/file3
  77. file.lzx
  78. dir2/file.lzx
  79. file.lzx
  80.  
  81. Not bad eh ? :-)
  82.  
  83. In the distribution there's also a one-shot, single-file only version for BBS
  84. owners (has been succesfully tested on C-Net systems). Have a look at the script
  85. itself (repack.rexx.bbs) for more info and how to use it in BBS enviromnents.
  86.  
  87. ***************
  88. *Requirements:*
  89. ***************
  90.  
  91. To fully operate, Repack needs some programs and libraries; these programs
  92. are: SetDate, Filenote, Delete, Which (found in AmigaDos 1.x and up), LZX 1.21,
  93. lha (or lhx and even LZX registered), arc, unzip, unarj, unrar, zoo, hpack,
  94. xarc, pak, gzip, tar (or Gnutar or Detar); you can get these on Aminet or
  95. similar PD distributor.
  96.  
  97. Remember: since version 3.3, LZX version 1.21 or above is REQUIRED!
  98.  
  99. The libraries Repack needs are Rexxsupport.library, Rexxreqtools.library and
  100. Reqtools.library. As the (un)archivers, the libraries are not included in this
  101. package, but can be found on Aminet or FredFish.
  102.  
  103. A little note about the (un)archivers: Repack has been designed to work with
  104. the most used types of archivers known, and especially SOME VERSION OF THEM!
  105. This means that if you use an older or different version of any of the above
  106. programs, Repack may not work. A good rule is that newer versions always work,
  107. while older are not guaranteed to. Here are the version numbers of the
  108. supported unarchivers, so if you have an older version of any of these... BE
  109. CAREFUL!
  110.  
  111. Unzip 5.1          07.02.94
  112. Unrar 1.0e        ??.??.94
  113. Unarj 2.41         12.03.94
  114. Shrink 1.1        ??.??.92
  115. Xarc            (first and only version)
  116. Zoo 2.1            09.07.91
  117. Arc 0.23         03.14.87
  118. Hpack 0.79a0         01.05.93
  119. Pak 1.00        02.11.87
  120. Gzip 1.2.4        18.08.93
  121. One of: Tar ??, GnuTar ??, Detar 1.2 (28.3.95)
  122. One of: Lha 1.48, Lhx 1.33, LZX 1.21 registered
  123.  
  124. Some notes about Lha archives: the registered version of LZX can extract Lha
  125. archive as well, so if you are a registered user of LZX you don't need to have
  126. Lha or Lhx to make Repack work. If you don't have LZX reg. , Repack will
  127. fallback to Lhx and then to Lha.
  128. A similar scheme applies to Tar archives: Repack will first try Tar, then Gnutar
  129. and Detar as last.
  130.  
  131. ***************
  132. *Installation:*
  133. ***************
  134.  
  135. Copy the script (repack.rexx) to a suitable directory (REXX: is usually a good
  136. choice), and if you want the "omit and add-file" feature, copy 'repack.ano' in
  137. s: (see below for further infos).
  138. It's ABSOLUTELY NECESSARY that you copy the script in a directory whose name
  139. doesn't contain white spaces (' '), otherwise the recursion won't work. This is
  140. an Arexx problem, not Repack's!
  141.  
  142. In the header of the file, there's the only line you can freely change: it's the
  143. groupsize parameter, which determine the value passed to LZX in for the -M
  144. option (see LZX docs!).
  145.  
  146. ********
  147. *Usage:*
  148. ********
  149.  
  150. -- Dopus v4.12:
  151.  
  152. Label a new button 'Repack', click on 'new entry', select AmigaDos (NOT Arexx!)
  153. and put in the command line: 'Rx repack "{s}" "{d}"'. This way Dopus will
  154. instruct Repack to convert the files in the source directory, using the
  155. destination directory as temporary dir.
  156.  
  157. -- Shell (or similar):
  158.  
  159. Template:
  160. Repack.rexx DIR-FILE/K,TEMPDIR/K,EFF./N,BBSMODE/S,DIR.RECURSION/S
  161.  
  162. Repack.rexx [Dir/File] [Temp dir] [(eff.)1|2|3] [(bbsmode)on|off] [(rec.)on|off]
  163.  
  164. Example:
  165.  
  166. rx Repack dh0:temp/a dh0:temp/b 3 ON ON
  167.  
  168. will repack each file in directory dh0:temp/a using dh0:temp/b as the temp dir.
  169. The efficiency will be maximum and both the BBS mode and directory recursion
  170. will be enabled.
  171. If you don't provide any of the above parameters, a Reqtools requester will
  172. appear for each, enabling you to make your choice.
  173. Please keep in mind that even through the template looks like a standard
  174. AmigaDos template you *CANNOT* use keywords like TEMPDIR or BBSMODE. Repack
  175. will use the parameters supplied ONLY in the order described above!
  176.  
  177. Explanation of parameters and features:
  178.  
  179. --- Dir-File: This is the directory Repack will scan looking for archives to
  180. convert, also called the source directory. It's the only directory that will be
  181. changed when the repacking process will be finished (unless you have set the
  182. Directory-recursion switch - see below).
  183. Although Repack was originally meant for BBS owners who needed to convert
  184. entire directories, this new version has been kluged to support also single
  185. file selection. Since this was not the Repack's original goal, this option is
  186. valid ONLY FROM THE COMMAND LINE!
  187.  
  188. --- Temp dir: This is the directory Repack will use to unpack the archives while
  189. converting. Unlike the previous versions, this directory *doesn't* need to be
  190. empty, but as always remember that it should have PLENTY of space: it must
  191. accomodate the largest extracted archive, and this becomes very critical when
  192. you convert files composed of many sub-archives, so be careful!
  193.  
  194. --- Efficency: It's the efficency for LZX. Have a look in LZX manual for more
  195. explanation. Note that you can speed the repacking up some by using a low mode
  196. setting (fast or default); even on 1 (fast), it will still be better than LHA
  197. and considerably faster. In mode 3, LZX has proven to be better than ANY common
  198. archiver, surpassing in compression both RAR and ARJ !
  199. (GZip and Shrink are still the best on single files, but they are much slower.)
  200. If you are a registered user of LZX, Repack will let you choose also the
  201. cpu-killing mode 9, called 'Maximum compression' in LZX.
  202.  
  203. --- BBS mode switch: When enabled, Repack will set the date, time and comment
  204. of the new .LZX archive as the old one. This could be useful for some bbs
  205. (like C-Net and DLG) that will get otherwise confused by the comment and date
  206. changes.
  207. Note: in this mode there's a potential bug, caused by the syntax of the
  208. Filenote command: if some moron included in a file comment one or more quotes
  209. ( " ), Filenote will get confused, resulting in an incomplete comment. This
  210. problem could be addressed a future release of Repack, if it is really
  211. necessary.
  212.  
  213. --- Directory recursion switch: this is the classical 'recursion' mode; when
  214. enabled Repack will recurse into sub-directories looking for archives to
  215. convert. Please keep in mind that this works IN SINGLE FILE MODE ALSO!! 
  216.  
  217. --- Repack.ano: (Repack-Add'n'Omit) This is a text file that must be placed in
  218. S: in order to work. It contains the file names Repack will omit from the
  219. original archive and/or add to the repacked one. This file has its own syntax:
  220. every line beginning with a semicolon ( ; ) will be considered comment and thus
  221. skipped. Aside from the semicolons, two fields are supported, each one beginnig
  222. with a keyword (either 'ADD:' or 'OMIT:') and ending at the end of the file or
  223. at the other keyword.
  224. Every file name in the 'ADD:' field will be added to the new archive. This
  225. option was made for BBS Sysops who may wish to add a BBS.displayme file to the
  226. repacked archives.
  227. Every file name in the 'OMIT:' field won't be repacked; the omit function is
  228. useful if you want to get rid of #?.displayme or file_id.diz kind of files that
  229. BBS Sysops adds using the ADD: keyword :-)))
  230. Both function support wildcards (as long as are supported by Delete and Copy
  231. commands). Have a look at the file (s/repack.ano) for some examples.
  232.  
  233. General instructions:
  234.  
  235. The script is also smart enough (WOW!) to keep track of the archive sizes:
  236. sometimes, when archives have few small files, it could happen that some
  237. archives are smaller than LZX ones. In this case, Repack will leave the
  238. original archive intact, and scrap the longer LZX's.
  239.  
  240. If an error occurs when operating, Repack will tell you what happened and
  241. leave the original archive intact. However, keep in mind this feature relies on
  242. the de-archivers behavior upon error: some of the older won't signal if
  243. something goes wrong, and you may lose some files. THIS IS NOT REPACK'S FAULT!
  244.  
  245. For the few who might need it, I've also implemented a log file, that can be
  246. found in t:, name (guess what?) 'Repack.log'.
  247.  
  248. It's generally a good idea to have the temp drawer on another drive other
  249. than the partition that you are repacking on. Why? Because it will lower disk
  250. thrashing and because for a reasonable drawer full of LHA archives, Repack
  251. can take quite some time indeed depending on the speed of your machine...
  252.  
  253. If you have plenty of memory and are going to convert many files, I suggest you
  254. make resident LHA (if you need it - see above under requirements), LZX and the
  255. other unarchivers; this way, disk access will be reduced to minimum, and you'll
  256. gain a reasonable amount of speed.
  257.  
  258. That's all folks, enjoy!
  259.  
  260. *********
  261. *Thanks!*
  262. *********
  263.  
  264. Many thanks to:
  265.  
  266. my brave betatesters:
  267. Jan Pasotto
  268. Angelo Verdone
  269. Marco Bielli
  270. Gino Casavecchia
  271.  
  272. J.Forbes for LZX
  273.  
  274. William S. Hawes for Arexx
  275.  
  276. Mat Bettinson for Repack v 1.0-2.0
  277.  
  278. Rafael D'Halleweyn for Rexxreqtools.library
  279.  
  280. Nico François for Reqtools.library
  281.  
  282. and Jay Miner, for having made a dream become true.
  283.  
  284. Curses to:
  285. Commodore, for having almost fu**ed that dream.
  286.  
  287. *******************
  288. *Copyright notice:*
  289. *******************
  290.          _ ___
  291. V1.0-2.0 by /\/\(-) |  Fido: 2:254/205.0 & E-Mail: mat@darkside.demon.co.uk
  292.  
  293. V3.0 and up by A. Vallinotto : Fido 2:334/21.13  AmigaNet 39:101/402.13
  294. E-Mail (Fidonet gateway): Andrea.Vallinotto@p13.f21.n334.z2.fidonet.org
  295.  
  296. Versions 1.0-2.0 of this program were a freeware production by Mat Bettinson.
  297. Since the current version is an evolution of Mat's code, I release it as
  298. completely FREEWARE. (However any donation is appreciated, like a 2-gigabytes
  299. SCSI-2 HD :-) )
  300. PD distributors such Aminet and Fish are allowed to distribute this software.
  301. However, ANY other commercial use of this package without the prior written
  302. consent of the author (Andrea Vallinotto) is expressly PROHIBITED.
  303.  
  304. Feel free to contact me for any suggestions, ideas, etc. at the address above.
  305.  
  306. And... if you have a nice sister, give her my address!
  307.             ^^^^^^^^^^^^
  308. This is a new form of payment for software, which I hope to use in next
  309. productions. It will be named SISTERWARE! :-)))))
  310. ******************************************************************************
  311.  
  312.