
README FILE for:

'Salvation Scheduler' version 1.5 copyright Salvation Software 2003

--------------------
The Scheduler is fairly self explanatory. One of the types of tasks that
can be executed is 'Run Automation Script'. 

Full documentation can be obtained by visiting: www.geocities.com/salvationsoftware

Basic instructions for the scripting component of Salvation Scheduler are as follows:

The Script interpreter runs through the script specified by the scheduler, executing
commands in the file which it recognizes. When it finds a command it does
not recognize, the program will record in which line the error occured
to SSCRIPT.LOG, and proceed to the next command. This will also happen if 
one of the recognized commands is passed an invalid parameter(eg. if you 
try to use 'Load' or 'Open' for a program/shortcut/batch file that doesn't exist). 

Rules for Script Files:
-----------------------
* Commands must be typed one per line
* Commands can be upper or lower case, as long as they are spelt correctly
* <WINDOW NAME> can be in any case
* <WINDOW NAME> can be any part of the actual, full window name(eg. you could use
'notep' for 'Mydoc.txt - Notepad'
* If you want <WINDOW NAME> to correspond to the complete name of the actual window,
prefix and suffix the name by a * (eg. if you only wanted <WINDOW NAME> to identify
'Baldur's Gate' only, and not something that had 'Bladur's Gate' as a part of the name,
you would use '*Baldur's Gate*' as the <WINDOW NAME>
* in case you're confused, only one set of quotes is necessary for all these commands
* 'Load' can be substituted for 'Open' in any of the relevant commands

Supported Commands:
-------------------
Maximize('<WINDOW NAME>')
- Maximize the specified window

Minimize('<WINDOW NAME>')
- Minimize the specified window

Closewin('<WINDOW NAME>')
- Close the specified window

SetFocus('<WINDOW NAME>')
- Set the focus to the specified window

ChangeRes(<RESOLUTION MODE TO CHANGE TO>)
- 1: 640x480
- 2: 800x600
- 3: 1024x768

Reset
- No options, resets the computer

Shutdown
- No options, shutsdown the computer

Sdown(<SHUTDOWN MODE>)
- 1: Logoff
- 2: Shutdown
- 3: Reboot
- 4: Force

Dialout('<CONNECTION NAME TO DIAL>')
- Connection names are as they appear in the Dial-Up Networking folder.

Hangup()
- Disconnects from a connection that was automatically dialled previously

Open('<PATH>',<WINSTYLE>)
- Run a program or shortcut or open a file with its associated program

Print('<PATH>')
- Print a file using its associated application

PlaySound('<SOUND FILE>')
- Play a sound file(*.wav)

SendKeys('<WINDOW NAME>',<KEYS>)
- Send the specified sequence of keys to the specified window

Delay(<SECONDS>)
- Wait the specified time before executing the next instruction

MsgBox('<MESSAGE TO POPUP>')
- Popup a message

Beep()
- Make the default windows sound(usually a beep)

SendKeysDos('<WINDOW NAME>',<KEYS>)
- Only available to REGISTERED users
- Send the specified sequence of keys to the specified DOS window

Move('<SOURCE PATH>',<DESTINATION DIR>)

Copy('<SOURCE PATH>',<DESTINATION DIR>)

Delete('<PATH>'

OpenWait('<PATH>',<WINDOW STYLE>)
- Only available to REGISTERED users
- Load the specified program, wait until it has ended then continue
script

FindOpen('<FILENAME>',<STARTING DIRECTORY>)
- Only available to REGISTERED users
- Look for the specified file(starting from the specified directory)
and load/open it if it is found

Important Notes:
*The quotation marks(') above, MUST be included where specified
*SendKeys does not work for DOS windows
*Everything is case INsensitive
*Open can be substituted by Load in any command containing it
--------------------

The following table identifies the values for <WINDOW STYLE> and the resulting style of window:

Value Window style

1 Normal with focus(default).
2 Minimized with focus.
3 Maximized with focus.
4 Normal without focus.
5 Minimized without focus.
6 Hidden.

--------------------

Notes on the 'SendKeys' function:

The plus sign (+), caret (^), percent sign (%), tilde (~), and parentheses ( )
have special meanings to SendKeys. To specify one of these characters, enclose
it inside braces. For example, to specify the plus sign, use {+}. Brackets ([ ])
have no special meaning to SendKeys, but you must enclose them in braces as well,
because in other applications for Microsoft Windows, brackets do have special
meaning that may be significant when dynamic data exchange (DDE) occurs. To send 
brace characters, use {{} and {}}. To specify characters that aren't displayed 
when you press a key (such as Enter or Tab) and keys that represent actions rather
than characters, use the codes shown below:

Backspace {BACKSPACE} or {BS} or {BKSP} 
Break {BREAK}
Caps Lock {CAPSLOCK} 
Clear {CLEAR}
Del {DELETE} or {DEL} 
Down Arrow {DOWN}
End {END} 
Enter {ENTER} or ~
Esc {ESCAPE} or {ESC} 
Help {HELP}
Home {HOME} 
Ins {INSERT}
Left Arrow {LEFT} 
Num Lock {NUMLOCK}
Page Down {PGDN} 
Page Up {PGUP}
Print Screen {PRTSC} 
Right Arrow {RIGHT}
Scroll Lock {SCROLLLOCK} 
Tab {TAB}
Up Arrow {UP} 
F1 {F1}
F2 {F2} 
F3 {F3}
F4 {F4} 
F5 {F5}
F6 {F6} 
F7 {F7}
F8 {F8} 
F9 {F9}
F10 {F10} 
F11 {F11}
F12 {F12} 
F13 {F13}
F14 {F14} 
F15 {F15}
F16 {F16} 

To specify keys combined with any combination of Shift, Ctrl, and Alt keys,
precede the regular key code with one or more of the following codes:

Key Code

Shift +
Control ^
Alt %

To specify that Shift, Ctrl, and/or Alt should be held down while several 
ther keys are pressed, enclose the keys' code in parentheses. For example,
to have the Shift key held down while E and C are pressed, use "+(EC)". 
To have Shift held down while E is pressed, followed by C being pressed 
without Shift, use "+EC". To specify repeating keys, use the form {key number}; 
you must put a space between key and number. For example, {LEFT 42} means
press the Left Arrow key 42 times; {h 10} means press h 10 times.



--------------------

For updates/additional information:

Web Site: http://www.geocities.com/salvationsoftware
E-Mail:   alexburm@hotmail.com
