home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / s / swihelp / !SWIHelp / !Help < prev    next >
Encoding:
Text File  |  1996-09-07  |  3.1 KB  |  65 lines
  1. !Help/Readme file for SWIHelp v1.00
  2.  
  3. This program is SHAREWARE.  You are free to distribute this program as long as
  4. all the files remain intact.  I retain the copyright at all times.  If you wish
  5. to use it after a trial period of two weeks you should register it with me by
  6. sending £5 to me at:
  7.  
  8.   Kieran Mansley
  9.   Brookside House
  10.   Airton
  11.   Skipton
  12.   North Yorkshire
  13.   BD23 4AX
  14.  
  15. Registered users will receive any updates or new versions as and when they
  16. become available.  See below for my plans for future developments.  If you do
  17. not want to use it after the trial period you *must* delete your copy or give
  18. it to someone else.
  19.  
  20. Registering brings many advantages:
  21.   You get free technical support
  22.   You get free upgrades to any later versions
  23.   You help fund the development of this and other programs
  24.   You give me some incentive to develop it further
  25.   You have a clear conscience
  26.   I will be more likely to release future programs as shareware
  27.    rather than selling them
  28. If you do use it and find it useful you really should register - I have spent
  29. many hours writing this program and I like to know that people are using it.
  30.  
  31.  
  32. So what is it?
  33.   SWIHelp is a program that I have written to help me when I am programming.  I
  34.   often find that I am trying to work out what a piece of code does, and every
  35.   time I come across a SWI I have to reach for the PRM index, hunt through it to
  36.   find the page number, then find the right book, and trudge through that just
  37.   to find out the name of the SWI and what it does.  With SWIHelp it is simple. 
  38.   You just enter either the name or the number of the SWI and the program
  39.   returns the other one as well as a brief description of its use and the PRM
  40.   page incase you need more information.
  41.  
  42. Wow! Thats Great! How do I use it?
  43.   First of all you may need to update your !System folder.  Use the !SysMerge
  44.   application that should accompany this program.  Once you have done this run
  45.   the program in the normal way and click on the iconbar icon.  Most of the
  46.   window should be fairly self explanatory.  Once you have filled in either the
  47.   name or the number press return and it will do its stuff.  If the SWI is one
  48.   that takes a reason code (eg. OS_Byte, OS_SpriteOp) you can then enter this by
  49.   either typing it in or using the adjuster arrows.  The program then returns a
  50.   description of the effect of each possible value.  If you want to find out
  51.   about a SWI not covered in the PRM's (ie one provided by a third party module)
  52.   then as long as the module is loaded it should still work, although
  53.   (obviously) it will not give a PRM page or description.
  54.  
  55. What will happen to it in the future?
  56.   I hope to write a Zap extension module to provide OLE type facilities for SWI
  57.   names and numbers.  You would be able to export the number direct from the
  58.   code to SWIHelp, check you have the right one, alter it if necessary and the
  59.   return the number to the code.  I will try to expand it to include the RISC OS
  60.   3.5+ SWIs and page numbers when I get vol 5 of the PRM's, as well as the
  61.   StrongARM SWIs when these become available.  I might also add functionality by
  62.   including Service Calls, *Commands etc.  If you want to add to this list then
  63.   mail me.
  64.  
  65.