home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / prpascal / surpas1.lzh / SURPAS.HLP < prev   
Text File  |  1987-10-04  |  12KB  |  253 lines
  1. %*+-------------------------------------+-----------------+---------------------+
  2. !           Cursor movement           !      Block      !       Various       !
  3. +-------------------------------------+-----------------+---------------------+
  4. ! ^S    Left char   ^D    Right char  ! ^K^B  Begin     ! ^J    Help          !
  5. ! ^A    Left word   ^F    Right word  ! ^K^K  End       ! ^K^D  Quit editor   !
  6. ! ^Q^S  Start line  ^Q^D  End line    ! ^K^Y  Delete    ! ^K^X  Exit editor   !
  7. ! ^E    Up line     ^X    Down line   ! ^K^C  Copy      ! ^V    INSERT on/off !
  8. ! ^Q^E  Top line    ^Q^X  Bottom line ! ^K^V  Move      ! ^Z    AUTO on/off   !
  9. ! ^R    Up page     ^C    Down page   ! ^K^P  Print     ! ^B    TABS on/off   !
  10. ! ^Q^R  Start text  ^Q^C  End text    ! ^K^H  Del marks ! ^W    ADJUST on/off !
  11. +-------------------------------------+-----------------+---------------------+
  12. !               Delete                !      Edit       !       Search        !
  13. +-------------------------------------+-----------------+---------------------+
  14. ! DEL   Char left   ^G    Char right  ! RETN  New line  ! ^Q^F  Find string   !
  15. ! ^QDEL Start line  ^Q^Y  End line    ! ^I    Tabulate  ! ^Q^A  Find/replace  !
  16. ! ^Y    Line all    ^T    Word right  ! ^N    Insert CR ! ^L    Find next     !
  17. +--------------------------------------+-----------------+--------------------+
  18. ! Find/replace options:  G = Global (all text), N = Replace without prompting !
  19. +-----------------------------------------------------------------------------+
  20. ! ADJUST mode: Use ^S and ^D to adjust then ^E or ^X to repeat above or below !
  21. +-----------------------------------------------------------------------------+
  22.  
  23. % SURPAS ON-LINE HELP: The command mode
  24.  
  25. SURPAS prompts by printing '>>'. Each time this prompt appears, SURPAS is
  26. ready to accept and process a command line. The following commands are
  27. available in the command mode.
  28.  
  29. LOAD      Load a source text.           SAVE      Save the source text.
  30. NAME      Set current file name.        EDIT      Invoke the editor.
  31. COMPILE   Compile the source text.      RUN       Run current program.
  32. PROGRAM   Compile to program file.      OBJECT    Compile into object file.
  33. FIND      Find a run-time error.        WHERE     Find error in include-file.
  34. DIR       Display disk directory.       USE       Display/set default drive.
  35. MEMORY    Display memory size.          ZAP       Zap (delete) source text.
  36. HELP      Display help screens.         QUIT      Return to MS-DOS.
  37.  
  38. Note that all commands may be abbreviated to their first letter.
  39.  
  40. For further help on the commands above, enter 'HELP' or 'H' followed by the
  41. command name (or the first character of it).
  42.  
  43. %ESURPAS ON-LINE HELP: The EDIT command.
  44.  
  45. The EDIT command invokes the on-screen editor. Once you are in the editor, a
  46. list of editor commands may be displayed by pressing CTRL/J.
  47.  
  48. %LSURPAS ON-LINE HELP: The LOAD command.
  49.  
  50. The LOAD command is used to load a source text into memory. The command line
  51. format is:
  52.  
  53.         LOAD <filename>
  54.  
  55. If the file type is omitted, it defaults to '.PAS'. The current file name is
  56. set to <filename>. When a file is loaded, it is appended to the end of the
  57. source text already in memory. If the file specified does not exist, SURPAS
  58. displays 'No such file'. If loading the file would overflow the memory buffer,
  59. SURPAS displays 'File too big'. For both errors, the text already in memory
  60. remains unchanged.
  61.  
  62. %SSURPAS ON-LINE HELP: The SAVE command.
  63.  
  64. The SAVE command is used to save the text in memory in a disk file. The com-
  65. mand line format is:
  66.  
  67.         SAVE <filename>
  68.  
  69. If <filename> is omitted entirely, it defaults to the current file name set by
  70. LOAD or NAME. If the file type is omitted, it defaults to '.PAS'. If a file of
  71. the same name and type exists on the disk specified, its type is changed to
  72. '.BAK' before the new file is created. If the disk directory is full, SURPAS
  73. displays 'Directory is full'. If there is not enough room on the disk to cre-
  74. ate a new file, SURPAS displays 'Disk is full'. If one of these errors are re-
  75. ported, insert another disk and try SAVE again.
  76.  
  77. %NSURPAS ON-LINE HELP: The NAME command.
  78.  
  79. The NAME command is used to change the current file name. The current file
  80. name is used by SAVE, PROGRAM, and OBJECT when a file name is not explicitly
  81. stated. The command line format is:
  82.  
  83.         NAME <filename>
  84.  
  85. If <filename> is omitted entirely, NAME displays the current file name instead
  86. of changing it. If the file type is omitted, it defaults to '.PAS'.
  87.  
  88. The current file name is set to 'WORK.PAS' when SURPAS is cold-started and
  89. when a ZAP command is issued.
  90.  
  91. %CSURPAS ON-LINE HELP: The COMPILE command.
  92.  
  93. When the compiler is invoked from a COMPILE command, the object code is stored
  94. directly into memory in succession of the source text.
  95.  
  96. Following a successful compilation, you are informed of the size of the code
  97. segment, the data segment, and free memory (the stack segment):
  98.  
  99.         Code: rrrrrr bytes (aaaa paragraphs)
  100.         Data: ssssss bytes (bbbb paragraphs)
  101.         Free: tttttt bytes (cccc paragraphs)
  102.  
  103. The numbers displayed in parentheses are the paragraph sizes (in hex) of each
  104. area in (one paragraph corresponds to 16 bytes).
  105.  
  106. Note that whenever you invoke the editor, the object code is erased.
  107.  
  108. %RSURPAS ON-LINE HELP: The RUN command.
  109.  
  110. The RUN command is used to execute a program. If no program code is present,
  111. the compiler is invoked to compile the program (see 'HELP COMPILE' screen).
  112. Assuming a successful compilation, or if the object code was already present,
  113. the program is started. When it ends, it automatically transfers control to
  114. the command mode.
  115.  
  116. If a run time error occurs, the program will terminate displaying a run time
  117. error message, for instance:
  118.  
  119.         EXECUTION ERROR 04 AT PC=254E
  120.         Program terminated
  121.  
  122. You may then use the FIND command to locate the statement that caused the
  123. error (see 'HELP FIND' screen).
  124.  
  125. %PSURPAS ON-LINE HELP: The PROGRAM command.
  126.  
  127. The PROGRAM command is used to compile the program into a command file on a
  128. disk. The command line formats is:
  129.  
  130.         PROGRAM <filename>,<ssegmin>,<ssegmax>,<csegmin>,<dsegmin>
  131.  
  132. If <filename> is omitted, the current file name is used, with its type changed
  133. to '.COM'. The file type defaults to '.COM'. <ssegmin>, <ssegmax>, <csegmin>,
  134. and <dsegmin> are hex numbers (up to four hex digits). Any one of the four hex
  135. parameters may be omitted, for instance 'PROGRAM TEST,800' (only <ssegmin>) or
  136. 'PROGRAM TEST,,,CD8,12E4' (only <csegmin> and <dsegmin>).
  137.  
  138. <ssegmin> and <ssegmax> specify the minimum and maximum sizes (in paragrahps)
  139. of the stack segment. <ssegmin> defaults to 100 hex (4K bytes), and <ssegmax>
  140. defaults to the value of <ssegmin>. <csegmin> and <dsegmin> specify the mini-
  141. mum sizes (in paragrahps) of the code and data segments. They default to the
  142. lowest possible values. They may never be larger than hex FFF (64K bytes), and
  143. usually they are only specified for programs that will chain to other programs
  144. with larger code and/or data segments. On compiling the program, SURPAS also
  145. writes a copy of the run-time package into the command file. Once compiled,
  146. the program can be executed from MS-DOS simply by typing its name.
  147.  
  148. %OSURPAS ON-LINE HELP: The OBJECT command.
  149.  
  150. The OBJECT command produces an object file which contains the compiled program
  151. code only (i.e. without the run-time package and the command file header). The
  152. command line format is:
  153.  
  154.         OBJECT <filename>
  155.  
  156. If <filename> is omitted, the current file name is used, with its type changed
  157. to '.CHN' (short for chain). The file type defaults to '.CHN'. Object (chain)
  158. files may only be activated through the chain procedure of SURPAS Pascal. For
  159. further details on program chaining, please refer to the SURPAS Pascal Prog-
  160. ramming Manual.
  161.  
  162. %FSURPAS ON-LINE HELP: The FIND command.
  163.  
  164. The FIND command is used to locate a statement in the source text which cor-
  165. responds to an offset address in the object code. The command line format is:
  166.  
  167.         FIND <offset>
  168.  
  169. where <offset> is the offset address of the statement to be located. The off-
  170. set address must be specified in hex (up to four hex digits). <offset> may be
  171. omitted, in which case it defaults to the offset address of the last run time
  172. error. Thus, to locate the statement that caused a run time error, simply en-
  173. ter 'FIND'.
  174.  
  175. If the offset address is found, the compiler stops and displays 'Target ad-
  176. dress found' followed by 'Press <RETURN> to edit or <ESC> to abort. When you
  177. press RETURN, the editor is invoked, and the cursor is placed at or just after
  178. the relevant section. If the offset is out of range, the compiler outputs
  179. 'Target address not found'.
  180.  
  181. %WSURPAS ON-LINE HELP: The WHERE command.
  182.  
  183. The WHERE command invokes the editor, and moves the cursor to a specific posi-
  184. tion in the text. The command line format is:
  185.  
  186.         WHERE <offset>
  187.  
  188. where <offset> is a hex number specifying the offset address of the spot to be
  189. located. <offset> may be omitted, in which case it defaults to the offset ad-
  190. dress of the last compilation error within an include. Thus, when the compiler
  191. reports an error within an include file, first save the source text using the
  192. SAVE command, next erase the memory buffer using the ZAP command, and load the
  193. include file using the LOAD command, and finally issue a WHERE command with no
  194. argument, which immediately invokes the editor and moves the cursor to the
  195. spot in error.
  196.  
  197. Whenever you leave the editor, the offset address of the cursor is recorded as
  198. the default WHERE argument. Thus, if you use WHERE instead of EDIT to invoke
  199. the editor, the cursor will be moved to the spot you left previously instead
  200. of to the beginning of the text.
  201.  
  202. %DSURPAS ON-LINE HELP: The DIR command.
  203.  
  204. The DIR command is used to display the directory of a disk. The command line
  205. format is:
  206.  
  207.         DIR <afn>
  208.  
  209. where <afn> is an ambiguous file name as the one used in an MS-DOS DIR com-
  210. mand, i.e. question marks (?) and asterisks (*) may be interspersed through
  211. the file name and type fields.
  212.  
  213. A question mark will match any character in that position, and an asterisk will
  214. match any combination of characters within the field in which it is used. If
  215. both the name field and the type field are omitted, leaving only a drive iden-
  216. tifier and a colon, then all files on that drive are listed. If <afn> is omit-
  217. ted entirely, then all files of the default drive are listed.
  218.  
  219. Note that system files are not displayed.
  220.  
  221. %USURPAS ON-LINE HELP: The USE command.
  222.  
  223. The USE command is used to display and set the default drive number. The com-
  224. mand line format is:
  225.  
  226.         USE <drive>
  227.  
  228. where <drive> is a drive identifier (A-O). If <drive> is specified, that drive
  229. becomes the default drive. The USE command ends by displaying the default
  230. drive identifier.
  231.  
  232. %MSURPAS ON-LINE HELP: The MEMORY command.
  233.  
  234. The MEMORY command displays the size of free memory:
  235.  
  236.         Free: rrrrrr bytes (aaaa paragraphs)
  237.  
  238. The number is parentheses is the paragraph size (in hex) of free memory. One
  239. paragraph corresponds to 16 bytes.
  240.  
  241. %ZSURPAS ON-LINE HELP: The ZAP command.
  242.  
  243. The ZAP command erases the text in memory and sets the current file name to
  244. 'WORK.PAS'. As a safety precaution, ZAP asks 'Are you sure (Y/N)?'. Any answer
  245. but 'Y' or 'y' will leave the text unchanged.
  246.  
  247. %QSURPAS ON-LINE HELP: The QUIT command.
  248.  
  249. The QUIT command transfers control to MS-DOS. You may later warm-start SURPAS
  250. by entering 'SURPAS *'. This of course requires that no vital memory areas
  251. have been overwritten by other programs run it the meantime.
  252.  
  253.