home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / mbug / mbug036.arc / SUPERSUB.DOC < prev    next >
Text File  |  1979-12-31  |  5KB  |  141 lines
  1.             SUPERSUB DOCUMENTATION    (revised 09/13/81)
  2.             ----------------------
  3.  
  4.                         09/05/81
  5.                         by Ron Fowler
  6.                         Westland, Mich
  7.  
  8. SUPERSUB is intended as a replacement program for SUBMIT.COM provided
  9. with CP/M by Digital Research Corporation.  This document assumes you
  10. are familiar with that utility and its use.
  11.  
  12.             ------------------
  13.  
  14. Version 1.1 update:
  15.  
  16. Control-character translation has been added.  This facility works
  17. similarly to CP/M's SUBMIT, where a desired control character is gen-
  18. erated in the text file by preceeding the character with a circumflex
  19. character.  For example, control-V is generated from "^V".  Thanks to
  20. Keith Petersen for pointing out this omission.
  21.  
  22. A bug in line number reporting when errors are encountered has been
  23. repaired.  Line numbers reported should now correspond to the actual
  24. line number in the file.
  25.  
  26.             ------------------
  27.  
  28.  SUPERSUB provides the following new capabilities:
  29.  
  30.     1) Null input lines are properly interpreted; they cause
  31.        the creation of a zero-length line in $$$.SUB.
  32.  
  33.     2) SUBMIT jobs may be nested.
  34.  
  35.     3) For small SUBMIT jobs, the command lines may be specified
  36.        on the SUPERSUB command line, seperated by semicolons.
  37.  
  38.     4) An interactive mode allows command lines to be entered
  39.        directly into SUPERSUB without need of a text editor.
  40.  
  41.     5) A built-in help function is provided.
  42.  
  43.     6) The output drive and number of allowable parameters may
  44.        by specified at assembly time.
  45.  
  46. NESTING
  47. -------
  48.  
  49. SUBMIT jobs may be nested under SUPERSUB. For example, suppose you
  50. have a submit file to compile a program:
  51.  
  52. BASCOM =$1
  53. L80 $1,$1/N/E
  54. PIP B:=$1.COM
  55. ERA $1.REL
  56. ERA $1.COM
  57.  
  58. named COMPILE.SUB.  You may then submit a job to compile several
  59. programs using COMPILE.SUB.  For example, you can create a file
  60. called COMPALL.SUB consisting of:
  61.  
  62. SUPERSUB COMPILE MYPROG
  63. SUPERSUB COMPILE RBBS.ASC
  64. SUPERSUB COMPILE PRIMES.BAS.
  65.  
  66. This is especially useful when using INTERACTIVE or SUMMARY modes.
  67. In combination with Ward Christensen's FMAP program (CPMUG), some
  68. very powerful command structures may be built.
  69.  
  70. SUMMARY MODE
  71. ------------
  72.  
  73. Summary mode allows the entire SUBMIT job to be specified in the
  74. CP/M command line.  This mode is enabled by using the slash ("/")
  75. character as the first character of the command line. The indiv-
  76. idual submit lines must be seperated with a semicolon. For example,
  77.  
  78.      A>SUPERSUB / CRCK *.* F;CRCK B:*.* F;COMPARE CRCKFILE.CRC B:                 ^
  79.          |
  80.           ----> (this space is optional)
  81.  
  82. will create a file of CRC's of all files on A:, then create a similar
  83. file on B:, then compare the two.  (CRCK, by Keith Petersen, and
  84. COMPARE, by Ward Christensen, are available from the CP/M Users Group).
  85.  
  86. INTERACTIVE MODE
  87. ----------------
  88.  
  89. You may enter the interactive entry mode by typing "SUPERSUB /<CR>"
  90. (ie, "SUPERSUB /" with no arguments).  Supersub will prompt for input
  91. with an asterisk, and you may then enter SUBMIT lines from the keyboard.
  92. You may enter more than one logical line on a physical line using
  93. semicolon seperation.  An empty line terminates the input.  Example:
  94.  
  95. A>SUPERSUB /
  96. *CRCK *.* F
  97. *CRCK B:*.* F
  98. *COMPARE CRCKFILE.CRC B:
  99. *                <empty line here>
  100. A>CRCK *.* F            <submit file begins execution>
  101.  
  102. has the same effect as the above SUMMARY mode example.
  103.  
  104. HELP FUNCTION
  105. -------------
  106.  
  107. Typing SUPERSUB with no arguments will print the built-in help file.
  108.  
  109.  
  110.  
  111.  
  112.  
  113. NOTES
  114. -----
  115.  
  116. 1) Nested SUBMIT runs are only usable up to a maximum of 128 nested
  117.    commands at any one time.  This is a limitation of the CP/M Console
  118.    Command Processor.
  119.  
  120. 2) If you change the drive specification for the output file, you
  121.    may want to do the same thing with XSUB (Digital Research's function
  122.    nine extender).  Within XSUB, find the submit File Control Block
  123.    (search for "$$$     SUB" within XSUB.COM)  and change the first FCB
  124.    byte (ie, the byte before the first "$") to:
  125.         0 - use default drive
  126.         1 - use drive A:
  127.         2 - use drive B:
  128.    etc.
  129.  
  130. 3) In SUMMARY and INTERACTIVE modes, passed parameters have no meaning.
  131.    When these modes are used, the parameter flag, "$", will be passed
  132.    through literally to the output file.
  133.  
  134. 4) Zero-length output lines may be created in SUMMARY and INTERACTIVE
  135.    modes by using two consecutive semicolons.  This is, in effect, a
  136.    blank logical line.
  137.  
  138. 5) Interactive mode may be aborted by typing control-C as the first
  139.    character of a line.  Also, all normal CP/M editing characters are
  140.    available.
  141.