home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / debug / sd.hlp < prev    next >
Encoding:
Text File  |  1988-05-03  |  11.9 KB  |  307 lines
  1. #
  2. #COMPILE             DELETE            EXIT        HELP
  3. #LIBRARY             LINK              OPTIONS     PACKAGE_SPECS
  4. #PROGRAM_LIBRARY     QUIT              RUN         SET_LIBRARY       
  5. #SOURCE_INSTRUMENT   SYSTEM_COMMANDS
  6. #
  7. *************
  8. $?\?\N/A\WIS_DEBUG Options are:  (UPPER CASE indicates minimum required input)
  9. +
  10. +  Library Management
  11. +    SEt_library(PROGRAM_LIBRARY); --> Set current program library
  12. +    Delete(UNIT_NAME);            --> Delete a unit from program lib
  13. +
  14. +  Execution Control
  15. +    SOurce_instrument;            --> Instrument an Ada source file
  16. +    Compile(SOURCE_FILE);         --> Compile an instrumented comp unit
  17. +    LINk(COMPILATION_UNIT);       --> Link an instrumented program
  18. +    Run(COMPILATION_UNIT);        --> Run the Debugger with an instr pgm
  19. +    QUit;  --> or EXit;           --> Quit WIS_DEBUG and Exit to the system
  20. +
  21. +  SYstem_command(COMMAND);        --> Execute a system command
  22. +
  23. +  Help                            --> Help for commands and features
  24. *************
  25. \COMPILE\C\None\Compile an instrumented Ada compilation unit
  26. ?
  27. +Syntax:  COMPILE(SOURCE_FILE);   --> or C(SOURCE_FILE
  28. +         Where SOURCE_FILE is the name of an Ada compilation unit.
  29. +
  30. +Invokes the Ada Compiler to compile the specified Ada source file from
  31. +within the WIS_DEBUG Shell.
  32. +
  33. +After a unit has been instrumented by the Source Instrumenter it must be
  34. +compiled using your Ada compiler.  If you did not select  the  automatic
  35. +compilation option after source instrumentation then  you  may  use  the
  36. +COMPILE command to avoid exiting the WIS_DEBUG Shell.
  37. E
  38. +  1) COMPILE(TEST.INS);
  39. +
  40. +  2) COMPILE(TEST.INS)
  41. +
  42. +  3) COMPILE(TEST.INS
  43. *************
  44. \DELETE\D\None\Delete a unit from the Current Program Library
  45. ?
  46. +Syntax:  DELETE(UNIT_NAME);     --> or D(UNIT_NAME
  47. +
  48. +The Source Instrumenter creates numerous files in the Current  Program
  49. +Library that are used during execution of the Symbolic  Debugger  with
  50. +the instrumented program.   When an  instrumented  program  unit is no
  51. +longer needed it must be deleted from the program  library  using  the
  52. +DELETE command.
  53. +
  54. +No file extension should be specified.  Only files that are created by
  55. +by the Source Instrumenter in the Current Program Library are deleted.
  56. +The user must delete unwanted  files that are  created in the  working
  57. +directory when the Source Instrumenter is executed.
  58. E
  59. +  1) DELETE(OLD_PROGRAM);
  60. +
  61. +  2) DEL(OLD_PROGRAM
  62. +
  63. +  3) D(OLD_PROGRAM
  64. *************
  65. $EXIT\E\None\Command:  Quit WIS_DEBUG and EXIT to the system
  66. +Abbreviation:   EX     --> 2 chars to avoid accidental entry
  67. +Syntax:         EXIT;  --> or EX
  68. ?
  69. +The EXIT command is functionally equivalent the QUIT command.  Some people
  70. +prefer EXIT and some prefer QUIT.  Both terminate the  WIS_DEBUG Shell and
  71. +return the user to the system command level.
  72. E
  73. +  1)  >> EXIT;      3)  >> EXI;         5)  >> EX;
  74. +
  75. +  2)  >> EXIT       4)  >> EXI          6)  >> EX
  76. *************
  77. \HELP\H\None\Display information about WIS_DEBUG Shell commands and features
  78. ?
  79. +Syntax:  HELP;            --> or H
  80. +         HELP(topic);     --> or H(topic
  81. +
  82. +Displays information about WIS_DEBUG  Shell  commands  and  features.   The
  83. +HELP command may be entered at any  time  WIS_DEBUG is in  "command"  mode.
  84. +"Topic" may be abbreviated.  If no "topic" is specified or  if  an  invalid
  85. +"topic" is specified then a menu of all available HELP topics is displayed.
  86. +If "topic" is ambiguous then a list  possible  intended  topics  and  their
  87. +minimum abbreviations is displayed.
  88. +
  89. +Help files may be modified or expanded by the user to add project or system
  90. +specific information, new terminal configurations,  information about bugs,
  91. +or any other topic.  The format of the  help  file  and  information  about
  92. +adding new topics may be found in the WIS_DEBUG User's Guide.
  93. +
  94. E
  95. +  1) HELP;       --> Will display a menu of all available HELP topics
  96. +
  97. +  2) HELP(HELP); --> Will display information about the HELP command
  98. +
  99. +  3) HELP(RUN    --> Will display information about the RUN command
  100. *************
  101. \LIBRARY\LIB\None\Set the current program library
  102. ?
  103. +Syntax:  LIBRARY(LIBRARY_NAME);   --> or LIB(LIBRARY_NAME
  104. +
  105. +         where LIBRARY_NAME is the complete path name of the directory
  106. +         to be used as the WIS_DEBUG Current Program Library
  107. +
  108. +The LIBRARY command is functionally equivalent to the SET_LIBRARY command.
  109. E
  110. +  1) LIBRARY( DRA0:[USER.BUBBA_SMITH.PGMLIB] );
  111. +
  112. +     A logical device identifier (DRA0:) is required if the Program
  113. +     Library is not located on the current default logical device.
  114. +
  115. +  2) LIB( [USER.NOSC.PGMLIB] )
  116. +
  117. +     The full path name of the directory is required if the Program 
  118. +     Library is not in the current default working directory.
  119. +
  120. +  3) LIB( [.PGMLIB]
  121. +
  122. +     The Program Library is set to the PGMLIB subdirectory of the
  123. +     current working directory.
  124. *************
  125. \LINK\LIN\None\Link an instrumented program
  126. ?
  127. +Syntax:  LINK(COMPILATION_UNIT);   --> or LIN(COMPILATION_UNIT
  128. +
  129. +Invokes the linker to link an instrumented compilation unit from within
  130. +the WIS_DEBUG  Shell.   The executeable  load module is created in  the
  131. +user's current working directory.
  132. E
  133. +  1) LINK(TEST);
  134. +
  135. +  2) LINK(TEST)
  136. +
  137. +  3) LIN(TEST
  138. *************
  139. $OPTIONS\O\None\WIS_DEBUG Command Options are:
  140. +
  141. +  COMPILE           --> Compile an instrumented Ada compilation unit
  142. +  DELETE            --> Delete a unit from the Current Program Library
  143. +  EXIT              --> Quit WIS_DEBUG and EXIT to the system
  144. +  HELP              --> Display information about commands and features
  145. +  LIBRARY           --> Set the Current Program Library
  146. +  LINK              --> Link an instrumented program
  147. +  QUIT              --> Quit WIS_DEBUG and exit to the system
  148. +  RUN               --> Run the Debugger with an instrumented program
  149. +  SET_LIBRARY       --> Set the Current Program Library
  150. +  SOURCE_INSTRUMENT --> Instrument an Ada source file
  151. +  SYSTEM_COMMAND    --> Execute a system command
  152. +
  153. +WIS_DEBUG command options may be displayed at any time by entering "?".
  154. +
  155. +For more information about a particular option enter HELP( <option_name> );
  156. *************
  157. $PACKAGE_SPECS\PA\None\Instrumenting Ada Package Specifications
  158. +
  159. +     When  the  source  file  you are  instrumenting  includes  a  package
  160. +specification, the source instrumenter will ask you if you want to include
  161. +the package spcecification in your instrumented source.
  162. +
  163. +     If  your package specification includes a generic declaration and you
  164. +want  to  instrument the generic body,  then you must answer YES  to  this
  165. +question.    Otherwise,   instrumenting   will  not  alter  your   package
  166. +specification  and  recompiling  your package  specification  may  not  be
  167. +required.
  168. +
  169. +     The   source  instrumenter  will  create  a  package  which  has  the
  170. +procedures  necessary  to trace any types and variables declared  in  your
  171. +package  specification.   The source instrumenter's package will WITH  and
  172. +USE your package.   Therefore, your package specification must be compiled
  173. +prior to compiling the source instrumenter's package.
  174. ?
  175. +     If you need to compile or recompile your package spcecification,  you
  176. +may  have  it  included  in the same file  as  the  source  instrumenter's
  177. +package.   Then  when  you  compile the  instrumented  source  file,  both
  178. +packages will be compiled.   You will have to recompile your package  body
  179. +and  all dependent units as usual.   If you do not want to recompile  your
  180. +package specification,  answer NO to the question.  You will still need to
  181. +compile  the  instrumented  source  file,  but your package  will  not  be
  182. +affected.
  183. *************
  184. $PROGRAM_LIBRARY\PR\None\The WIS_DEBUG Program Library Consists of:
  185. +
  186. +   1) The Base Program Library
  187. +
  188. +   2) A Current Program Library
  189. ?
  190. +The Base Program Library is created at the time  WIS_DEBUG is  installed
  191. +and contains static non-transient files that are common to all  users of
  192. +the debugger, such as the Terminal Capabilities File and help files.
  193. +
  194. +The Current Program Library contains dynamic information that is created
  195. +and used by the Source Instrumenter and by the debugger during execution
  196. +of the instrumented program.  The Current Program Library must be set at
  197. +run time by using the SET_LIBRARY command.
  198. *************
  199. $QUIT\Q\None\Command: QUIT WIS_DEBUG and exit to the system
  200. +Abbreviation:   QU     --> 2 chars to avoid accidental entry
  201. +Syntax:         QUIT;  --> or QU
  202. ?
  203. +The QUIT command is functionally equivalent the EXIT command.  Some people
  204. +prefer QUIT and some prefer EXIT.  Both terminate the WIS_DEBUG  Shell and
  205. +return the user to the system command level.
  206. E
  207. +  1)  >> QUIT;      3)  >> QUI;         5)  >> QU;
  208. +
  209. +  2)  >> QUIT       4)  >> QUI          6)  >> QU
  210. *************
  211. \RUN\R\None\Run the Symbolic Debugger with an instrumented program
  212. ?
  213. +Syntax:  RUN(PROGRAM)  --> or R(PROGRAM
  214. +
  215. +Runs the Symbolic Debugger with an instrumented program from within
  216. +the WIS_DEBUG Shell.   The PROGRAM  must have already been compiled
  217. +and linked.
  218. E
  219. +  1) RUN(TEST);
  220. +
  221. +  2) RUN(TEST
  222. +
  223. +  3) R(TEST
  224. *************
  225. \SET_LIBRARY\SE\None\Set the current program library
  226. ?
  227. +Syntax:  SET_LIBRARY(LIBRARY_NAME);   --> or SET_L(LIBRARY_NAME
  228. +
  229. +         where LIBRARY_NAME is the complete path name of the directory
  230. +         to be used as the WIS_DEBUG Current Program Library
  231. +
  232. +The SET_LIBRARY command is functionally equivalent to the LIBRARY command.
  233. E
  234. +  1) SET_LIBRARY( DRA0:[USER.BUBBA_SMITH.PGMLIB] );
  235. +
  236. +     A logical device identifier (DRA0:) is required if the Program
  237. +     Library is not located on the current default logical device.
  238. +
  239. +  2) SET_LIB( [USER.GEORGE_BURNS.PGMLIB] )
  240. +
  241. +     The full path name of the directory is required if the Program 
  242. +     Library is not in the current default working directory.
  243. +
  244. +  3) SE( [.PGMLIB]
  245. +
  246. +     The Program Library is set to the PGMLIB subdirectory of the
  247. +     current working directory.
  248. *************
  249. \SOURCE_INSTRUMENT\SO\None\Instrument an Ada source file
  250. ?
  251. +Syntax:  SOURCE_INSTRUMENT;
  252. +         SOURCE_INSTRUMENT(INPUT_FILE,
  253. +                           SOURCE_LISTING_FILE,
  254. +                           INSTRUMENTED_SOURCE_FILE);
  255. ?
  256. +Instruments an Ada source  program to insert  "hooks"  to the Symbolic
  257. +Debugger.  If input and output file names are not specified  then  the
  258. +user will be prompted  for  their  names by the  Source  Instrumenter.
  259. +Only the input file name must be specified.   If no output file  names
  260. +are specified then default names <input_file>.LST and <input_file>.INS
  261. +will be used.
  262. E
  263. +  1)  SOURCE_INSTRUMENT(TEST.ADA, TEST.LIS, TEST.SI); <cr>
  264. +
  265. +      source_file = TEST.ADA
  266. +      source_listing = TEST.LIS
  267. +      instrumented_source = TEST.SI
  268. E
  269. +  2)  SOURCE_INSTRUMENT <cr>
  270. +
  271. +      Enter Source_File => TEST.ADA <cr>
  272. +      Enter Source_Listing => TEST.LIS <cr>
  273. +      Enter Instrumented_Source_File => TEST.SI <cr>
  274. +
  275. +      source_file = TEST.ADA
  276. +      source_listing = TEST.LIS
  277. +      instrumented_source = TEST.SI
  278. E
  279. +  3)  SO <cr>
  280. +
  281. +      Enter Source_File => TEST.ADA <cr>
  282. +      Enter Source_Listing => <cr>
  283. +      Enter Instrumented_Source_File => <cr>
  284. +
  285. +      source_file = TEST.ADA
  286. +      source_listing = TEST.LST
  287. +      instrumented_source = TEST.INS
  288. *************
  289. \SYSTEM_COMMAND\SY\None\Execute a system command from the WIS_DEBUG Shell
  290. ?
  291. +Syntax:  SYSTEM_COMMAND(COMMAND);
  292. +
  293. +Executes a system command or another  program from  within the  WIS_DEBUG
  294. +Shell.   May be  used  for  editing  source  programs,  file  management,
  295. +submitting jobs to a batch stream,  printing Source Instrumenter listings
  296. +for use during a debugging session, etc.
  297. +
  298. +When spawned process is completed, any changes that have been made to the
  299. +environment will be restored to their state prior  to  execution  of  the
  300. +SYSTEM_COMMAND.
  301. E
  302. +  1)  SYSTEM_COMMAND( DIR/DATE );
  303. +
  304. +  2)  SYSTEM_COMMAND( EDIT TEST.ADA
  305. +
  306. +  3)  SY( PRINT TEST.LST
  307.