home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / COMPRESS / A2Z16D.ZIP / A2Z.DOC next >
Encoding:
Text File  |  1989-03-11  |  8.5 KB  |  190 lines
  1. A2Z - The Ultimate ARC/PAK to ZIP converter
  2.  
  3. version 1.6
  4. 3/10/89
  5. by Ian McLean
  6.  
  7.  
  8. Program description
  9. -------------------
  10. A2Z is an archive to zip conversion program.  What does this mean?  Well, it
  11. will convert files with an ARC or PAK extention into equivalent ZIP files,
  12. thus (usually) saving disk space.  Here's some fun features to know and tell:
  13.  
  14.     .    Preserves original file date and time
  15.     .    Converts ARC/PAKs inside other ARC/PAKs inside other ARC/PAKs, etc,
  16.     etc, until everything's a ZIP
  17.     .    Nifty log file
  18.  
  19. And other features that will become apparent in the following documentation.
  20.  
  21. Calling syntax
  22. --------------
  23. Use this for reference, each parameter will be described in detail later:
  24.  
  25.   A2Z  [/A] [/B] [/C] [/Z] [/N] [/S=device] [/W=dir] [!filespec] [filespec]
  26.  
  27. /A  Append to log file      /C  Enter configuration
  28. /B  Batch mode              /Z  Check ZIPs for internal files
  29. /N  No log file             /S  Status log device
  30. /W  Work directory
  31.  
  32. !filespec   File path or path and name, search below this directory as well
  33. filespec    File path or path and name, search only this directory
  34.  
  35. The Log File
  36. ------------
  37. A2Z keeps a log file.  This log file is called A2Z.LOG and is put in whatever
  38. directory is current when A2Z is invoked.  Statistics of all files converted,
  39. not converted, and any errors are kept in the log file for later reference.
  40. When A2Z encounters an error, it will NOT pause: it will write it in the error
  41. log.  Normally, the log file is started anew each time you run A2Z.  That is,
  42. if it already exists, it is deleted.  However, if you enter a /A parameter on
  43. the command line, the log file is appended to if it exists.  This is good for
  44. resuming an interrupted conversion.  You can suppress the log file by entering
  45. a /N on the command line.
  46.  
  47. The Work Directory
  48. ------------------
  49. Normally, A2Z will make its work directories off the directory it's working
  50. on.  This is fine, except under multitasking environments, where you'll want
  51. to specify the work directory.  SO, you can, in your environment, set the
  52. variable A2ZWORK to point to a directory for A2Z to work in.  Do it like so:
  53.  
  54.     C:\> SET A2ZWORK=C:\WORK
  55.  
  56. A2Z will clean up any files it creates, so don't worry.  If you don't feel
  57. like setting an environment variable, you can type /W=[dir] on the command
  58. line.  If a /W parameter is present, it overrides any environment variable
  59. that may be set.
  60.  
  61. Batch Mode
  62. ----------
  63. When A2Z begins, it searches the disk to see how many files it has to convert.
  64. Then it displays some information so you can make a guess as to how long the
  65. conversion is going to take.  It then pauses for you to press a key.  If you
  66. run A2Z in, say, your BBS's daily event file, you don't really want it to pause
  67. for a key.  So, if you enter a /B on the command line, A2Z will not wait for a
  68. key to be pressed: it will begin converting immediately.
  69.  
  70. Configuration
  71. -------------
  72. Entering /C on the command line causes A2Z to enter its configuration mode.
  73. Here you must enter the paths and filenames for programs A2Z calls.  This is
  74. pretty self-explanatory.  The one thing you have to remember is to enter a
  75. FULL path and filename specification.  For example, PKXARC won't work; you'll
  76. have to enter C:\UTIL\PKXARC.EXE.  This can be a bit of a pain, but it's kinda
  77. necessary.  Here's what A2Z asks for:
  78.  
  79.    Path to:
  80.      PKZIP    PK Ware's ZIP program.  Must be version 0.80, at least.
  81.      PKUNZIP    PK Ware's UNZIP program.  Must be at least version 0.80.
  82.      PKUNPAK    PK Ware's unARC program.  PKXARC won't work!  You need at
  83.         least version 3.6.
  84.      PAK    NoGate consulting's ephemeral ARC program.  This adds a new
  85.         level of compression to normal ARCs
  86.  
  87.    Compression levels:
  88.      This is the level of compression to force when converting to ZIPs.
  89.      4 is the highest compression and consequentially takes longer.  1 is the
  90.      lowest level of compression and is almost instantanious.  ASCII is for
  91.      text files, binary is for program files.
  92.  
  93. When you're running the configuration, A2Z.EXE must be in the current
  94. directory.  You'll get an error message if it's not.  The reason for this is
  95. that A2Z writes the changes you make in configuration to its program file.
  96. I could have made A2Z look to see what directory it was found in, but this
  97. would have required at least DOS 3.1, and I didn't want to restrict that much.
  98.  
  99. If any of the information A2Z has is invalid, it will give you a message
  100. and enter the configuration again.
  101.  
  102. ZIPfile searching (/Z)
  103. ----------------------
  104. Normally, A2Z will search and convert only ARC and PAK files.  But, if you've
  105. run a previous version of this program that didn't convert internal ARCs, you
  106. probably have a few ZIP files on your drive with ARCs or PAKs in them.  So, if
  107. you enter a /Z parameter on the command line, A2Z will examine .ZIP files in
  108. the directories you specify and see if they have anything inside them that
  109. needs to be converted.  Handy, eh?  The /Z parameter does not override normal
  110. conversion.  A2Z will convert BOTH archives and, if needed, ZIPfiles with this
  111. option.
  112.  
  113. The Status Log (/S)
  114. -------------------
  115. Status log is a nifty feature that makes calling A2Z from a bulletin board
  116. system relatively easy.  Here's what it does:  If a user is online and you're
  117. dynamically converting to a ZIP file, you can keep him/her updated on what's
  118. going on.  Just add /S=COM1 (or /S=COM2, etc) to the command line and helpful
  119. updates will be sent to the comm port.  No path names are sent ever for
  120. security reasons.  Default for the status log is the device NUL.
  121.  
  122. Running A2Z
  123. -----------
  124. You can specify up to twenty directories and/or filenames to convert on the
  125. command line.  Some valid ones are:
  126.  
  127.     C:\PAS        all of directory C:\PAS
  128.     *.*        all files in current directory
  129.     D:\*.ARC    all files with extention ARC in directory D:\
  130.     THIS        all files THIS.* in the current directory
  131.  
  132. If you enter an ! before the path name (E.g, !C:\), A2Z will also search all
  133. directories off of the one you specified for files matching the ones you
  134. specified.  Here's some more examples:
  135.  
  136.     !D:\        all files in all directories on drive D:
  137.     !D:\*.*        same as above
  138.     !C:\PAS\*.ARC    all ARC files in path C:\PAS and below
  139.     !E:\A*.*    all files matching A*.* on drive E:
  140.  
  141. You may enter up to twenty of these on one command line, remember:
  142.  
  143.     !C:\ !D:\ !E:\    all files on drives C:, D:, and E:
  144.  
  145. A2Z will ONLY work on files with an extension of ARC or PAK.  If you specify
  146. the /Z parameter, A2Z will also work on ZIP files.  But you'll have to rename
  147. files that are archives but don't have the ARC or PAK extentions.  Sorry.
  148.  
  149. Interrupting conversion
  150. -----------------------
  151. With previous versions of A2Z you could just press Ctrl-Break anywhere in the
  152. program and exit cleanly.  Well, you can't anymore.  The recursive nature of
  153. the new conversion routines requires a little neater way of exiting.  So, you
  154. now have to press ESC to stop conversion.  Don't be dismayed when you press ESC
  155. and don't see anything happen - A2Z finishes the file it's on before stopping.
  156. If you do press control break, nothing will happen.  In a dire emergency, you
  157. can reboot your computer when A2Z is running and no data will be lost.  You
  158. will, however, have to remove several temporary directories that A2Z creates.
  159. They're called A2Z.$$$.  Also check for a file with the extension A2B.  That's
  160. a backup A2Z makes of the current file being worked on.
  161.  
  162. Notes
  163. -----
  164. Here's a good rule of thumb:  Find your biggest archive.  Multiply its unarced
  165. size by three.  Have that much free space on your drive.  A2Z will, of course,
  166. detect an error at any stage in the conversion process, so don't worry.
  167.  
  168. A2Z is public domain.  I have included the main source code and the source
  169. code for the interrupt handler.  If you have any questions, contact me at:
  170.  
  171.     Ian McLean            Voice phone:
  172.     3365 Timber Lake Road        (404) 428-7829
  173.     Kennesaw, GA
  174.     30144
  175.  
  176. I'm also available (usually) to do small systems programming on a contract
  177. basis.  [<--- Blatant plug]
  178.  
  179. Update history
  180. --------------
  181. 1.0  Initial release
  182. 1.1  Fixed a few bugs, improved windowing routines
  183. 1.2  A2Z wouldn't keep the origional archive date; 1.2 fixes this.
  184. 1.3  Full error protection added, A2Z.LOG is now kept, output cleaned up.
  185. 1.5  Full code rewrite and probably the last version that will be released.
  186.      Major changes, addition of internal arc/pak conversion, improved logging,
  187.      zip file checking, lotsa new stuff.  Read the docs for more details.
  188. 1.6  Nifty keen new features such as /S, /W, SET A2ZWORK=, and /N.  Also
  189.      pretended to clean up the code.
  190.