home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / makeswi / MakeSwiDoc < prev   
Encoding:
Text File  |  1990-10-24  |  5.9 KB  |  133 lines
  1. >&.Text.Document.MakeSwiDoc
  2.  
  3. Package Version 0.40 18th July 1989
  4.  
  5. MakeSwi BASIC Utility Documentation
  6.  
  7. This file documents the BASIC program MakeSwi (0.40, 18th July 1989)
  8.  
  9. It contains two sections:
  10.  
  11.         - MakeSwi Documentation
  12.                 Information about MakeSwi.
  13.         * Package Documentation
  14.                 Information about the package in general. Read this.
  15.  
  16. Document Version 0.01 18th July 1989
  17.  
  18. --- MakeSwi Documentation
  19.  
  20.         MakeSwi is a BASIC program that makes text files of equate directives
  21. for assemblers and other programs that define all the SWI calls available in
  22. the machine. These can then be used as 'include' (Wingpass, C) or 'get' files
  23. (Aasm). 
  24.  
  25.         When you start the program you are asked for a filename for the output
  26. to go to. Just pressing RETURN will cause the output to go to the screen only.
  27. If you select a file then you will be asked what type you would like it to be
  28. set to. The default is text (FFF) but you could type (eg) 70A or C Source if
  29. such types were defined on your machine.
  30.  
  31.         You are then asked about the output file format. Selecting Wingpass,
  32. Aasm or C makes files directly suitable for these programs. Selecting other
  33. allows you to define your own format. If you do select other you will be asked
  34. for:
  35.         Equate operation. The operator symbol for 'becomes'. Examples:
  36.                 C, Wingpass     =
  37.                 Aasm            *
  38.         String to begin comment. This is placed at the start of a comment line.
  39.          Examples:
  40.                 C               /*
  41.                 Wingpass, Aasm  ;
  42.         String to end comment. This is placed at the end of every comment line.
  43.          Examples:
  44.                 C               */
  45.                 Wingpass, Aasm
  46.         String to start hex constant. This is a string that tells the program
  47.          that a number is written in hex. Examples:
  48.                 C, Wingpass     0x
  49.                 Aasm            &
  50.         Name prefix. This is an optional string used to prefix the generated
  51.          names. It is also asked for in 'C' mode. An example might be Swi_
  52.          so that names all began Swi_; for example Swi_OS_WriteI = 0x100.
  53.         End of file string. This is placed at the end of the file. Examples:
  54.                 C, Wingpass
  55.                 Aasm            END
  56.  
  57.         Finally you are asked what maximum SWI number should be checked. This
  58. defaults to &7FFFF, which covers all OS SWIs in current releases. However, a
  59. check to higher numbers may be safer in later OS versions.
  60.  
  61.         The file is echoed to screen as it is produced. There is also a status
  62. indication of how far through the search the program has got. This is not
  63. written to the file.
  64.  
  65. --- Package Documentation
  66.  
  67. *** Users of other shareware written by me please note - the text below may
  68. *** look the same as others but it is not. Take a few moments to look through
  69. *** it for differences, please.
  70.  
  71. This package contains:
  72. MakeSwi    0.40 (18th July 1989): BASIC program
  73. MakeSwiDoc 0.01 (18th July 1989): This document
  74.  
  75.    The software contained in this package is Shareware. The word 'Shareware'
  76. means many things to many pople, so I'll explain what I mean. In fact, some
  77. people would call this 'freeware' or 'public domain software' but it hardly
  78. matters what you call it - your obligations are set out below.
  79.    The program is free. You may make any number of copies and give them away to
  80. anyone (subject to the condition that you give them ALL the files in the
  81. package). You may not sell this software, or use it otherwise for personal gain
  82. without my permission. If you wish to post it on your Bulletin Board or include
  83. it in your Shareware library then that, too, is fine.
  84.    If you want to add any part of the code or data to one of your programs for
  85. your own use, then that's fine too. If you want to add it to something you plan
  86. to sell, or otherwise release as copyright material (whether for gain or not)
  87. then you'll need my permission - I retain copyright on this program.
  88.    If you like this program and find it useful then I would appreciate a small
  89. donation (say 5 pounds). This donation is a voluntary contribution.
  90.    If you send a donation and say which version of the package you have then I
  91. will send you an update if there is one. This disc will also contain up-to-date
  92. copies of as much of my shareware as will fit, plus any other stuff I can fit.
  93. There may be no update, since, for the moment, I've done all I want to to this
  94. program. Thus I don't guarantee that, if you send me money, I'll send you a
  95. new version of the program. You will, however, get a disc with things on it. If
  96. you'd prefer to wait until there is a disc with a new version on it then please
  97. say so. In this case you'll get a thankyou note.
  98.    This program has been tested with RISC OS. It should be suitable for both
  99. Arthur 1.2 and RISC OS. Please state, when sending for updates, whether you
  100. have RISC OS.
  101.    This software carries no warranty, either express or implied. I've tested it
  102. and, to the best of my knowledge, there are no bugs. If you come across a bug
  103. then I'd be delighted if you got in touch with me. I can't guarantee to fix it
  104. but I'll probably have a good try.
  105. My address is:
  106.         Martyn Lovell
  107.         16, Fairwater Park,
  108.         Barnwood,
  109.         Gloucester.
  110.         GL4 7HF
  111. No telephone calls please.
  112. However, I can be contacted as:
  113. Cix:       MartynL
  114. Janet:     ZCEEB02@UK.AC.UCL.EUCLID
  115. Interspan: Contact via Janet at above address
  116. Eureka II: Martyn Lovell (112)
  117. Note that, during university terms, I read all this EMail sites regularly but
  118. in the holiday periods I may read them less regularly.
  119. For bug reports please send the following information:
  120.         Machine Type
  121.         OS Version
  122.         Software Version
  123.         Modules Installed
  124.         Modules Unplugged
  125.         Podules Installed
  126.         Drives Installed
  127.         RAM Available
  128.         Monitor Type
  129.         Which OS was running at the time of the crash 
  130.         Is the bug repeatable
  131.         What is the file like
  132. and everything else that seems relevant.
  133.