home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilsd / ensure / Docs / Ensure
Text File  |  1995-05-08  |  5KB  |  139 lines
  1. File        : Ensure
  2. Date        : 09-May-95
  3. Author      : © A.Thoukydides, 1995
  4. Description : Description of the "Ensure" utility.
  5.  
  6.  
  7. INTRODUCTION
  8.  
  9. The "Ensure" utility is used to ensure that suitable versions of modules from
  10. the !System.modules directory are loaded. There are two advantages over the
  11. usual RMEnsure commands in a script file: only a single command is required
  12. for each module, and the error messages are friendlier.
  13.  
  14. This utility is FreeWare; it may be freely used and copied. However, I
  15. retain full copyright. See the section on "LEGAL MATTERS" for more details.
  16.  
  17.  
  18. USAGE
  19.  
  20. The syntax is:
  21.  
  22.     Ensure <ModuleTitle> <Version> <Filename>
  23.  
  24. where
  25.  
  26.     <ModuleTitle>   - the name of the module, as given by *Modules
  27.     
  28.     <Version>       - the minimum version of the module required
  29.     
  30.     <Filename>      - the filename of the file within the !System.modules
  31.                       directory, i.e. it is appended after "System:modules."
  32.  
  33. Note that no checking of arguments is currently performed.
  34.  
  35. Example of use:
  36.  
  37.     Run <DataMagic$Dir>.Ensure Iconbar 1.11 Toolbox.IconBar
  38.  
  39. This starts the Ensure utility from the DataMagic directory to ensure that
  40. version 1.11 of the Iconbar module is loaded. If necessary the module is
  41. loaded as "System:modules.Toolbox.Iconbar".
  42.  
  43.  
  44. LEGAL MATTERS
  45.  
  46. The "Ensure" utility and documentation is supplied "as is"; no warranty,
  47. express or implied, of the merchantability of this software or its fitness
  48. for any particular purpose is given. In no circumstances shall the author, or
  49. any provider or distributor of this software, be liable for any damage, loss
  50. of profits, or any indirect or consequential loss arising out of the use of
  51. this software or inability to use this software.
  52.  
  53. This utility is FreeWare. Permission is granted for anyone to distribute it
  54. unchanged and in its entirety, providing that no profit is made in the
  55. process. The "Ensure" utility may not be distributed if modified or
  56. incomplete; neither may it be distributed without this documentation.
  57.  
  58. To use this utility, or any part of it, as part of a system or other
  59. application that is for sale (for however much and for whatever reasons) or
  60. released as copyright material then the author's express permission in
  61. writing must be obtained. The author maintains copyright on all the material
  62. supplied and reserves the right to change these conditions at any time
  63. without notice.
  64.  
  65.  
  66. CONTACTING THE AUTHOR
  67.  
  68. I would be interested in hearing of any bugs or other unexpected features in
  69. this utility, and will endeavour to correct any such problems in future
  70. releases. Suggestions for improvements are also most welcome. Implementation
  71. depends upon practicability and on how much spare time I have.
  72.  
  73. If you have any comments on this program, or would like to suggest ways in
  74. which it could be improved, I can be contacted at one of the following
  75. addresses:
  76.     
  77.     Until June 1995:
  78.         
  79.         19 Museum Road
  80.         Oxford
  81.         OX1 3PX
  82.         
  83.         alexander.thoukydides@lincoln.oxford.ac.uk
  84.     
  85.     After June 1995:
  86.     
  87.         Thalna
  88.         2 Dukes Drive
  89.         Bearwood
  90.         Bournemouth
  91.         Dorset
  92.         BH11 9SZ
  93.  
  94. If in any communication you make specific reference to the program code please:
  95.  
  96.     Quote the version number and date of the utility (it is contained near
  97.     the start of the executable binary).
  98.     
  99.     Refer only to the utility as released.
  100.     
  101.     Supply as many details as possible about the problem, including the
  102.     hardware and software configuration of the machine being used.
  103.  
  104. Please send a stamped and self addressed envelope, or give details of how to
  105. contact via e-mail, if you would like a reply.
  106.  
  107. I hope you find this application of some use.
  108.  
  109.  
  110. ACKNOWLEDGEMENTS
  111.  
  112. I would like to the thank the following people for their contributions to
  113. the development of this utility:
  114.  
  115.     Acorn Computers - The Risc PC, RISC OS and the ObjAsm assembler.
  116.     Dominic Symes   - The brilliant !Zap editor; get a copy immediately.
  117.     Robin Watts     - !Larger, the greatest backdrop program ever.
  118.  
  119. and everyone at the Acorn User Group in Oxford.
  120.  
  121.  
  122. THINGS TO DO
  123.  
  124. The following are changes that may be made to this utility sometime in the
  125. future:
  126.     
  127.     Checking of command-line arguments and display of syntax message.
  128.     
  129.     Use (optional) Messages file or system variables for error message text.
  130.  
  131.  
  132. VERSION HISTORY
  133.  
  134. 0.00 (16-Apr-95)    Original development version.
  135.  
  136. 0.01 (03-May-95)    Tidied up the code and improved the documentation.
  137.  
  138. 1.00 (09-May-95)    First official release version.
  139.