home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 4 / CDPD_IV.bin / fish / 891-910 / ff896 / scripttool / scripttool.doc < prev    next >
Text File  |  1994-05-04  |  4KB  |  147 lines
  1.  
  2.                 ScriptTool V1.02
  3.  
  4.             Copyright (c) 1993 by Jan Hagqvist
  5.  
  6.  
  7. COPYRIGHT
  8.  
  9.     Copyright (c) 1993, Jan Hagqvist, All Rights Reserved.
  10.  
  11.     This program is FREEWARE. You may freely use and distribute this
  12.     program under the following conditions:
  13.  
  14.     1) No modifications are made into the program or this documentation
  15.        and all the files are spread together. However, you are allowed
  16.        to compress all the files into an archive for distribution.
  17.  
  18.     2) No money (other than nominal copying fees) is charged for its
  19.        distribution.
  20.  
  21. DISCLAIMER
  22.  
  23.     THIS PROGRAM IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
  24.     EITHER EXPRESSED OR IMPLIED. THE AUTHOR WILL NOT BE LIABLE FOR
  25.     ANY DAMAGES, DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL,
  26.     RESULTING FROM THE USE OF THE PROGRAM. THE ENTIRE RISK AS TO THE
  27.     USE OF THIS PROGRAM IS ASSUMED BY THE USER.
  28.  
  29.  
  30. What is ScriptTool?
  31.  
  32.     ScriptTool is a Workbench-utility which makes it possible for you
  33.     to execute commonly used scripts or programs from Workbench's Tools-
  34.     menu. ScriptTool needs DOS2.0 (V36) or better.
  35.  
  36. How does it work?
  37.  
  38.     ScriptTool uses workbench.library's AddAppMenuItemA function to add
  39.     userdefinable menuitems to Workbench's Tools-menu.
  40.  
  41. How do I use it?
  42.  
  43.     To use ScriptTool, you need to copy ScriptTool into your Sys:c
  44.     drawer. You also need to write a script, which describes the menu
  45.     items you want to add. The script file is called ToolScript and it
  46.     needs to be placed into your Sys:s drawer. The format of the
  47.     script file is:
  48.  
  49.     Menu-item 1        ; These are the texts to appear in the
  50.     .            ; menus, they should tell what this
  51.     .            ; command/script does. One line per item.
  52.     Menu-item x        ; Max 49 bytes per line
  53.     <empty line>        ; This is very important!
  54.     Command 1        ; These are the commands/scripts to be
  55.     .            ; executed when the respective menu-item
  56.     .            ; has been selected. One line per item.
  57.     Command x        ; Max 99 bytes per line
  58.     <empty line>        ; This is important too!
  59.  
  60. Example
  61.  
  62.     Let's assume that,
  63.  
  64.     You want to add the following commands to the Tools-menu:
  65.  
  66.     DiskCopy df0: to df1:
  67.     Palette
  68.     ScreenMode
  69.     Virusc
  70.  
  71.     all these are in the Sys:c drawer. You also want to add the
  72.     following script to the Tools-menu:
  73.  
  74.     ; This script moves all the files from RAM: to DF1:
  75.     Copy Ram:#? Df1:
  76.     Delete Ram:#?
  77.  
  78.     the script is in the Sys:s drawer and it's called BackUpRam.
  79.  
  80.     The ToolScript would be as follows:
  81.  
  82.     Copy DF0 to DF1
  83.     Change palette
  84.     New screenmode
  85.     Virusc
  86.     BackUpRam
  87.     <empty line in here (linefeed=return=enter)>
  88.     Sys:c/DiskCopy df0: to df1:
  89.     Sys:c/Palette
  90.     Sys:c/ScreenMode
  91.     Sys:c/Virusc
  92.     Sys:s/BackUpRam
  93.     <another empty line>
  94.  
  95.     Also have a look at the example-drawer. You should copy the s, prefs
  96.     and wbstartup drawers to your sys:s, sys:prefs and sys:wbstartup
  97.     respectively. Note that the script 'ScriptTool' in the wbstartup-
  98.     drawer needs IconX to be in c: drawer. The example uses c:virusc,
  99.     c:ed and sys:prefs/screenmode.
  100.  
  101. Notes
  102.  
  103.     - To run ScriptTool from Shell, use 'run' to execute it.
  104.  
  105.     - To run ScriptTool from Workbench, use 'IconX' to execute it.
  106.  
  107.     - To use scripts the 'Execute'-command needs to be in the c: drawer.
  108.  
  109.     - Remember to set the 's'-flag in your scripts, using the 'Protect'-
  110.       command ('Protect script1 +s').
  111.  
  112.     - ScriptTool should accept any dos-command/script.
  113.  
  114.     - ScriptTool is able to handle 49 menu-items. Each itemtext may be
  115.       49 bytes long. Each scripttext may be 99 bytes long.
  116.  
  117.     - To exit ScriptTool, select 'Exit ScriptTool' from Tools-menu.
  118.  
  119.     - Note that you can't quit Workbench, if you haven't exited from
  120.       ScriptTool. Try it and you get 'Cannot Quit yet, open count = x"
  121.       error message.
  122.  
  123.  
  124.     Should any comments come to your mind, please write to:
  125.  
  126.     Jan Hagqvist
  127.     Reinolankatu 5 A 1
  128.     48600 KARHULA
  129.     FINLAND
  130.  
  131.  
  132. History
  133.  
  134. V1.01    (Saturday, 13 February 1993)
  135.     The first version I used. What happened to the V1.00, who knows?
  136.     This is a perfectly working version of the program and needs V37 to
  137.     run.
  138.     Size = 1256 bytes
  139.  
  140. V1.02    (Tuesday, 22 June 1993)
  141.     A very minor update. I was browsing the Kernel Manual and noticed
  142.     that V36 also has the workbench.library, so I made this program
  143.     to work under V36 too. Now it needs the V36 to run. (If I keep
  144.     browsing the manual I soon find that I can get it to work under 1.2
  145.     too, I guess).
  146.     Size = 1256 bytes (Still)
  147.