home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 9 Archive / 09-Archive.zip / ZOODOC.ZIP / ATOZ.DOC next >
Text File  |  1986-10-01  |  11KB  |  249 lines
  1.                                     ATOZ
  2.  
  3.                             A Conversion Utility
  4.                        Version 1.10 -- 1 October 1986
  5.  
  6.                                      by
  7.  
  8.                                 Rahul  Dhesi
  9.  
  10.  
  11.                                 INTRODUCTION
  12.  
  13. ATOZ is a public domain program that helps convert archives in other formats
  14. into ZOO format.  For each source archive to be converted, Atoz first
  15. invokes an external program (e.g. PKXARC.COM, ARCE.COM, or LUE.COM) to
  16. extract files from the source archive.  Then it invokes Zoo to create a Zoo
  17. archive from the extracted files.
  18.  
  19. Atoz's built-in safeguards give you full control over whether or not to
  20. proceed with creation of a Zoo archive after files have been extracted from
  21. each source archive.  After each set of files has been extracted, you may
  22. escape to DOS and examine the resulting files to make sure that extraction
  23. occurred without errors.
  24.  
  25. Optionally you can tell Atoz not to wait for your permission after extrac-
  26. ting each source archive, allowing you to convert a large number of files as
  27. an unattended job.
  28.  
  29. You can also ask Atoz to test the integrity of each Zoo archive after it is
  30. created, by invoking Zoo to extract all files from it.
  31.  
  32.  
  33.                                  USING ATOZ
  34.  
  35. You will need (a) a floppy disk or a hard disk subdirectory containing all
  36. the archives you wish to convert;  (b) a blank formatted floppy disk or an
  37. empty hard disk subdirectory for ATOZ to use as a scratch area;  and (c) a
  38. program that can extract all files from the archives that you wish to
  39. convert.
  40.  
  41. For example, to convert archives of the form *.ARC, you could use PKXARC.COM
  42. or ARCE.COM.  To convert archives of the form *.LBR, you could use LUE.COM.
  43.  
  44. Avoid trying to convert your only copy of an archive so that if something
  45. goes wrong, valuable data are not lost.
  46.  
  47. For the following example let's assume you are converting from ARC format
  48. and you are using PKXARC.COM to perform the extraction.  To convert LBR
  49. format files simply replace "ARC" by "LBR" in the following discussion and
  50. use LUE instead of PKARC.
  51.  
  52.  
  53. 1.   Converting on a Hard Disk
  54.  
  55. Make sure that all three of the following programs are in a subdirectory
  56. included in your DOS PATH variable so that they can be invoked from anywhere
  57. on the disk:  ZOO.EXE, ATOZ.EXE, and the extraction program (PKXARC.COM for
  58. this example).
  59.  
  60. Create two empty subdirectories anywhere on the disk.  One will hold the
  61. source files to be converted and also the newly-created Zoo archives.  The
  62. other will serve as a scratch area for Atoz.  For this example, we will use
  63. C:\SCR as a scratch area and we will let C:\TMP hold archives to be
  64. converted.
  65.  
  66. Into C:\TMP, copy all the *.ARC format archives that you wish to convert.
  67.  
  68. Now from the DOS prompt type the command
  69.  
  70.      atoz -source c:\tmp\*.arc -temp c:\scr -prog pkxarc
  71.  
  72. This tells Atoz to convert all files matching C:\TMP\*.ARC, to use C:\SCR as
  73. a scratch directory, and to invoke PKXARC for extraction.  Now proceed to
  74. step 3.
  75.  
  76.  
  77. 2.   Converting on a Floppy-Only System
  78.  
  79. Two disk drives are recommended.  (You can also perform the conversion on a
  80. one-disk system by creating subdirectories as with a hard disk.)
  81.  
  82. Into one disk drive (let's assume it's B:) put a blank formatted floppy
  83. disk.  ATOZ will use this as a scratch area.
  84.  
  85. Into the other disk drive (drive A: for this example) put a disk containing
  86. the following files:  (a) ATOZ.EXE;  (b) ZOO.EXE;  (c) the program to ex-
  87. tract files from *.ARC archives (PKXARC.COM for this example);  and (d) all
  88. the ARC format files to be converted.
  89.  
  90. To avoid disk full errors, there must be enough free space remaining on disk
  91. A: to hold the Zoo archives that will be created.
  92.  
  93. If you do not have a DOS PATH set, give the following command:
  94.  
  95.      PATH A:
  96.  
  97. which tells DOS to search drive A: for programs to run, even if the current
  98. disk happens to be B:.
  99.  
  100. Now from the DOS prompt type the command
  101.  
  102.      atoz -source a:*.arc -temp b: -prog pkxarc
  103.  
  104. This tells Atoz to convert all files matching A:*.ARC, to use disk B: as a
  105. scratch disk, and to invoke PKXARC to perform the extraction.  Now proceed
  106. to step 3.
  107.  
  108.  
  109. 3.   Performing the Conversion
  110.  
  111. Conversion proceeds as follows.  For each matching source archive, Atoz
  112. invokes the extraction program (here PKXARC) to extract that archive.  Then
  113. Atoz asks for permission from you to create a Zoo archive from the extracted
  114. files.  Type "Y" to tell Zoo to proceed with the creation of a Zoo
  115. archive or "N" to tell it to skip this particular set of extracted files but
  116. proceed with the next matching source archive.
  117.  
  118. At this point you can also type "D" to get a directory of the extracted
  119. files or "S" to get a DOS shell.  From the DOS shell you may give any DOS
  120. command as usual.  Type "exit" to return to Atoz.
  121.  
  122. Note:  To get the directory or to spawn a DOS shell, Atoz must be able to
  123. find the command interpreter COMMAND.COM.  Ordinarily, this means that the
  124. drive from which you originally booted the system must have a disk
  125. containing a copy of COMMAND.COM.  This can pose a problem only for floppy-
  126. only uses and the solution is to make sure that the disk in drive A:, used
  127. to hold the archives to be converted, also contains holds COMMAND.COM.
  128.  
  129. If memory is tight on your floppy-only system, you may find that the pres-
  130. ence of COMMAND.COM on the boot disk is necessary even if you never 
  131. request a directory listing or invoke a DOS shell.  This is a special
  132. feature of some IBM-specific versions of DOS.  (In technical terms:  a. Atoz
  133. uses the COMSPEC environment variable to find the command interpreter.
  134. b. Some versions of DOS require the transient portion of COMMAND.COM to be
  135. in memory in order to execute a new process.)
  136.  
  137.  
  138.                                OPTION SUMMARY
  139.  
  140.  
  141. Format:  ATOZ [-SOURCE] filespec [-TEMPORARY tempdir] [-PROGRAM progname]
  142.               [-[NO]BELL] [-[NO]WAIT] [-[NO]RENAME] [-[NO]TEST] [-HELP]
  143.  
  144. Capitalized words above are typed exactly as shown above or abbreviated to a
  145. hyphen plus enough letters to uniquely identify the word.  Thus -SOURCE may
  146. be written as -SOURC or -SOU or -S etc.  -TEMPORARY could be abbreviated
  147. to -TEMPOR or -TEMP or -TEM etc. but not to -TE since that could also mean
  148. -TEST.
  149.  
  150. Parameters may be given on the command line in any order.  A parameter may
  151. be repeated on the command line;  if so, the last occurrence of the param-
  152. eter is used.  Thus if multiple filespecs are given, only the last one is
  153. used.  The meanings of the parameters are as follows.
  154.  
  155. [-SOURCE] filespec
  156.      Specifies which file(s) to convert to Zoo format.  May contain the
  157.      usual wildcards "*" and "?".  The switch -SOURCE may be omitted but
  158.      a filespec must be present.
  159. -TEMPORARY tempdir
  160.      Name of an empty temporary (scratch) directory.  It is an error for the
  161.      scratch directory to be not empty.  If the scratch directory is not
  162.      specified on the command line, Atoz uses the value of the environment
  163.      variable ATOZ$TEMP.  If ATOZ$TEMP is not defined Atoz will also look
  164.      for the environment variables TEMP, TMP, ARCTEMP, and PKARCTMP in that
  165.      order and use the first one found.
  166. -PROGRAM progname
  167.      Name of program to run to extract source files.  If the name of the
  168.      program is not specified on the command line, Atoz uses the value of
  169.      the environment variable ATOZ$PROG.  Note:  if the extraction program
  170.      requires any parameters, e.g. "arc x", it cannot be specified on the
  171.      command line but may be specified as the value of ATOZ$PROG, e.g. with
  172.      the DOS command "SET ATOZ$PROG=ARC X".
  173. -WAIT or -NOWAIT (default is -WAIT)
  174.      Whether to ask permission before creating each Zoo archive.  After the
  175.      program invoked to extract files from the source archive has finished
  176.      execution, Atoz prints a message on the screen and waits for confirma-
  177.      tion from you before creating a Zoo archive. At this point, you may
  178.      type "Yes" or "Y" to give Atoz permission to proceed with the creation
  179.      of a Zoo archive.  However, if you observed an error occur during
  180.      extraction, you may type "No" or "N" to skip this set of extracted
  181.      files.  You may also type "D" to see a directory listing of the extrac-
  182.      ted files, or "S" to invoke a DOS shell, before deciding whether to
  183.      answer Yes or No.
  184. -BELL or -NOBELL (default is -BELL)
  185.      Whether to beep when asking permission.
  186. -RENAME or -NORENAME (default is -RENAME)
  187.      Whether to rename a source file to *.BAD if it could not be properly
  188.      converted to a Zoo archive.
  189. -TEST or -NOTEST (default is -NOTEST)
  190.      Whether to invoke Zoo to test each created Zoo archive by extracting
  191.      all files from it.
  192. -HELP
  193.      Gives a detailed help message.
  194.  
  195. Defaults may be changed by setting environment strings as "ATOZ$x=Y" or
  196. "ATOZ$x=N" where x is WAIT, BELL, RENAME, or TEST.  For example, the envi-
  197. ronment string ATOZ$RENAME=N changes the default to NORENAME.  Note that
  198. parameters typed on the command line take precedence over any environment
  199. variables.
  200.  
  201. Example:  To convert all ARC format files in directory C:\TMP, using
  202.      C:\SCR as a scratch area and using PKXARC to extract files, without
  203.      beeping, and with each Zoo archive being tested after creation:
  204.  
  205.      atoz -source c:\tmp\*.arc -temp c:\scr -prog pkxarc -nobell -test
  206.  
  207. To decrease the amount of typing, we could set environment variables thus,
  208. either from the keyboard or from our AUTOEXEC.BAT file:
  209.  
  210.      SET ATOZ$TEMP=C:\SCR
  211.      SET ATOZ$PROG=PKXARC
  212.      SET ATOZ$BELL=N
  213.      SET ATOZ$TEST=Y
  214.  
  215. If this has been done, the above command could be typed more briefly as:
  216.  
  217.      atoz -source c:\tmp\*.arc
  218.  
  219. or, since the switch -SOURCE may be omitted, simply as:
  220.  
  221.      atoz c:\tmp\*.arc
  222.  
  223.  
  224.                                ERROR RECOVERY
  225.  
  226. None of the fast archive/library extraction programs that I know of (except
  227. Zoo, and Ooz since version 1.10) correctly returns an error code if it
  228. detects an error, such as a CRC error, during extraction.  For this reason,
  229. Atoz cannot usually know whether or not extraction of files from the source
  230. archive was successful and must rely upon you, the user, to tell it.  If you
  231. are confident that no errors will occur during extraction of any of the
  232. specified source archives, you may set the environment string ATOZ$WAIT=N or
  233. give the -NOWAIT switch on the command line.
  234.  
  235. Regardless of the -NOWAIT and -NOBELL switches, Atoz will always beep,
  236. inform you, and wait for your permission to go ahead, if an executing
  237. program does return an error status.
  238.  
  239.  
  240.                               REVISION HISTORY
  241.  
  242. 1986/08/15     Initial release of Atoz 1.00, written as a batch file.
  243. 1986/08/16     Incompatibility with DOS 3.x documented and documentation
  244.                revised.
  245. 1986/10/01     Re-written as an executable file.  This is Atoz version 1.10.
  246.                This version should be compatible with all DOS versions of
  247.                2.10 and greater.  This documentation was also completely re-
  248.                written.
  249.