home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / misc / aliascol_1 / !ReadMe next >
Text File  |  1996-09-21  |  8KB  |  217 lines
  1. Kasoft's Alias Command Collection
  2. ---------------------------------
  3. Public Domain Version 1.04 (06 Mar 1992)
  4. Compiled by Kade Hansson
  5.  
  6. Using the Aliases
  7. -----------------
  8.  
  9. This collection of commands can be added to those that your RISC OS system
  10. recognises by running the Obey file Aliases. However, it is recommended that
  11. you insert the Aliases file into a !Boot file in a !System folder or another
  12. frequently activated !Boot file, so that they are always available. This can
  13. be done quite simply with the !Edit application.
  14.  
  15. The Run Action Aliases
  16. ----------------------
  17.  
  18. These aliases allow you to set the run type of various types of files. Some
  19. also allow you to change the run action of ALL files. As an example of the
  20. latter, the SetTypeEm command causes all files to be stamped with the given
  21. file type when run. This provides a simple way to set file types:
  22.  
  23. 1. Issue the *SetTypeEm <type> command.
  24. 2. Run (or double-click on desktop) the file(s) to be typed.
  25. 3. Issue the *RunEm <type> command to allow files to be run in normal fashion
  26.    once more.
  27.  
  28. Other commands which perform similar functions to SetTypeEm are LoadEm and
  29. RunEm (used above to reset to normal after SetTypeEm). However, it is often
  30. more useful just to set the run action of one particular type of file. The
  31. Action and CAction commands provide a simple way to do this. They take the
  32. form:
  33.  
  34. *Action <hex file type> <command>
  35.  
  36. So, issuing the command:
  37.  
  38. *Action FED Dump
  39.  
  40. would cause all palette files to be *Dumped when run. The CAction command
  41. works in the same way, except it clears the screen and activates page mode
  42. before, in this case, *Dumping the file.
  43.    Commands related to CAction and Action include ReadEm, which lists text
  44. files when run, SysSprites, ScreenSprites and PoolSprites. These commands
  45. have no parameters.
  46.  
  47. Display Control Commands
  48. ------------------------
  49.  
  50. Many of these commands have equivalents in BASIC. The only difference between
  51. them is that the parameters are separated by spaces, not commas. Here are
  52. some examples:
  53.  
  54. *Mode 12
  55. *Colour 1 255 0 0
  56. *GCol 1 1
  57. *CLS
  58. *CLG
  59.  
  60. Some other commands have not so obvious equivalents in BASIC:
  61.  
  62. *Pen 1
  63. *Paper 0
  64. *Ink 1 1
  65. *MouseColour 0 255 255 255
  66.  
  67. The rest would normally have to be done by hard to remember VDU sequences or
  68. FX commands:
  69.  
  70. *Explode
  71. *Symbol 32 254 130 130 130 130 130 254 0
  72. *Implode
  73. *Window 10 70 10 22
  74. *Page
  75. *KillPage
  76. *Kill
  77. *Revive
  78. *CancelVDU
  79. *Reverse
  80. *Tidy
  81. *Wait
  82. *Flash 7 0 0 0 255 255 255
  83. *SpeedInk 1 1
  84.  
  85. Printing Commands
  86. -----------------
  87.  
  88. The printing commands include ones which select different printer output:
  89.  
  90. *NetPrint
  91. *ParaPrint
  92. *SerialPrint
  93. *NullPrint
  94. *FilePrint adfs::0.$.PrintOut
  95.  
  96. The PrOut command allows the output of a command to be directed to a printer.
  97. For example:
  98.  
  99. *PrOut CLS           -would do a page feed
  100. *PrOut Echo <10>     -would do a line feed
  101. *PrOut Cat           -would catalogue the current directory
  102. *PrOut Modules       -would list installed relocatable modules
  103.  
  104. Two other printer commands allow screen output to be echoed to the printer:
  105.  
  106. *Printer
  107. *KillPrint
  108.  
  109. Miscellaneous commands
  110. ----------------------
  111.  
  112. Here are some examples of the other commands provided:
  113.  
  114. *EscapeOn                      *EscapeOff
  115. *HardReset                     *Exterminate $.Directory
  116. *Beep                          *Clear
  117. *Lock Unplug                   *Unlock Unplug
  118. *ResetKeys                     *SpeedKey
  119. *BreakUp                       *Blank
  120. *CursorEdit                    *Arrows
  121. *CursorF                       *Delay 4
  122. *Sh                            >TWIN
  123. *FixCore                       *SoundReset
  124. *FontsOff                      *FontsOn
  125.  
  126. Appendix A - Command Summary
  127. ----------------------------
  128.  
  129. The following alphabetical list of commands describes briefly the use of each
  130. along with the parameters required by them enclosed in angle brackets. All
  131. these commands are *-commands or OS commands, so may need to be prefixed with
  132. a star in languages such as BASIC.
  133.  
  134. Action       - Set the run action of <file type> to <command>
  135. Arrows       - Make the cursor keys produce arrow symbols (their ASCII codes)
  136. Beep         - Send character 7 to the VDU drivers (i.e. Beep)
  137. Blank        - Black out the screen
  138. Border       - Set the border colour up with given <red>, <green> and <blue>
  139. BreakUp      - Causes the Break key to reset the computer (Beeb style)
  140. CAction      - Set run type for <file type> to clear paged screen & <command>
  141. CLG          - Clear the graphics window
  142. CLS          - Clear the text window
  143. CancelVDU    - Cancel VDU queue
  144. Clear        - Clear all buffers
  145. Colour       - Set actual colour <colour> to <red>, <green> and <blue>
  146. CursorEdit   - Make the cursor keys operate as normal
  147. CursorF      - Make the cursor keys act as function keys
  148. Delay        - Wait <time>x2.55 seconds for a key press
  149. EscapeOff    - Disable the escape key
  150. EscapeOn     - Enable the escape key
  151. Explode      - Explode soft character RAM allocation
  152. Exterminate  - Destroy file/directory <pathname>
  153. FilePrint    - Send all printed output to <filename>
  154. FixCore      - Fixes the File core in use error which crops up sometimes
  155. Flash        - Set colour <colour> to flash <r1>,<g1>,<b1>,<r2>,<g2> & <b2>
  156. FontsOff     - Temporarily forget the location of the outline fonts
  157. FontsOn      - Reinstate the location of fonts (only use after *FontsOff)
  158. GCol         - Set graphics mask <mask> and colour <colour>
  159. HardReset    - Causes the Reset button to generate a hard reset
  160. Implode      - Implode soft character RAM allocation
  161. Ink          - Set logical colour <logical> to physical colour <physical>
  162. Intercept    - Inform user when <command> is used and with what parameters
  163. Kill         - Disable VDU drivers
  164. KillPage     - Disable paged mode
  165. KillPrint    - Disable printer echo
  166. LoadEm       - Load files that are run (e.g. by double-clicking on desktop)
  167. Lock         - Disable command <command>
  168. Mode         - Change to display mode <mode>
  169. MouseColour  - Set mouse colour <colour> to given <red>, <green> and <blue>
  170. NetPrint     - Select network printer attached to 0.254
  171. NullPrint    - Select the printer sink (no output)
  172. Page         - Enable paged mode
  173. Paper        - Set text background colour <logical>
  174. ParaPrint    - Select the parallel printer port
  175. Pen          - Set text foreground colour <logical>
  176. PoolSprites  - When a sprite file is run, it is merged into the WIMP pool
  177. PrOut        - Send the output of the given <command> to the current printer
  178. Printer      - Echo screen output to printer
  179. Read         - Display text file in paged window
  180. ReadEm       - When a text file is run, it is displayed in a paged window
  181. ResetKeys    - Reset keyboard speed, clear keyboard buffer and function keys
  182. Reverse      - Swap text foreground and background colours
  183. Revive       - Enable VDU drivers
  184. RunEm        - Run files when run
  185. ScreenSprites- When a sprite file is run, the first sprite is displayed
  186. SerialPrint  - Select the serial printer port
  187. SetTime      - Set the real-time clock to <hh:mm:ss>
  188. SetTypeEm    - SetType files to <type> when run
  189. Sh           - Set Quiet bell volume
  190. SoundReset   - Resets the sound system
  191. SpeedInk     - Set <first> and <second> colour flash times in centiseconds
  192. SpeedKey     - Set keyboard repeat <delay> and repeat <rate> in centiseconds
  193. Symbol       - Redefine <character> to bitmap <l1>,<l2>,<l3>,<l4>,...,<l8>
  194. SysSprites   - When a sprite file is run, it is loaded into the system area
  195. Tidy         - Reset text window to the whole screen and clear it
  196. Twin         - Used by BASIC's TWIN command
  197. Unlock       - Reenable <command>
  198. Wait         - Wait for frame flyback
  199. Window       - Define text window as <left>,<right>,<top>,<bottom>
  200.  
  201. Appendix B - Updates, bug fixes, donations etc.
  202. -----------------------------------------------
  203.  
  204. Requests for updated versions of Kasoft's Alias Command Collection, cash
  205. donations and suggestions for new commands can be sent by Snail Mail to:
  206.  
  207. Kade Hansson
  208. 4/73 Alexander Street
  209. Shearwater 7307
  210. AUSTRALIA
  211.  
  212. (This address is correct as of September 1996.)
  213.  
  214. My e-mail address is:
  215.  
  216. kade_fh@postoffice.utas.edu.au
  217.