home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilst / wimpdebug / !WimpDebug / !Help < prev    next >
Text File  |  1991-08-27  |  4KB  |  86 lines
  1.                          *** WimpDebug v1.21 ***
  2.                   A debugging tool for Wimp applications
  3.                            © 1991 Olav Reinert
  4.  
  5.  
  6.  
  7. _____________________________ Introduction _________________________________
  8.  
  9.    WimpDebug is a Relocatable Module which provides facilities for debugging
  10. new Wimp applications. It creates and maintains a window on the desktop in
  11. which information given by other applications (such as variable values etc.)
  12. may be displayed in an orderly fashion.
  13.    Several interfaces are provided for specifying what to be displayed:
  14.  -CLI commands (mostly for showing constant values or system variables).
  15.  -an SWI interface for high-level languages.
  16.  -an SWI interface for ARM code programs, featuring calls that are
  17. completely transparent to the calling code.
  18.    Special attention has been paid to the ARM interface - it is the
  19. cornerstone of the program, around which all other functions have been
  20. designed (almost).
  21.  
  22.  
  23.  
  24. _______________________________ Contents ___________________________________
  25.  
  26. The documentation is split into the following files, which can all be found
  27. in the directory "Docs":
  28.  
  29.    "Tutorial":  Covers installation and how to use the program. Also
  30. contains many examples.
  31.    "Guide":  The WimpDebug Reference Guide (abbreviated WRG). Documents the
  32. complete range of interfaces provided, in detail, as well as a description of
  33. the macros, the desktop task and a list of possible errors.
  34.    "TechInfo":  Various technical details about WimpDebug.
  35.    "History":  WimpDebug revision history.
  36.  
  37.  
  38.  
  39. ___________________________ Acknowledgements ______________________________
  40.  
  41.    First of all, I didn't invent the original concept of WimpDebug myself.
  42. Mads Jensen once wrote an ARM application with which he used some debugging
  43. code that was conditionally assembled to be integrated into the application
  44. code. It worked rougly like WimpDebug, providing a window with 2x16 icons
  45. for displaying data. Various routines called with BL did the job of putting
  46. data into the icons etc. I think the idea was to make an include file which
  47. contained the debug code.
  48.    I liked the idea, but wanted a general debugging utility, not only for
  49. use with ARM code programs. So I programmed the WimpDebug module and
  50. provided various interfaces to it, including proper ARM debug SWIs that were
  51. transparent to the caller.
  52.  
  53. ___________________________________________________________________________
  54.  
  55. © Olav Reinert, 1991.
  56.  {Formalities on}
  57.    This program is the property of Olav Reinert, who is also the programmer
  58. and the copyright holder. It has been put into the Public Domain to be spread
  59. freely and used by whoever wants to do so, on the condition that it is only
  60. passed on as a whole, not in parts, and that everybody pass on an unmodified
  61. copy of the program (incl. all files belonging to it) which they originally
  62. received. Individual customisation of the program code is OK.
  63.    Inclusion of this program in commercial software products is not allowed
  64. without written consent from the programmer.
  65.    This program is supplied "as is" (standard Acorn phraseology, isn't it?).
  66. Use of it is entirely at your own risk. Nobody but the user may be held
  67. responsible for any damage or loss caused by the use or abuse of this
  68. program. In particular, the programmer will not accept any such
  69. responsibility.
  70.  {Formalities off}
  71.  
  72.    Bug reports, comments and suggestions (donations?) are all very welcome
  73. and can be sent to this address:
  74.  
  75.     Olav Reinert
  76.     Marius Simonsensvej 15, 1th
  77.     8200 Århus N
  78.     Denmark
  79.       Phone: (+45) 86 10 07 70
  80.  
  81.    You can also reach me at Quercus BBS (using ArcBBS software) in Denmark:
  82. (+045) 31 67 97 70, or at TWoC and Arcade, which I occasionally call to read
  83. messages. My username is "Olav Reinert" on all boards.
  84.    Besides, I also read the international Fidonet/echomail conferences
  85. dealing with Archimedes-related stuff.
  86.