home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / CPM / SUBMIT / SUBTOOL.LBR / SUBTOOL.DQC / SUBTOOL.DOC
Text File  |  2000-06-30  |  7KB  |  188 lines
  1.           Documentation for SUBTOOL.LBR  6-2-85
  2.  
  3. SUBTOOL.LBR should contain the following files:
  4.  
  5. SUBTOOL.OBJ    Submit pause and file find utility.
  6. SUBTOOL.AQM    Source for the above.
  7. SUBTOOL.DQC    This documentation
  8. PAUSE.OBJ    Submit pause utility.
  9. PAUSE.AQM    Source for the above
  10. TESTFILE.OBJ    Submit file find utility.
  11. TESTFILE.AQM    Source for the above.
  12. ASM.SUB        SUB to use SUBTOOL with ASM.COM
  13. MAC.SUB        Another for MAC.COM
  14. BASCOM.SUB    For BASCOM.COM using external runtime.
  15. OBASCOM.SUB    Similar, for compiling internal runtime.
  16. MTPLUS.SUB    For compilation of Pascal/MT+
  17. SUBTOOL.CRC    CRC and other stats on the extracted
  18.         and unsqueezed files.
  19.  
  20. ******************************************************
  21. *  WARNING! Do not use any of these SUB files until  *
  22. *  you have read the documentation.                  *
  23. ******************************************************
  24.  
  25. Incorrect use can result in erasure of your source file!
  26.  
  27. This erased file can be recovered with unera.com.  This is due
  28. to the last line of each SUB file that erases the .HEX or .REL
  29. file.  Correct syntax for each SUB file is:
  30.  
  31. SUBMIT <subname> <filename>
  32.  
  33. ALL without extension.  It is the inclusion of the extension that
  34. can cause the trouble.  For example, to assemble the file FOO.ASM
  35. with MAC.COM the syntax is:
  36.  
  37. A>SUBMIT MAC FOO
  38.  
  39. If you were to enter SUBMIT MAC FOO.ASM, the final line in
  40. MAC.SUB which reads: ERA B:$1.HEX would send the following
  41. command to CP/M  ERA B:FOO.ASM.HEX.  This would be read by CP/M
  42. as ERA B:FOO.ASM.
  43.  
  44. Subtool does protect you somewhat from this problem.  If your
  45. source filename is 5 or more characters in length, subtool will
  46. abort in the filefind mode because the total filename length
  47. exceeds the maximum that CP/M will accept.  You do get one
  48. more chance to recover from this input error because the pause
  49. before load or link will give you the option of aborting by
  50. entering 'A' or 'a' for Abort.
  51.  
  52. Two ways are available to avoid this completely, if the possible
  53. erasure bothers you.  One, delete the last line of each .SUB file
  54. in this library, except MTPLUS.SUB, and erase the .HEX or .REL
  55. manually.  Two, replace the final line with ERA B:*.HEX or ERA
  56. B:*.REL.  This will erase ALL .HEX or .REL files on the
  57. destination disk.  Be sure you want ALL of them to go away.
  58.  
  59. Of course, you can use SUBTOOL, PAUSE or TESTFILE to write your
  60. own SUB file.
  61.  
  62.                  SUBTOOL
  63.  
  64. I created Subtool by modifying and combining PAUSE and TESTFILE
  65. by Mark Anacker which appeared in the March 1985 issue of Byte
  66. magazine.
  67.  
  68. I use the submit files in this library because I am basically
  69. lazy.  Most of the time when I am assembling or compiling a
  70. program, I just want to start with a source file and end with the
  71. object code and source.  I don't want to see a PRN file symbol
  72. table or HEX file unless I have a difficult problem.  This is
  73. particularly true if all I want to do is make some small changes
  74. or throw a switch or two in a public domain program.  I also
  75. wanted to save a little disk space by having only one small tool
  76. program instead of two.
  77.  
  78. Subtool has two functions.  If it is called in a .SUB file with
  79. no command tail, it will cause an interruption of Submit
  80. processing and give you a chance to abort the whole thing with
  81. this message to the screen:
  82.  
  83. Press A to abort, any other to continue _
  84.  
  85. If it is called with a filename or $1, $2 etc. Subtool will
  86. search the requested drive to see if the file exists.  If it
  87. does not, Subtool will abort the whole operation and erase the
  88. $$$.SUB temporary file.
  89.  
  90.  
  91.                   PAUSE
  92.  
  93. Pause is a modified version of the program in the March 1985
  94. Byte magazine.  Its function is included in Subtool.  To use
  95. it, just enter a line in your .SUB file that reads:
  96.  
  97. PAUSE
  98.  
  99. It will cause a break in execution of the SUB file and give you
  100. an option to abort.  The main modification from the Byte listing
  101. is to save the disk and CP/M stack so that an abort can return
  102. directly to CP/M, without a warm boot.  A warm boot is required
  103. to continue execution.
  104.  
  105.  
  106.                 TESTFILE
  107.  
  108. Testfile is the second of Mark Anacker's programs from the March
  109. 1985 Byte.  I have modified it much like Pause, to abort directly
  110. to CP/M.  It simply does a file search to determine whether a
  111. requested file exists.  Syntax in the SUB file is:
  112.  
  113. TESTFILE [d:]$1        If the extension is supplied in Submit
  114.             command line.
  115.     or
  116.  
  117. TESTFILE [d:]$1.<ext>    Similar to the use of Subtool in the SUB
  118.             files in this library.
  119.     or
  120.  
  121. TESTFILE [d:]<filename>.<ext>    Search for a file that always should
  122.                 be present
  123.  
  124.  
  125.                  ASM.SUB
  126.  
  127. For with ASM.COM.  To assemble the file FOO.ASM, enter:
  128.  
  129. SUBMIT ASM FOO            (without extension!)
  130.  
  131. SUBMIT.COM, ASM.COM and LOAD.COM must be together on the same disk.
  132. I them on the A drive.  Your source file must be on B:
  133. Rewrite the ASM.SUB if you want to have your source on some other
  134. drive.  Change all drive references to the desired drive.
  135.  
  136.  
  137.                  MAC.SUB
  138.  
  139. For use with the Digital Research macro assembler, MAC.COM.
  140. To assemble SAMPLE.ASM, enter:
  141.  
  142. SUBMIT MAC SAMPLE        (without extension!)
  143.  
  144. SUBMIT.COM, MAC.COM, LOAD.COM and any macro libraries used in
  145. assembly, like Z80.LIB, must be on the same disk.  The source
  146. file must be on B:
  147.  
  148.  
  149.                BASCOM.SUB
  150.  
  151. For use with Microsoft's Basic compiler to create a COM file
  152. that will require the external runtime package, BRUN.COM, be
  153. present on the same disk with your compiled basic program to
  154. execute.  To compile SAMPLE.BAS, the syntax is:
  155.  
  156. SUBMIT BASCOM SAMPLE        (without extension!)
  157.  
  158. SUBMIT.COM, BASCOM.COM, L80.COM and BASLIB.REL must all be on the
  159. same disk.  The source file with the extension .BAS must be on
  160. B:
  161.  
  162.  
  163.                OBASCOM.SUB
  164.  
  165. For use with Microsoft's Basic compiler to create a stand alone
  166. COM file that does not require BRUN.COM.  To compile SAMPLE.BAS,
  167. the syntax is:
  168.  
  169. SUBMIT OBASCOM SAMPLE        (without extension!)
  170.  
  171. SUBMIT.COM, BASCOM.COM, L80.COM and OBASLIB.REL must all be on the
  172. same disk.  The source file with the extension .BAS must be on
  173. B:
  174.  
  175.  
  176.                MTPLUS.SUB
  177.  
  178. For use with the Pascal/MT+ compiler from Digital Research.
  179. This is sample given in the Byte article.  It should require
  180. all of the Pascal/MT+ files and SUBMIT.COM to be on the same
  181. disk.  The source file must be on B:  I do not own the
  182. Pascal/MT+ compiler, so I have not been able to check it.
  183.  
  184.                 Merlin R. Null
  185.                 P. O. Box 9422
  186.                 N. Hollywood, CA 91609
  187.                 (818) 762-1429
  188. d basic progra