home *** CD-ROM | disk | FTP | other *** search
/ Set of Apple II Hard Drive Images / hard.hdv / HARD / UTILS / HFS.DOC < prev    next >
Encoding:
Text File  |  1990-08-23  |  10.3 KB  |  261 lines  |  [04] ASCII Text (0x0000)

  1. HFSLink   Version B.3 (beta)
  2. by Scott Blackman
  3.  
  4. Internet: blackman@phoenix.princeton.edu
  5.    Snail: Scott Blackman, 1717 Briarcliff Circle, Dalton, GA 30720
  6.  
  7. *** This is a test version!  Please report any bugs! ***
  8.  
  9.  
  10.  
  11. What is HFS Convert?
  12. --------------------
  13.  
  14. HFS Convert, as of this writing, converts files from a Macintosh HFS volume
  15. into two ProDOS files: one for the data fork and one for the resource fork.
  16. Multiple file selection and directory conversion are supported.
  17.  
  18. How do I use it?
  19. ----------------
  20.  
  21. Quickly:
  22. 1. Use "F" if necessary to set the destination ProDOS filetype/auxtype.
  23. 2. Use "P" if necessary to set the destination ProDOS prefix.
  24. 3. Use "T" to transfer files/folders.
  25.  
  26. If unsure, *** use SHRINKIT keys ***.
  27.  
  28.  
  29. Table of Contents
  30. -----------------
  31.  
  32. (you may search for the string <Num>.  <Title>, as the following numbered
  33.    lines appear exactly in their respective sections)
  34.  
  35. 1.  Main Menu
  36.        (Finding your Macintosh and ProDOS disks, and setting the prefix)
  37. 2.  Setting the Filetype
  38. 3.  About Transferring files (quick version)
  39. 4.  About those keys (Selection Notes)
  40. 5.  About the Conversion
  41.        (Volumes supported, handling directories, more)
  42. 6.  HFSLink Modify Program
  43.        (What is it, and do I need to use it?)
  44. 7.  Hardware Configuration
  45. 8.  Technical Information
  46. 9.  Revision History
  47. 10. Standard Stuff
  48.  
  49.  
  50. 1.  Main Menu
  51. -------------
  52.  
  53. The main menu presents five options: Transfer files, Filetype of Converted
  54. file, Set ProDOS Prefix, About HFSLink, and Quit.  The current Prefix is
  55. also on screen.  To select, you may use the up/down or left/right arrows,
  56. or press the first letter of the option.
  57.  
  58. To set the ProDOS prefix, select "ProDOS prefix".  Type the complete or
  59. partial pathname at the prompt.  Simply pressing RETURN aborts the
  60. process.
  61.  
  62. You do not need to tell HFSLink to find your Macintosh disk; it will scan
  63. the online volumes, prompting you as necessary, for insertion of an HFS
  64. disk.
  65.  
  66.  
  67. 2.  Setting the Filetype
  68. ------------------------
  69.  
  70. You may set the transfer filetype/auxtype by pressing "F".  In this version,
  71. you must type the hexadecimal value for filetypes.  Some common values are:
  72.  
  73. $04 TXT                 /  AuxType = record length (usually 0)
  74. $06 BIN                 /  AuxType = starting address
  75. $E0 NuFx (ShrinkIt)     /  AuxType = $8002
  76. $FF System file         /  AuxType = $2000 (starting address)
  77.  
  78. A file's filetype may also be changed by a number of shareware/freeware
  79. file utilities.
  80.  
  81.  
  82. 3.  About Transferring files (quick version)
  83. --------------------------------------------
  84.  
  85. After selecting "Transfer Files", the program will read your HFS disk and
  86. present a list of files.  At this point you may use the following keys:
  87.  
  88. up/down arrows                          Move the cursor bar up/down
  89. left/right arrows                       Move the cursor bar up/down
  90. ESC                                     Close Directory
  91. space                                   Select/Unselect current file
  92. RETURN                                  Open Directory or Start Transfer
  93. TAB                                     Read another HFS volume
  94. oa-A                                    Select/Unselect all files
  95. oa-G                                    "Go" - Start transfer
  96. oa-O                                    Online volumes
  97. oa-V                                    Volume Info (HFS or MFS)
  98. Period (".")                            Abort Transfer
  99.  
  100.  
  101. 4.  About those keys (Selection Notes)
  102. --------------------------------------
  103.  
  104. ESC will "pop" one directory off of the current path, moving back up one
  105. directory level on the disk.  If already in the root directory, this has
  106. no effect.
  107.  
  108. If RETURN is pressed when no files are selected, the operation will be
  109. performed only on the file beneath the cursor.
  110.  
  111. TAB will also reread the current device to see if the disk is switched.  In
  112. most respects, it behaves exactly as the Standard File Toolset in IIgs
  113. applications.
  114.  
  115. oa-A marks or unmarks every file.  If a file is marked, it will be unmarked,
  116. and vice versa.  For instance, pressing oa-A twice has no net effect.
  117.  
  118. oa-G "Go" is useful mainly to select directories conversion without opening
  119. them at the time of selection.
  120.  
  121. oa-O (Online volumes) presents a list of online volumes, allowing you to
  122. choose which volume to read.  Pressing oa-V or oa-I will give Volume Info of
  123. the volume under the cursor.
  124.  
  125. oa-V (Volume Info) presents information about an HFS or MFS volume (although
  126. conversion only reads HFS disks): Free Space and Volume size, Volume
  127. Operating system, Volume Created/Modified/Backed up dates.
  128.  
  129.  
  130. 5.  About the Conversion
  131. ------------------------
  132.  
  133. Conversion is supported for all HFS volumes from 800K 3.5" disks to 40 megabyte
  134. hard disks.  Although it is possible for an HFS volume to be unsupported, I
  135. have not had it happen to me.
  136.  
  137. Files and Directories selected undergo filename translation: all
  138. non-alphanumeric characters are replaced with periods ("."), and all lowercase
  139. characters are replaced with uppercase.  If a file does not start with a
  140. letter, the letter A is prepended to the name.  Filenames are truncated at 15
  141. characters if necessary.  Resource forks have ".R" appended to a 13-character
  142. truncated name.
  143.  
  144. Selection of a directory preserves the heirarchical structure.  A directory
  145. is created on the ProDOS disk, and files within that Macintosh folder are
  146. placed within the corresponding ProDOS directory.  Conversion of nested
  147. folders is supported.
  148.  
  149.  
  150. 6.  HFSLink Modify Program
  151. --------------------------
  152.  
  153. To provide greater support for hard drive reading, the HFSLink.Mod
  154. program will perform the following function:
  155.  
  156. On some hard drives, ProDOS may not recognize the partitioning, and the HFS
  157. volume will "start" at a block other than zero.  That is, information that is
  158. on logical block zero of the hard drive (according to a Macintosh), may be
  159. on block $80 of the ProDOS device, and the first $80 blocks may be taken by
  160. partitioning information.  In this case, the entire volume is shifted by $80
  161. blocks.  A modifying program is included with HFSLink to patch the HFS disk
  162. reading routines to add an offset to ALL HFS block requests.
  163.  
  164. As the only offset I have encountered is $80, that is the default.  The
  165. modifying program creates a temporary file in /RAM5/HFSTEMP (or any file, if
  166. you change the string DF$ in the program), which it then runs.  No other files
  167. are modified, and HFSTEMP may be deleted when finished.  The modified HFSTEMP
  168. will recognize the hard drive's volume if the offset is correct; however, it
  169. will NOT recognize "normal" HFS volumes, and you must re-run the unmodified
  170. HFSLink.
  171.  
  172.  
  173. 7.  Hardware Configuration
  174. --------------------------
  175.  
  176. The minimum hardware configuration is an Apple //e, 64K, with 80-column card.
  177. MouseText is optional but makes the displays nicer.  No 65C02 opcodes are used.
  178. One-drive systems are supported.
  179.  
  180.  
  181. 8.  Technical Information
  182. -------------------------
  183.  
  184. Conversion is very simply written.  Debugging diagnostics are still printed on
  185. the screen: the file's complete extent record, and several procedures are still
  186. output on the screen.
  187.  
  188. Errors: Internal errors are numbered much like Apple IIgs Toolbox Errors.  The
  189. number is $xxyy, where xx is the subroutine number, and yy is the error number.
  190. For a complete list of errors and subroutines, mail or email me and I'll send
  191. it to you.
  192.  
  193. Conversion Features:  Will correctly locate all extent records for all files,
  194. and for the Catalog Tree, even if it is necessary to read the Extents Tree.
  195. Arbitrary HFS volumes are supported.  Directory conversion is supported.  One
  196. drive systems are supported.
  197.  
  198. Bugs:  All *KNOWN* bugs have been worked out of the program, but if you can
  199. make anything STRANGE happen, let me know.
  200.  
  201.  
  202. 9.  Revision history
  203. --------------------
  204.  
  205. Beta 1: (3/31/90)      First release.  Conversion of any HFS file into
  206. /RAM5/TEMP.DATA and /RAM5/TEMP.RSRC supported.  Catalog Trees with extents
  207. in the Extents Tree _NOT_ supported.
  208.  
  209. Beta 2: (5/11/90)      Extents tree fully supported, for files and for the
  210. Catalog Tree.  HFS Device selection added (select a device other than slot 2,
  211. drive 1.  Some speedups in the B*Tree routines.
  212.  
  213. Beta 3: (7/09/90)      First widespread distribution.  MANY changes (in fact,
  214. basically a rewritten program) including: Creation of Main Menu.  File
  215. conversion into arbitrary pathnames. Alphabetical HFS directory list.
  216. Multiple file or directory selection.  Rewritten HFS Device selection.
  217. Windows.  A real read/write buffer.  Completely rewritten HFS tree handling
  218. routines.  Large volume (hard disk) support.  Centralized error handling.
  219. Along with many internal memory handling improvements and source code
  220. "improvements".
  221.  
  222. Beta 4a: (8/26/90)      Bug fixes: Allowed for conversion of empty directories.
  223. Added a CLC that was giving //c owners trouble (thanks "Ralpho" Carpenter).
  224. Fixed a bug in the "get next HFS volume" routine (thanks Joe Carlin).  Fixed
  225. a bug in the routine that creates a ProDOS-compatible filename (thanks Dan
  226. McGuirk).
  227.  
  228. Beta 4b: (9/02/90)      Bug fixes: Getting disk info from the "Volumes online"
  229. menu interfered with further HFS directory walking - fixed.  Better scrolling
  230. in HFSGetfile.  Internal cleanup of HFSGetfile and variable-length FileBuf
  231. entries (internal effects only).  Modification date and time displayed and
  232. preserved for files and directories during conversion.
  233.  
  234. Coming soon: Real prefix selection.  The ability to list Stuffit files.
  235. AppleSingle and AppleDouble support.  Automatic re-conversion of files with creator "pdos" (automagically gets the right filetype).  MFS support.  Summer
  236. may bring all of these (if Apple doesn't release the HFS FST first!).
  237.  
  238. Most importantly, this should WORK on all 800K HFS volumes, and convert any
  239. file you can throw at it.  If you find one that makes it choke, please _let
  240. me know_.
  241.  
  242.  
  243. 10. Standard Stuff
  244. ------------------
  245.  
  246. This program is FreeWare.  You may copy it and give it to your friends or
  247. upload it to information services as you please.  Please remember, however,
  248. that this is a beta revision: instead of payment, I ask that you tell me
  249. about the program.  If you find any bugs (especially one that makes conversion
  250. fail), TELL me!  If you'd like to see a feature, TELL me!  Or, if you like the
  251. program, I'd LOVE to hear that.
  252.  
  253. Maybe I need to say this, since I mentioned it: ShrinkIT is a registered
  254. trademark of L&L Productions, Inc.  ShrinkIT is by Andy Nicholas, and is
  255. available almost everywhere.
  256.  
  257.  
  258.  
  259. HFSLink Copyright (c) 1990 by Scott Blackman.  Any distribution of this program
  260. must include this documentation file.
  261.