home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / boota / !BootA / !Help < prev    next >
Encoding:
Text File  |  1991-12-16  |  10.5 KB  |  293 lines
  1. !BootA  -  RISC OS front-end for non-wimp-based applications
  2. ------------------------------------------------------------
  3.  
  4. Note: The term 'client application' is used below to refer to a
  5.       non-wimp-based application which is 'installed' via the
  6.       !BootA front-end.
  7.  
  8.       The term 'client icon' is used for the client application's
  9.       icon installed by !BootA on the icon bar.
  10.  
  11.  
  12. Starting !BootA
  13. ---------------
  14.  
  15. !BootA is started automatically when you install a client
  16. application by double-clicking on its icon in a directory viewer.
  17. You should double-click on the !BootA icon itself ONLY when you
  18. want to install the list of client applications specified in the
  19. !Init file (see 'Installing Client Applications Automatically'
  20. below).
  21.  
  22.  
  23. Installing a client application on the icon bar
  24. -----------------------------------------------
  25.  
  26. Double-click on the icon for the application in the corresponding
  27. directory viewer. The client icon will be installed at the right
  28. of the icon bar and !BootA will be started if it is not already
  29. active. If a sprite with the same name as the client application
  30. is found in the Wimp sprite pool, !BootA uses this for the icon.
  31. This is the normal case when a !sprites file exists in the
  32. application directory and contains a sprite with the same name as
  33. that application directory. If no such sprite is found, !BootA
  34. uses the generic 'application' sprite.
  35.  
  36.  
  37. Running the client application
  38. ------------------------------
  39.  
  40. Drag a file or directory icon to the client icon on the icon bar.
  41. This is equivalent to pressing f12 and then entering the
  42. following command:
  43.  
  44.     *RUN  client-appl  object
  45.  
  46. where 'client-appl' is the fully qualified name of the client
  47. application directory and 'object' is the fully qualified name of
  48. the file or directory that was dragged.
  49.  
  50. It is also possible to run the application by just clicking on
  51. the client icon, which is equivalent to the following command:
  52.  
  53.     *RUN  client-appl
  54.  
  55.  
  56. Supplying additional command line input to the client application
  57. -----------------------------------------------------------------
  58.  
  59. Click MENU over a client icon and chose the 'CmdOpts' option. A
  60. window will appear in which you can enter up to 50 characters of
  61. additional information to be passed to the client application.
  62. Press RETURN when you have finished entering the data. Dragging a
  63. file or directory to the client icon will now be equivalent to
  64. entering the following command:
  65.  
  66.     *RUN  client-appl  object  cmdopts
  67.  
  68. The additional information will typically be option flags. Once
  69. entered, the 'CmdOpts' data is retained as long as the client
  70. icon remains displayed on the icon bar. It can be updated at any
  71. time by choosing 'CmdOpts' again from the menu. An initial value
  72. for this 'CmdOpts' data can be supplied by creating a file called
  73. '!CmdOpts' in the client application directory (see supplying
  74. default CmdOpts information below).
  75.  
  76.  
  77. Removing a client application from the icon bar
  78. -----------------------------------------------
  79.  
  80. Click MENU on the client icon and chose 'Quit' from the resulting
  81. menu. The icon will disappear from the icon bar. If it is the
  82. last client icon, !BootA itself will terminate.
  83.  
  84.  
  85. Terminating !BootA
  86. ------------------
  87.  
  88. !BootA will terminate automatically when the last client icon is
  89. removed from the icon bar via the 'Quit' option from the menu.
  90. Alternatively, you can force !BootA to terminate by calling up a
  91. 'Task display' from the task icon (at the extreme right of the
  92. icon bar), clicking the mouse menu button on the display line for
  93. !BootA and chosing 'Quit' from the resulting menu. This will
  94. remove all client icons from the icon bar and terminate !BootA.
  95.  
  96.  
  97. !BootA Menu
  98. -----------
  99.  
  100. Clicking MENU over a client icon will result in a menu with the
  101. following options:
  102.  
  103.  Info:     which displays version information about !BootA.
  104.  
  105.  Help:     which displays brief help text about the client
  106.            application
  107.  
  108.  CmdOpts:  which causes a dialogue window to appear for entering
  109.            or updating the additional input to be passed to the
  110.            client application.
  111.  
  112.  Quit:     which removes the client icon; if this is the only
  113.            client icon to be displayed !BootA will terminate.
  114.  
  115.  
  116. Client Application Directory Format
  117. -----------------------------------
  118.  
  119. The client application directory must contain at least two files:
  120. the !Run file and the !RunA file. The !Run file contains the
  121. commands to start up !BootA and install the client icon. These
  122. commands will normally be:
  123.  
  124.   If "<BootA$Appl>" = ""  then Error BootA cannot be found
  125.   Set BootAclient <Obey$Dir>
  126.   Run <BootA$Appl> <BootAclient>
  127.  
  128. Note that this relies on the variable BootA$Appl being defined.
  129. This is set by the !Boot file in the !BootA application directory
  130. so that before double clicking on any client application, a
  131. directory viewer should be opened for the directory containing
  132. !BootA. The easiest way to do this is to place all the client
  133. applications in the same directory as !BootA itself.
  134.  
  135. The !RunA file should contain the commands to run the client
  136. application itself and so corresponds to the !Run file for a
  137. normal RISC OS application. The core of this file will normally
  138. be a command such as:
  139.  
  140.   Run <Obey$Dir>.!RunImage %*0
  141.  
  142.  
  143. Installing Client Applications Automatically
  144. --------------------------------------------
  145.  
  146. One or more !BootA client applications can be installed
  147. automatically at Desktop start-up time by including a single
  148. command in the DeskTop initialisation file as described in the
  149. Archimedes User Guide. This command should start the !BootA
  150. application itself, specifying the required client applications
  151. as arguments:
  152.  
  153.   e.g. Run adfs::HardDisc4.$.!BootA
  154.            adfs::HardDisc4.$.!Lock  adfs::HardDisc4.$.!Unlock
  155.  
  156. The !BootA application will also accept an initialisation file
  157. containing a list of client applications to be installed:
  158.  
  159.   e.g. Run adfs::HardDisc4.$.!Boot
  160.            -file adfs::HardDisc4.$.!Boot.!Auto
  161.  
  162. The !BootA application directory as distributed includes a file
  163. called '!Auto' which contains a suggested (but ONLY suggested)
  164. list of client applications for starting automatically. There is
  165. also a file called '!Init' which contains a list of all the
  166. example client applications. If you double click on the !BootA
  167. icon, you will install all the client applications in this latter
  168. list.
  169.  
  170.  
  171. Supplying default 'CmdOpts' information
  172. ---------------------------------------
  173.  
  174. When !BootA 'installs' a client application, it looks in the
  175. application directory for a file called '!CmdOpts'. If found, it
  176. will set the 'CmdOpts' data for the application from the file
  177. contents (only first 50 characters will be used). The data in the
  178. file should not contain any newline or other control characters.
  179.  
  180.  
  181. Help support
  182. ------------
  183.  
  184. !BootA provides brief help text when the 'Help' option is chosen
  185. from the menu. It also supports the RISC OS !Help application by
  186. providing the same help message when !Help is active and the
  187. mouse pointer is over the client icon.
  188.  
  189. A standard help message is supplied but a customised message can
  190. be provided for a specific client application by including a file
  191. called '!HelpMsg' in that application's directory which can
  192. contain up to 231 characters of help message. More than 231 will
  193. be truncated. The text should be created without any newline or
  194. other control characters.
  195.  
  196.  
  197. BootA$Appl system variable
  198. --------------------------
  199.  
  200. This is set by the !Boot (and !Run) obey file in the !BootA
  201. application directory. The !Boot file will be run when a filer
  202. window is first opened for the directory containing !BootA. It is
  203. used by the standard client application !Run file to locate the
  204. !BootA application directory.
  205.  
  206.  
  207. BootA$Object system variable
  208. ----------------------------
  209.  
  210. !BootA sets this system variable to the following values before
  211. running the client application:
  212.  
  213.    FILE     meaning that a file icon was dragged to the client
  214.             icon.
  215.  
  216.    DIR      meaning that a directory icon was dragged to the
  217.             client icon.
  218.  
  219.    APPL     meaning that an application directory icon was
  220.             dragged to the client icon.
  221.  
  222.    NONE     meaning that the client application was started by
  223.             clicking on the client icon and no file or directory
  224.             icon was dragged to it.
  225.  
  226. This system variable can be tested in the client applications
  227. !RunA file to check for error situations and issue the
  228. appropriate message.
  229.  
  230.  
  231. BootA$Type system variable
  232. --------------------------
  233.  
  234. !BootA sets this system variable to the type of the file that was
  235. dragged to the client icon before running the client application.
  236. This type will be the same as that shown in directory viewer in
  237. full display mode - i.e. either 3 digit hex or a filetype name.
  238. If a directory was dragged, BootA$Type is set to 'DIR'. If the
  239. application was run by clicking on its icon (without dragging a
  240. file or directory to it), BootA$Type is set to 'NONE'.
  241.  
  242.  
  243. BootA$Dir system variable
  244. -------------------------
  245.  
  246. !BootA sets this to the name of the directory containing the file
  247. that was dragged to the client icon, or if a directory was
  248. dragged, to the directory name. It will be set to '@' if the
  249. application was run by clicking on its icon without dragging any
  250. file or directory to it.
  251.  
  252.  
  253. BootA$Leaf system variable
  254. --------------------------
  255.  
  256. If a file is dragged to the client icon, !BootA sets this
  257. variable to the leaf-name of the file. In all other cases
  258. (directory dragged or nothing dragged) it is set to a null
  259. string.
  260.  
  261.  
  262. BootA$CmdOpts system variable
  263. -----------------------------
  264.  
  265. !BootA always sets this to the information specified via the
  266. 'CmdOpts' option in the menu (which is initially set from the
  267. contents of the !CmdOpts file in the application directory).
  268.  
  269.  
  270. BootA$Handle system variable
  271. ----------------------------
  272.  
  273. !BootA sets this to the handle assigned by the window manager to
  274. the client application icon when BootA installs it on the icon
  275. bar. This handle can be used in conjunction with the BootAutil
  276. program to send a message to BootA requesting that a different
  277. sprite be used for the client icon on the icon bar. BootAutil is
  278. technically an application program itself (with a file type of
  279. FF8 or 'absolute'), so it should be run by commands in the !RunA
  280. obey file (in addition to the client application program itself).
  281. It is located in the !BootA application directory, so can be run
  282. by the following command:
  283.  
  284.   *Run <BootA$Appl>.BootAutil -sprite xxxxxxxxxxxx
  285.  
  286. where 'xxxxxxxxxxxx' is the name of the new sprite. See !Compare
  287. !RunA file for an example of this. If the command to run
  288. BootAutil is issued from another application program (e.g. by
  289. using 'OSCLI"Run <BootA$Appl>.BootAutil -sprite xxxxxxxxxxxx"'
  290. within a BASIC program, then BootAutil will overlay that
  291. application program which will be lost.
  292.  
  293.