home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Club Amiga de Montreal - CAM
/
CAM_CD_1.iso
/
files
/
274.lha
/
Scripit_v1.0
/
Docs
/
Scripit.DOC
< prev
next >
Wrap
Text File
|
1989-08-06
|
7KB
|
196 lines
PRELIMINARY DOCUMENTATION
Scripit -- The Intuition Script Language
==========================================
By: Khalid Aldoseri
-------------------
'Scripit' is a script processor that reads in a script file and executes any
commands it finds in that file. The commands are executed sequentially.
To use Scripit just issue the following command from CLI:
Scripit scriptfilename
The format of the Scripit scriptfile should be normal text lines ending with
a carriage return. The accompanying file 'Commands' describes all the
available commands as well as their structure.
Format: Scripit [flags] [scriptfile]
Flags: -v Turns on Verbose mode.
-d Turns on Debug mode.
-x Loads Scripit Resident Arexx mode.
Format: Scripit -x [portname]
Where PortName is the portname Scripit will be referenced
by from ARexx.
-c Compile Script.
Format: Scripit -c [input file] [output file]
-w Disable Warnings.
Scripit's commands control other programs by manipulating their menus, gadgets
windows, and screens. The programs being controlled do not need any special
ports as all the messages they receive are simulated Intuition messages. In
fact, the programs don't even recognize that it isn't Intuition talking to
them!
You can also run Scripit from WB by clicking on its icon and then selecting
the script file from the file requester. (The file requester will first
search for a directory called Scripit:. If it doesn't find it, it will
use the current directory.)
Compiling Scripts:
------------------
Scripit can compile scripts into a special format that is usually around
30%-50% smaller in size than the original file and runs a lot quicker.
These files are automatically idetified by Scripit.
To compile a script:
Scripit -c [inputfile] [outputfile]
e.g. Scripit -s Access Acc
This creates a compiled file called 'Acc'.
To run a compiled script:
Scripit Acc
OR Xit Acc
'Xit' is a special version of Scripit that _only_ runs compiled files.
It is a lot smaller in size than Scripit, which allows it to load a lot
faster. If you try to execute a non-compiled script with 'Xit' it will
just quit.
Note: Compiled Scripit files can be identified by the first four bytes
in the file. They are 'X' 'I' 'T' '1'.
When you specify a non-compiled script file name to Scripit, it will
automatically compile it and then run it. However, if Scripit cannot
read in the whole file at once, (like when using '*' as a file name or
through pipes or if it cannot allocate enough memory to load in the
whole file at once) it will compile and execute it line by line.
Using 'Scripit *' will allow you to enter the 'live mode' where you
can enter commands directly from the console and each command will be
executed one by one as you type them in.
Using Scripit from Workbench:
-----------------------------
To use Scripit from the Workbench just double-click on its icon. The
file requester will come up allowing you to select a script file to
execute. You can also auto-invoke a script by double-clicking on
the script file's icon. Both 'Scripit' and 'Xit' can execute
scripts this way, however 'Xit' doesn't have a file-requester.
You can use any icon file as the script icon as long as it is
a project icon can be used. Just make sure that the tool name points
to either Scripit (for normal scripts) or Xit (for compiled scripts.)
Supporting Programs:
--------------------
1. Recorder:
This is a general Intuition event recorder that records what the user is
doing and saves it to a file you select. This saved file is totally
compatible with Scripit and when run from Scripit will recreate the
original user activities as closely as possible.
This is _not_ a keyboard and mouse macro recorder. It actually records all
messages going from Intuition to the currently active window. It will also
monitor what the active window is, and if it changes Recorder will add the
necessary commands to change the active window in the script as well.
The file created by Recorder can be edited as it is a normal script file.
To use Recorder, just run it from CLI: Recorder scriptfilename
After that do all the 'actions' you want, and when you want to stop the
recording, send it a Control-C by either clicking into the CLI window and
pressing Control-C or by using the 'break' command, or by closing its
window. (Note: the power LED will flicker as long as it is recording.)
To execute the saved script just use: Scripit scriptfilename
Recorder has several options. (Use Recorder ? to see the options.)
Format: Recorder [-flags] [scriptfile]
Flags: -c Adds comments to script.
-w Do not open display window.
-l Disable power LED activity meter.
-n Use menu & gadget numbers instead of text.
-t Disable time recording.
-m Disable MouseMoves recording.
-i Disable Intuiticks recording.
2. Lister
This is a general screen, window, menu and gadget listing facility that
will help in identifying the correct names or numbers of the items to be
controlled.
To use Lister, just run it. You will get a list of screens in the system.
You can then see the windows in a specific screen by typing the first few
letters of the screen name as Lister's first argument. You can go on to
specify window, menu, menuitem, subitem, or gadget. The format is:
Format: Lister [screen] [window] [menu] [item] [subitem]
or: Lister [screen] [window] -g [gadget]
If you would like to have a look at sample scripts, just look at the file
that Recorder produces. :-)
3. XitLoadWB
This program allows Scripit to control the WorkBench. Read the doc file
'WBench.DOC' for details on its usage.
4. AutoScript
Makes scripts auto-run. Read 'AutoScr.DOC' for details.
Notes on file requester:
The file requester has two hidden features:
1. click on the right mouse button to get a list of the volume names of
devices currently in the system. Click on it again to get the list
of 'logical' devices, i.e. assigns;
2. you can resize the file requester, the resize gadget is at the bottom
of the requester, all across the bottom border.
All comments, suggestions, bug reports, etc. should be send to:
Khalid Aldoseri, CIS 75166,2531.
Many thanks to Vic Wagner for his help with the script language,
Larry Phillips for coming up with the name 'Scripit', and mostly
to Brian J. Bartlett for countless hours in conference testing Scripit
and for lots of great suggestions.
Copyright 1989 Khalid Aldoseri.