home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 98 / af098sub.adf / abeeb.LZX / ABeeb / Roms / README next >
Text File  |  1997-01-09  |  8KB  |  208 lines
  1. 1. *CAT (<drive>)
  2. -----------------
  3.  
  4. XDFS now supports the number of times written to the disc BCD cycle count and
  5. the boot up options (although I haven't put SHIFT - BREAK boot up in yet).
  6. You will need to add 1 line to the top of all your catalogs giving the
  7. number of times the disc has been written to (BCD, 2 characters) and the
  8. disc boot up option (1 character between 0 and 3 inclusive). Eg.:
  9.  
  10.     44 0
  11.     $.Hopper      FF2000 FF4800 002A00 FFF
  12.     $.HopLScr     FF5800 FF5800 002800 FFF
  13.     $.HopLdr      FF0E00 FF802B 000191 FFF
  14.  
  15. XDFS uses part of the start sector as a locked flag indicator. If you want
  16. files unlocked, set the start sector to 0x3ff or lower. Note that *ACCESS has
  17. not been implemented yet (even though it appears on *HELP DFS). If you want
  18. to lock or unlock a file in xbeeb then use the relevant OSFILE call.
  19.  
  20. *CAT outputs the disc catalog on the xbeeb screen as in the Acorn DFS roms.
  21. The current working directory (set with *DIR) is displayed first, followed by
  22. the remaining directories. You cannot have more than 31 files in a directory.
  23. Be careful not to put any redundant newlines at the end of the __CATALOG__
  24. file otherwise you will get some strange output.
  25.  
  26. The single parameter supplied is the drive number (0-3 inclusive) that you
  27. wish to catalog. This number is meaningless and is only implemented for the
  28. sake of compatability. A Bad Drive error is generated if the drive is not in
  29. the range 0-3 inclusive. There is a bug in the *CAT in all Acorn DFS roms that
  30. allows you to enter:
  31.  
  32.     *.0 Blobby Blobby Blobby
  33.  
  34. ie.: only the first character is being checked. This feature is also
  35. implemented in XDFS.
  36.  
  37. If no parameter is supplied, then the currently selected drive (selected with
  38. *DRIVE or *DIR) is used.
  39.  
  40.  
  41.  
  42. 2. *HELP
  43. --------
  44.  
  45. XDFS responds to *H.., *HELP DFS and *HELP UTILS. In each case a list of star
  46. commands the rom responds to is printed in the xbeeb screen. Along with most
  47. functions in XDFS no case checking is done, so things like *HElp utILs will
  48. work.
  49.  
  50.  
  51.  
  52. 3. *DRIVE <drive> (40/80)
  53. -------------------------
  54.  
  55. This command is provided to provide compatibility with those programs written
  56. for Acorn DFS v 2.00 and above. The drive is a single digit in the range 0-3
  57. inclusive. The second parameter is optional but is parsed if supplied, so 
  58. *DR. 0 52 is not allowed. Wherever possible the errors generated are the same
  59. as the Acorn ones with the same error numbers, but I have invented some of my
  60. own.
  61.  
  62.  
  63.  
  64. 4. *DIR <dir>
  65. -------------
  66.  
  67. This command is identical to the Acorn DFS version. All further occurances of
  68. *LOAD, *RUN, *EX, *DELETE, etc will occur on the directory specified.
  69.  
  70.     *DIR :1   - Sets drive to 1, directory unchanged.
  71.     *DIR P      - Sets directory to P, drive unchanged.
  72.     *Dir :2.O - Sets the drive to 2 and the directory to O.
  73.  
  74.  
  75. 5. *LIB (<dir>)
  76. ---------------
  77.  
  78. This command is identical to the Acorn DFS version. Any *commands unrecognised
  79. by the system will be checked against the currently selected directory and then
  80. the library directory. Any parameters not supplied are set to those as given
  81. by the last *DIR command (as DFS v 2.45).
  82.  
  83.     *DIR :1.Q - Sets the drive to 1 and the directory to Q
  84.     *LIB :0.W - Sets the library drive to 0 and directory to W
  85.     *LIB P    - Sets the library drive to 1 (currently selected drive)
  86.                 and the library directory to P.
  87.  
  88. Note that the internal flags and pointers used by XDFS are identical to Acorn
  89. DFS v 0.90. So, if anyone's illegally changing directory by ?&10CA=ASC"$" this
  90. will work. The tube not present flag is also set but not used. A list of flags
  91. and pointers used by Acorn DFS v 0.90 is given in the Advanced Disc Users Guide.
  92.  
  93.  
  94.  
  95. 6. *DISC, *DISK
  96. ---------------
  97.  
  98. This command selects the XDFS. The library and currently selected directories
  99. are set to :0.$ and the tube not present flag is set. This command jumps into
  100. the OS ROM quite a bit and won't work on any OS before OS 1.00 (but then and
  101. again, if you're trying to run xbeeb with OS 0.1 then you really are sad).
  102. This command is also issued when the XDFS ROM initialises, either if XDFS is
  103. the highest priority filing system or the 'D' key is held down on a BREAK.
  104.  
  105. Note that *D. is equivalent to *DISC (as Acorn DFS up to 2.10) and not *DUMP
  106. (as on the Master DFS v 2.24 and 2.45).
  107.  
  108.  
  109.  
  110. 7. *ROMS (<rom id>)
  111. -------------------
  112.  
  113. This command is quite different to the Acorn DFS version, although the output
  114. is similar to that is DFS releases 1 and 2. The parameter supplied is a rom
  115. id in the form of a string or a number 0-15 inclusive.
  116.  
  117. If no parameters are given then all ROMS are cataloged. If the ROM is a bank
  118. of sideways RAM then this will be identified as Ram. Note the new RomSelect.c
  119. required to make this feature work. The ROMs name and version number are also
  120. printed.
  121.  
  122. If the parameter supplied is a number in the range 0-15 inclusive then that
  123. ROM bank is cataloged. If the socket does not contain a valid ROM then no
  124. output will be given.
  125.  
  126. Otherwise the parameter is taken to be a ROM title string, eg.: DFS. All ROMs
  127. titled DFS will be cataloged. It is only necessary to enter the first word, so
  128. *ROMS Acorn will catalog Acorn ADFS and Acorn ANFS. Again, no case checking
  129. is made (unlike Acorn's version) so *ROMS BASIC and *ROMs baSIc will give the
  130. same result.
  131.  
  132. In either case, if the ROM cannot be identified then the error Bad ROM id will
  133. be generated. This may give some compatibility problems at this point as
  134. Acorn's version gave no error.
  135.  
  136.     >*ROMS
  137.     Rom 15 : ( L) BASIC
  138.     Rom 10 : (S ) DFS 0.70
  139.     Rom 09 : (S ) SLAVE  1.34
  140.     Ram 04 : (S ) DISC DOCTOR  1.0B
  141.     Rom 02 : (SL) ViewSheet B1.0
  142.     Rom 01 : (SL) VIEW
  143.  
  144. Notice that bank 4 in the example above is declared as Ram.
  145.  
  146.     >*roms 9
  147.     Rom 09 : (S ) SLAVE  1.34
  148.  
  149.     >*ROMS VIEWSHEET
  150.     Rom 02 : (SL) ViewSheet B1.0
  151.  
  152.  
  153. 8. *EX (<dir>)
  154. --------------
  155.  
  156. This command is identical to the command provided in Acorn's DFS v 2.00 and
  157. above. The contents of the specified directory are given with their load,
  158. execution, length and start sector. If no parameter is given then the
  159. currently selected directory is used.
  160.  
  161.  
  162.  
  163. 9. *NEWDISC, *NEWDISK <Unix dir>
  164. --------------------------------
  165.  
  166. This command changes the current disc used by xbeeb. Its single parameter is
  167. a Unix directory relative to the XBEEBROMS define in Config.h. This is the
  168. only command in the ROM that is case sensitive, since Unix is case sensitive,
  169. and Acornsoft and acornsoft could be two different directories.
  170.  
  171. If the directory does not exist or it does not contain a readable __CATALOG__
  172. file then the error Bad Unix disc is generated. The old disc is no longer
  173. selected. The title of the disc is taken to be the directory given to the
  174. *NEWDISC command.
  175.  
  176.     *NEWDISC Acornsoft
  177.     *NEW. Superior
  178.     *NEW. ../efs-demo
  179.  
  180.  
  181. 10. *DELETE <fsp>
  182. -----------------
  183.  
  184. For some reason, there are a shortage of people willing to test this function.
  185. I have tested it and am happy that it works, but I'd be grateful if you'd do
  186. the same. Please make a backup of your hard disc before attempting to use this
  187. function. Although I am confident that the code is bug free, I cannot take
  188. responsibility for any data lost by whatever means through direct or indirect
  189. use of the XDFS ROM. In using the DFS ROM it is taken that you agree and
  190. understand this disclaimer.
  191.  
  192.  
  193.  
  194. 11. *RENAME <old fsp> <new fsp>
  195. -------------------------------
  196.  
  197. This works but is not yet bug free. The function will not let you rename a
  198. file to its original name, and nothing is printed if *OPT 1,2 has been set.
  199. I have included it as it is a good indication of how errors that occur in the
  200. Unix end of the filing system will be handled.
  201.  
  202.  
  203.  
  204. 12. *OPT x,y
  205. ------------
  206.  
  207. Identical to Acorn's version.
  208.