home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / develop / here / simbug / docs / simbug.doc < prev   
Text File  |  1995-02-27  |  7KB  |  190 lines
  1.  
  2. -----------------------------------------------------------------------------
  3.  
  4.  
  5.                                   SIMBug
  6.  
  7.                        Preliminary S.I.M. Debug Server
  8.                                 Version 0.61
  9.  
  10.                    Copyright © 1990-1993 by Stefan Walter
  11.                              ALL RIGHTS RESERVED
  12.  
  13. -----------------------------------------------------------------------------
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                Documentation
  20.  
  21.  
  22.                          last edited on: 13.03.93
  23.  
  24.  
  25.  
  26.  
  27.  
  28. =============================================================================
  29.         1.      Introduction
  30. =============================================================================
  31.  
  32.  
  33. SIMBug  provides  an  easy  way to use SIM as debugger for different kinds of
  34. programs:   Executables,  bootblocks,  files,  tasks  and  programs  that are
  35. already in memory.
  36.  
  37. Support  of  multiple  task  debugging is still only not available.  You also
  38. should  not run two copies of SIMBug because they both share the same copy of
  39. SIM.
  40.  
  41. This version is still only preliminary and not quite comfortable.
  42.  
  43.  
  44.  
  45.  
  46. =============================================================================
  47.         2.      Startup
  48. =============================================================================
  49.  
  50.  
  51. SIMBug  can  only be started from CLI, not from Workbench.  When started, SIM
  52. looks  for  the system symbols definition file which, if available, is loaded
  53. and  compiled  to  a  symbol  list.   If  no  SIM  is  in  memory yet, SIMBug
  54. automatically enters the SIM load menu.
  55.  
  56.  
  57.  
  58.  
  59. =============================================================================
  60.         3.      Commands
  61. =============================================================================
  62.  
  63.  
  64. The following case unsensitive commands are known by SIMBug:
  65.  
  66.  
  67. Quits SIMBug.
  68.  
  69.  
  70. Lists all commands.
  71.  
  72.  
  73.         k       Removes  a  previously  installed  copy  of SIM and frees the
  74.                 memory  if it was allocated.  This command needs to be called
  75.                 when you need to load a fresh copy of SIM.
  76.  
  77.  
  78.         s       Loads  SIM.   SIMBug first determines a suitable location for
  79.                 SIM,  display  and  backup.   SIM  is searched in the current
  80.                 directory,  'C:',  'DH0:',  'C+:'  and  'DF0:'.  Then you are
  81.                 asked  the  address for SIM, display and backup.  By entering
  82.                 nothing,  the computed default values printed in brackets are
  83.                 used.
  84.                 
  85.                 You  can  then either allocate memory for SIM or not, default
  86.                 is  to  do  so.   Finally  you need to confirm if all entered
  87.                 addresses are right.
  88.  
  89.  
  90.         e       Simply  enters  SIM  through  the  JSR entrance.  The PC then
  91.                 points   somewhere   in  SIMBug.   This  function  is  mainly
  92.                 supported  for short calls to SIM.  You should not change the
  93.                 PC or stack.
  94.  
  95.  
  96.         l       Debugs  an  executable.   You  are  asked for the name of the
  97.                 program  and  a  command  line  which  is  then passed to the
  98.                 program in a0/d0.
  99.                 
  100.                 After  sucessfully  loading  the executable, SIMBug scans the
  101.                 hunk  structure  for  symbol  hunks.  If it encounters any, a
  102.                 symbol list is created.
  103.                 
  104.                 After  the  program terminates, SIMBug waits for you to press
  105.                 <CR>  once  more before it frees symbol lists and unloads the
  106.                 program.  Useful if the program detaches from CLI.
  107.  
  108.  
  109.         b       Debugs  a bootblock.  You are asked for the drive number from
  110.                 which  to  load  the bootblock.  Only DF0:-DF3:  are allowed.
  111.                 The  bootblock  of that drive is loaded to an allocated block
  112.                 of chip memory.
  113.  
  114.  
  115.         f       Debugs  a  file.   You  are  asked  for the file name and the
  116.                 address  to  which  it  shall  be  loaded.   If no address is
  117.                 specified, the default address is used.  Memory is allocated,
  118.                 if it can't, the command fails.
  119.                 
  120.                 The PC is set to the start of the file in memory.
  121.  
  122.  
  123.         m       Debugs  a  program  already in memory.  You are asked for the
  124.                 address to be used as PC.
  125.  
  126.  
  127.         t       Debugs  an existing task.  You are asked for the task control
  128.                 blocks address of the task to intercept.  If interception was
  129.                 successful,  the  task enters SIM when it becomes the running
  130.                 task again.
  131.  
  132.  
  133.         w       Lists all tasks.
  134.  
  135.  
  136.         n       Creates a new CLI.
  137.  
  138.  
  139.  
  140.  
  141. =============================================================================
  142.         4.      BTW
  143. =============================================================================
  144.  
  145.  
  146. A  loaded  copy  of  SIM  is  kept resident in memory.  Some virus protection
  147. programs  may  complain  about the resident structure SIMBug creates for that
  148. purpose.
  149.  
  150. When debugging anything except tasks, the processing power of the CLI process
  151. of SIMBug is used.
  152.  
  153.  
  154.  
  155.  
  156. =============================================================================
  157.         5.      The Quit Feature
  158. =============================================================================
  159.  
  160. SIMBug  uses  the  debug  server  entrance of SIM when debugging executables,
  161. files, bootblocks and programs in memory, thus enabling aborting the program.
  162.  
  163. By  leaving  SIM with one of the quit commands or shortcuts, SIMBug is called
  164. again.   You can then either continue debugging or abort the program.  If you
  165. abort, the program is unloaded but resources allocated by the program are not
  166. freed.   The continue function is useful if you need to suspend debugging and
  167. temporarily work on something else.
  168.  
  169. The quit feature only works if the running task is the CLI process of SIMBug.
  170. If  you  quit  SIM from the wrong process, a requester pops up.  You can then
  171. choose to either continue or to suspend the process.
  172.  
  173.  
  174.  
  175.  
  176. =============================================================================
  177.         6.      Bugs
  178. =============================================================================
  179.  
  180.  
  181. If  you  find  any bugs in SIMBug, the system symbol definition files or SIM,
  182. you  are  kindly  asked  to  report  these  to me in order to get them fixed.
  183. Please  look  at  the end of the documentation of SIM for both my physical or
  184. e-mail address.
  185.  
  186.  
  187.  
  188. Happy bug-hunting! :)
  189.  
  190.