home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / GWINDOWS / scriptmaster.lzh / readme next >
Text File  |  1996-01-01  |  7KB  |  158 lines
  1.                                Script Master
  2.                      shell script manager for G-Windows
  3.                   Copyright 1994, 1996 by Stephen Carville
  4.  
  5.  This program provides an integrated environment for managing your commonly 
  6.  used shell scripts.  You can Edit, Create, Delete, Rename and Run shell 
  7.  script without ever leaving the program environment.  
  8.  
  9.  Getting Started
  10.  
  11.  For convenience, you may specify the editor to use with an environment 
  12.  variable.  The program will look for the variable named "EDITOR" first and 
  13.  the name "EDIT" second.  Both of these are common to many other OS9 programs 
  14.  so may well be defined already.  If either is defined, the editor named will 
  15.  be used.  If no editor is specified, the program will default to umacs.  
  16.  
  17.  To start the program chd to your GWINDOWS directory and use 'makdir' to 
  18.  create a new directory.  If you have extracted the complete archive the 
  19.  default directory has already been created for you.
  20.  
  21.  Now type "scriptmaster <>>>/win&" at the shell prompt or double click on the 
  22.  program icon.  IT IS VERY IMPORTANT THAT YOU USE I/O REDIRECTION.  Script- 
  23.  master must be able to control it's own windows so will close all standard 
  24.  paths to it's startup window which may cause that window to dissappear.  
  25.  
  26.  Two command line options are available.  You may change the title displayed 
  27.  on the window bar and hibernate icon and you may specify the directory to 
  28.  read scripts from:  
  29.  
  30.     -t=<new title> - title to display.  Default="Scripts"
  31.  
  32.     -d=<directory> - directory to get scripts from.
  33.                      default=$(HOME)/GWINDOWS/WORK_OUT.SCRIPTS
  34.                      
  35.  "$(HOME)" is the directory specified in your HOME environment variable.  If 
  36.  unavailable, the default device specified on startup by init is used - this 
  37.  is usually "/dd".  This practice of using the HOME environment variable 
  38.  allows scriptmaster to work on G-Windows systems which have several users, 
  39.  each with their own HOME directory.  
  40.  
  41.  The command line convention lets you have more than one script directory 
  42.  and several copies of scriptmaster running with each monitoring a different 
  43.  directory.  A sample startup.gw entry might look like:
  44.  
  45.     scriptmaster <>>>/win&
  46.     scriptmaster -t=Games -d=/dd/GWINDOWS/GAMES <>>>/win&
  47.  
  48.  This will start up scriptmaster twice but each will have a different title 
  49.  and run scripts from a different directory.  
  50.  
  51.  If the directory specified or the default is not available the program will 
  52.  terminate with an error advisory.
  53.  
  54.  The program will start up as a hibernate icon so you will have to click on 
  55.  this to bring up the program window.  If any scripts are available in the 
  56.  directory being monitored, they will be displayed in the scrolling window
  57.  at the right.  To run a script, either double click on it's name or select 
  58.  the name with the mouse and click on the "run" button.
  59.  
  60.  When a script begins running it will print to a specially created terminal 
  61.  window which will be terminated when the script is done.   When the script 
  62.  is finished, scriptmaster will reappear as a hibernate icon.
  63.  
  64.  Commands
  65.  
  66.     +-------------------------------------------------------------------+
  67.     | +----------------------------+  +-------------------------------+ |
  68.     | | <name of selected script>  |  |  <list of available scripts>  | |
  69.     | +----------------------------+  |                               | |
  70.     | +-----+                         |                               | |
  71.     | | Run |                         |                               | |
  72.     | +-----+                         |                               | |
  73.     |                                 |                               | |
  74.     |     Script Master v.vv          |                               | |
  75.     |     By Stephen Carville         |                               | |
  76.     |     Copyright (c) 1996          |                               | |
  77.     |                                 |                               | |
  78.     |                                 |                               | |
  79.     |                                 |                               | |
  80.     |                                 |                               | |
  81.     |                                 |                               | |
  82.     |                                 |                               | |
  83.     |                                 +-------------------------------+ |
  84.     +-------------------------------------------------------------------+
  85.  
  86.  Menu options (right mouse button click):
  87.  
  88.  Run Script    - This causes your script to be executed just like you had 
  89.                  typed the name at a shell prompt.  Same as the "Run" button
  90.  
  91.  Edit Script   - Calls the editor so that the script may be modified.
  92.  
  93.  Rename Script - Renames the currently selected script.
  94.  
  95.  Delete Script - Deletes the selected script.  Prompts to be certain you 
  96.                  really want to do this.
  97.  
  98.  New Script    - Asks for a name for a new script and passes it to the editor
  99.  
  100.  Refresh List  - Refreshes the displayed list.  This will normally be done 
  101.                  automatically when any changes are made but, because scripts 
  102.                  can be copied in manually, is included as a just-in-case.
  103.  
  104.  Quit          - Frees all memory and quits the program.
  105.  
  106.  
  107.  Caveats and helpful information:
  108.  
  109.  When creating scripts for scriptmaster any program you wish to start up in 
  110.  it's own window must use I/O redirection unless the program creates it's 
  111.  own.  Scriptmaster will terminate the window it creates to run the script.
  112.  
  113.  Because scriptmaster waits for the script to finish and the shell created to 
  114.  die it can be monopolized by a script that forks a program without the "&" 
  115.  operator.  To avoid this always use the "&" operator on any programs that 
  116.  are to continue running after the script terminates.  For example:
  117.  
  118.     -t
  119.     #set up a shell window attached to the directory
  120.     setenv HOME /dd/C/SOURCE
  121.     chd
  122.     setenv _sh 0
  123.     shell -l <>>>/win&
  124.     
  125.     # setup a special window for the editor 'ed'
  126.     setenv WINDOW TX=81,TY=32,BS=$08,QF=-1,TF=$00ffff,TB=$600000,FR=1
  127.     setenv QTERM vt32
  128.     ed <>>>/win&
  129.  
  130.  This script will chance to the C/SOURCE directory, start a shell and start 
  131.  the editor 'ed' in a specially defined window.  Of course if the programs 
  132.  called MUST run sequentially - such as some backup scripts do - you will 
  133.  either have to wait to get control back or adopt a strategy something like:
  134.  
  135.     chd /dd/C/SOURCE
  136.     backup_source <>>>/win&
  137.  
  138.  This will change to the C/SOURCE directory and call another script called 
  139.  "backup_source" to do the actual work.  This frees scriptmaster quickly and 
  140.  the backup continues as an independent process.
  141.  
  142.  As demonstrated above, it's not uncommon for one script to call another.  To 
  143.  avoid confusion scriptmaster adopts a special naming convention so that only 
  144.  the desired scripts are displayed.  Any script that scriptmaster is to 
  145.  display and access must begin with 'wk_' in lower case.  This is normally 
  146.  taken care of by the program but if you intend to copy scripts in manually, 
  147.  you need to be aware of it.  
  148.  
  149.  Report any comments, suggestions, bug reports, etc to:
  150.  
  151.     Stephen Carville
  152.     pagan@delphi.com
  153.     High G Software
  154.     P.O. Box 822
  155.     Glendora, CA 91740
  156.     (818) 914-2511
  157.  
  158.