home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / filemanager / director_1 / !Director / Utils / !ReadMe next >
Text File  |  1995-07-24  |  4KB  |  140 lines
  1. Utilities
  2. =========
  3.  
  4. This directory provides a few utilities that are useful in conjunction with
  5. Director.
  6.  
  7.  
  8. SWI Module
  9. ==========
  10.  
  11. The SWI module is (C) Jens H. Ovesen 1993 and is distributed with Director
  12. with permission.
  13.  
  14. This provides a single * command for running SWIs from the command line.
  15.  
  16. Syntax
  17. ------
  18.   *SWI <expression> [<expression>]^ [TO <variable>[ <variable>]^ [;<variable>]]
  19.  
  20. <expression> is a string that is OS_GSTrans'ed before it's read. If it has ""
  21. around it or it can't be read as a number, it's expected to be a string.
  22. Otherwise it's read as a number value.
  23.  
  24. <variable> is a system variable. If a '$' is found in <variable>, the
  25. register is expected to be a pointer to a string, and the system variable
  26. will be created as a String type from that register. Otherwise it will be
  27. created as a Number type.
  28.  
  29. Please be aware that the machine may hang up if you don't know what you're
  30. doing.
  31.  
  32. Examples
  33. --------
  34.  
  35.   *SWI "OS_ReadLine" "12345678901" 10 32 126 to input$ length
  36.   *SWI XOS_CLI "cat $" to ;flags
  37.   *SWI <my$swi> <my$param> to my$output ; flags
  38.  
  39.  
  40. ExpandMenu
  41. ==========
  42.  
  43. This is for converting Pinboard+ menu files to Director menu files.  See the
  44. main manual for more details.
  45.  
  46.  
  47. RunFilerAc
  48. ==========
  49.  
  50. This is for starting off Filer_Action tasks.  It is useful if you want to do
  51. actions to files from the MenuMenu.
  52.  
  53. See the example menus for details.
  54.  
  55.  
  56. IfPodule
  57. ========
  58.  
  59. Detects presence of podules
  60.     
  61. Syntax
  62. ------
  63.   1) *IfPodule <podule> <command>
  64.         <command> executed if <podule> installed
  65.        
  66.   2) *IfPodule <podule> <command_1> <command_2>
  67.         <command_1> executed if <podule> installed
  68.         <command_2> executed if not installed
  69.        
  70.   3) *IfPodule <podule> <command> <param_1> <param_2>
  71.         <command> <param_1> executed if <podule> installed
  72.         <command> <param_2> executed if not installed
  73.  
  74. where <podule> can be:
  75.   1) a (partial) podule name, or
  76.   2) a 4-bit simple podule type
  77.   3) a 32-bit ID with the product type in the low 16 bits and
  78.      the manufacturer in the top 16 bits
  79.  
  80. Examples
  81. --------
  82.   *IfPodule SCSI "Echo SCSI installed"
  83.   *IfPodule Fax "Filer_Run !FaxManager" "Echo No FaxPack present"
  84.   *IfPodule LaserDirect "Set LD$Present" yes no
  85.   *IfPodule &1100A4 "Echo Acorn Ether3 installed"
  86.   *IfPodule 15 "Echo Nick’s Magic podule is available"
  87.  
  88.  
  89. IfThereIs
  90. =========
  91.  
  92. Detects presence of files or directories.
  93.  
  94. Syntax
  95. ------
  96.   *IfThereIs [-Not] [ -File | -Dir | -App | -Image ] [-x] <object>
  97.              <‘yes’ command> [<‘no’ command>]
  98.            | <command> <‘yes’ param> <‘no’ param>
  99.  
  100.   1) *IfThereIs [options] <object> <command>
  101.         <command> executed if <object> found
  102.        
  103.   2) *IfThereIs [options] <object> <command_1> <command_2>
  104.         <command_1> executed if <object> found
  105.         <command_2> executed if not found
  106.        
  107.   3) *IfThereIs [options] <object> <command> <param_1> <param_2>
  108.         <command> <param_1> executed if <object> found
  109.         <command> <param_2> executed if not found
  110.  
  111. -x makes IfThereIs take the no option if any OS errors reported during the
  112. testing.
  113.  
  114. Examples
  115. --------
  116.   *IfThereIs -App Apps:!ArtWorks "Echo ArtWorks installed"
  117.   *IfThereIs <Obey$Dir>.!Run "<Obey$Dir>.!Run" "Echo No !Run file"
  118.   *IfThereIs Resources:$.Apps.!Help "Set Help$Present" yes no
  119.   *IfThereIs -Image ADFS::0.$ "Echo Dos Disc: " yes no
  120.  
  121. DriveName
  122. =========
  123.  
  124. This is used for finding the name of a drive from its drive spec.
  125.  
  126. Syntax
  127. ------
  128.   Syntax: *DriveName <varname> <drivespec>
  129.  
  130. Examples
  131. --------
  132.   *DriveName Name ADFS::4
  133.   *DriveName Name ADFS::4.$
  134.   *DriveName Name ADFS::4.$.!Boot.Library
  135.  
  136. All of these set the system variable Name to the name of the drive
  137.  
  138.   *Show Name
  139.   Name : HardDisc4
  140.