home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 129 / af129a.adf / YADI20.lzx / YADI20 / yadi.doc < prev    next >
Text File  |  1979-05-30  |  10KB  |  285 lines
  1.  
  2.  YADI  -  Yet Another Disk Imager v2.0
  3.  =====================================
  4.  
  5.  
  6.  
  7.   YADI  ia  a  small  cli-only  program to transfer disk images to and from
  8. Amiga devices.  A disk image is a file that contains the raw data as stored
  9. in  an  AmigaDOS device.  YADI is useful to store NDOS disks as files, make
  10. backups of devices, transfer Amiga disks to Amiga emulators, transfer Amiga
  11. disk images used in the emulators (ADF/ADZ files) back to Amiga disks, etc.
  12. Why another disk imager ?  Because the others suck.
  13.  
  14.  
  15.  
  16. YADI features:
  17. --------------
  18.  
  19.   A  single program handles creation of disk images and also writes them to
  20. devices.
  21.   Supports  any  AmigaDOS  device,  of  any  size,  that supports trackdisk
  22. compatible commands, using any filesystem.  This includes standard DF0:  to
  23. DF3:   (low  or  high  density),  Cross-DOS  devices  like  PC0:, Cross-Mac
  24. devices, diskspare devices, RAD:  , hard disk partitions, ZIPs, etc.
  25.   You  supply  the  AmigaDOS  device name, i.e., DF1:, not trackdisk.device
  26. unit 1; RAD:, not ramdrive.device.
  27.   It  is  safe.   It  won't  let  you write a disk image over a device of a
  28. different  size.   So  you  can't write by accident a 880kb disk image over
  29. your hard disk partition.
  30.   Works in any Amiga with kickstart 1.3 (and maybe even 1.2) or newer.  But
  31. uses 2.0+ functions if available.
  32.   Is public domain.
  33.  
  34.  
  35. New features in version 2.0:
  36. ----------------------------
  37.  
  38.   Supports internal compression and decompression of disk images using gzip
  39. compatible  algorithm  (uses  zlib  by  Jean-loup  Gailly).   Now  you  can
  40. decompress directly the so called ADZ files and also generate them.
  41.   Supports  decompression  of  DMS  files,  calling  the xDMS utility (also
  42. written by me).  xDMS is available in Aminet in the directory util/arc.
  43.   Supports enhanced control in the case of read/write errors.
  44.   Supports batch reading/writing of several disk images.
  45.   Can  show  informations  about the device geometry, needed if you want to
  46. mount the disk image as a hardfile.
  47.  
  48.  
  49. Notes:
  50. ------
  51.  
  52.   To  install  it  in your system, just copy the yadi executable to your C:
  53. directory or somewhere else in your path.
  54.   The  reading/writing  operation  can  be aborted at any time, by pressing
  55. Ctrl+C.
  56.   Please  note  that YADI is unable to read the data from floppy disks that
  57. use  tracks  encoded  in  a  special  format, like the ones used in several
  58. copy-protected  games,  because it would need knowledge about the low level
  59. MFM  encoding  of  each  different game disk.  You can use YADI to read the
  60. data  from some copy protected disks to use it with game HD installers, but
  61. only  if  the  special  track  is not really needed (does not contains game
  62. data)  and is ignored by the loader/installer.  Future versions of YADI may
  63. support a limited form of reading/writing of MFM level data in Extended ADF
  64. format.
  65.   Also, to read/write data from/to a floppy in a foreign format, the device
  66. must  be  apropriately  mounted (i.e.  to make disk images from MSDOS disks
  67. you need CrossDOS installed).
  68.  
  69.  
  70.  
  71. Usage:
  72. ------
  73.  
  74. YADI must be executed from the CLI.  It has the following usage template:
  75.  
  76.  
  77.  yadi [options] <command> [disk_image] <device>
  78.  
  79.  
  80. A command is indicated by a letter (case insensitive) and can be one of the
  81. following:
  82.  
  83.  
  84.      r  :   reads  the  data from the device, generating a disk image file.
  85. You must supply the disk image name and the device name.
  86.  
  87.  
  88.      w  :   writes a disk image to device.  The type of the disk image will
  89. be  auto-detected  and decompressed if needed.  It will recognize raw files
  90. and  files  compressed  with  gzip  or  DMS.  The detection is based in the
  91. content and size of the file, not in the extension.  You can only write the
  92. file  data  to  a  device of the same size, for security reasons.  You must
  93. supply the disk image name and the device name.
  94.  
  95.  
  96.      i  :   shows  informations about the device geometry.  You must supply
  97. only  the name of an AmigaDOS device.  You will need that information to be
  98. able  mount  the disk image as a hardfile.  The UAE Amiga emulator supports
  99. hardfiles  (disk  images from hard disk partitions).  You can also mount it
  100. in  the  Amiga using some device drivers available in Aminet.  Using YADI I
  101. made a disk image of my entire system partition, tranfering it to a PC over
  102. the  parallel  port  (using  PC2Amiga)  and  successfully  mounted  it as a
  103. hardfile under UAE.
  104.  
  105.  
  106.  
  107. You can also supply one or more (or none) of the following options:
  108.  
  109.  
  110.     -c  :   using this option, the generated disk images will be compressed
  111. using an algorithm/file format compatible with gzip.
  112.  
  113.  
  114.     -a  :   will  ask for a user action in the event of a read/write error,
  115. after  all  retries  have failed.  By default after all retries have failed
  116. YADI will skip the faulty track and display a warning message.
  117.  
  118.  
  119.     -q :  quiet operation.  Does not shows standard messages.
  120.  
  121.  
  122.     -n<nn>  :   sets  the  number of disks to be read or written in a batch
  123. operation.   <nn> can be any value from 1 to 1000.  In this mode, YADI will
  124. ask  you to insert every disk from 1 to <nn> and for each one it will write
  125. or  read  from  a  disk  image  file whose name will be generated using the
  126. [disk_image]  parameter that you supplied as a template.  You can use the #
  127. character  in the name to specify the position and minimum number of digits
  128. of  a  counter  number  to  be  inserted  in  the disk image filename.  See
  129. examples below for more informations.
  130.  
  131.  
  132.     -t<nn>  :   number  of  retries :  set the maximum number of times YADI
  133. will  retry  to read or write a track in the case of an error.  <nn> can be
  134. any  value  from 0 to 99.  Default is 1.  Very useful to read data from old
  135. floppy disks.
  136.  
  137.  
  138.     -s<nn>  :   starting  cylinder  to be read or written in the operation.
  139. Can be any value from 0 to the number of cylinders in the device minus one.
  140. This  value  is  relative  to the start of the partition (i.e.  the minimum
  141. value  is  0  even if it is not the fisrt partition in the drive).  Default
  142. value is 0.
  143.  
  144.  
  145.     -e<nn>  :   last  cylinder  to  be read or written.  Can range from the
  146. starting cylinder to the number of cylinders in the device minus one.  This
  147. value  is relative to the start of the partition.  The default value is the
  148. number  of  cylinders in the device minus one.  Standard Amiga floppy disks
  149. have 80 cylinders, so its cylinder numbers vary from 0 to 79.  Using the -s
  150. and/or  -e options, you can split a disk image in two or more files, if you
  151. need  to transfer it to another computer using a disk or other device where
  152. the entire file wouldn't fit.  Later you can re-join the parts.
  153.  
  154.  
  155.  
  156.  
  157.  
  158. Examples:
  159. ---------
  160.  
  161.  
  162. yadi r tst.dsk df0:
  163.  
  164. Will  read  the  contents  of the disk in drive DF0:  and save it as a disk
  165. image file in the current directory with the name tst.dsk .
  166.  
  167.  
  168.  
  169. yadi -c -t10 -a r tst.adz df0:
  170.  
  171. Will  read  the  contents  of  the  disk  in  drive  DF0:  and save it as a
  172. compressed disk image file in the current directory with the name tst.adz .
  173. It  will  retry up to 10 times to read a track with a read error, and if it
  174. fail 10 times it will ask the user to continue/cancel.
  175.  
  176.  
  177.  
  178. yadi -e39 -q r tst_p1.adf df0:
  179.  
  180. Will  generate  a disk image containing the data from the first half of the
  181. disk  in  device  DF0:   with  the  name  tst_p1.adf .  No messages will be
  182. displayed.
  183.  
  184.  
  185.  
  186. yadi -s40 -e79 r tst_p2.adf df0:
  187.  
  188. Will  generate a disk image containing the data from the second half of the
  189. disk in device DF0:  with the name tst_p2.adf .
  190.  
  191.  
  192.  
  193. yadi w ram:AmigaDemo.ADF rad:
  194.  
  195. Will write the disk image ram:AmigaDemo.ADF to RAD:
  196.  
  197.  
  198.  
  199. yadi w NiceGame.ADZ df0:
  200.  
  201. Will  write  the  disk  image NiceGame.ADZ to df0:, decompressing it in the
  202. process.
  203.  
  204.  
  205.  
  206. yadi w NiceGame.DMS df0:
  207.  
  208. YADI will call the xDMS utility, if installed, to convert the DMS file to a
  209. temporary  disk  image.   Then  YADI  will write the disk image to the DF0:
  210. device  and  delete  the  temporary  file  afterwards.   Note  that it will
  211. generate  a  880kb  temporary file to the directory assigned to T:  (usualy
  212. assigned  to a directory in RAM disk).  If don't have much free RAM, assign
  213. T:   to  a  directory in your HD.  (Or just use DMS/UNDMS to decompress DMS
  214. files ;) )
  215.  
  216.  
  217.  
  218. yadi r dh1:Sys_Hardfile dh0:
  219.  
  220. Will  save  a  image  of your entire DH0:  partition as Sys_Hardfile in the
  221. root directory of your DH1:  partition.
  222.  
  223.  
  224.  
  225. yadi i dh0:
  226.  
  227. Will  display  informations  about  your  DH0:  device, including number of
  228. heads, blocks per track, number of cylinders, etc.
  229.  
  230.  
  231.  
  232. yadi -n12 r MyBigGame#.img df0:
  233.  
  234. Will  generate  12 disk images, asking you to insert each disk in the drive
  235. DF0:  The first file will be named MyBigGame1.img, the last MyBigGame12.img
  236.  
  237.  
  238.  
  239. yadi -n12 r MyBigGame##.img df0:
  240.  
  241. Will  generate  12 disk images, asking you to insert each disk in the drive
  242. DF0:    The   first   file   will   be   named  MyBigGame01.img,  the  last
  243. MyBigGame12.img .
  244.  
  245.  
  246.  
  247. yadi -n12 w MyBigGame##.img df0:
  248.  
  249. Will  write 12 disk images back to disks, asking you to insert each disk in
  250. the  drive  DF0:   The  data  for the first disk will be read from the file
  251. named MyBigGame01.img, the last from MyBigGame12.img .
  252.  
  253.  
  254.  
  255.  
  256. How to contact me:
  257. ------------------
  258.  
  259. If  you  have  any  question,  comments or have found a bug in YADI you can
  260. contact me by e-mail.
  261.  
  262.  
  263.                 André Rodrigues de la Rocha
  264.                 E-mail address:  adlroc@usa.net
  265.  
  266.  
  267.  
  268.  
  269. History:
  270. --------
  271.  
  272.  
  273. Version 2.0 :  Major update.  Added compression support and other features.
  274.  
  275. Version 1.1 :  Fixed a bug present in the previous version.  When trying to
  276. read a disk image from a disk with a faulty or strange track, like the ones
  277. used  with  most  copy-protected  games, it used to skip the error, but the
  278. resulting  file  was  smaller  than it should be, making it useless to make
  279. disk images for game installers and other aplications.  Fixed.
  280.  
  281. Version 1.0 :  First release.
  282.  
  283.  
  284.  
  285.