******************************************************************************************
* SATAN is freely available for application in research.
* Any commercial use is prohibited. (Copyright Karl-Heinz Schmidt)
* The code is provided "AS IS", without warranty of any kind. We shall not
* be liable for any damages arising out of your use of the code.
******************************************************************************************
How to install SATAN on WINDOWS with
source code and PL/I compiler
To install SATAN you need to compile and
link the SATAN package on your local computer. The necessary steps are described in the following.
SATAN can be installed on WINDOWS95, WINDOWS98, WINDOWS/NT, WINDOWS2000, WINDOWS/XP, and Wine (under LINUX).
Additional information how to install SATAN under Wine can be found here.
1. Install the PL/I Compiler "IBM VisualAge PL/I Enterprise for Windows".
SATAN has been developed for the IBM VisualAge PL/I Enterprise for Windows Version 2.1.07
(C) Copyright IBM Corp., 1998
and Versions 2.1.10, 2.1.11, 2.1.12, 2.1.13, 2.1.14.
( An older version of the compiler can be updated using the
downloads from IBM.)
2. Copy the source files
Create a folder \FRSTOOLS\TRI. Download the necessary files
into this folder.
It is highly recommended not to change the folder structure, because several features of
SATAN rely on the full file names!
After installation, the file structure should look like this:
\FRSTOOLS
\FRSTOOLS\TRI
\FRSTOOLS\TRI\FIT
\FRSTOOLS\TRI\GHELP
\FRSTOOLS\TRI\GRAF
\FRSTOOLS\TRI\GTUT
\FRSTOOLS\TRI\SATAN
\FRSTOOLS\TRI\WINREV
\FRSTOOLS\TRI\WORKSPACE.
3. Adapt to your configuration:
After copying the files, adjust the file \FRSTOOLS\TRI\WinVersion.MAC to your
conditions. The following two lines should correspond to your configuration like in this
example:
If you have Windows/NT, WINDOWS2000 or WINDOWS/XP: " %C_VERSION = 'WINNT';",
For Windows/95 and WINDOWS98 enter: " %C_VERSION = 'WIN95';",
Adapt the file \FRSTOOLS\TRI\Tripath.MAC. If the path where you copied the TRI folder is on drive C:
" %REPLACE TRIPATH by 'C:\FRSTOOLS\TRI\';"
Define TRIPATH as an environment variable, e.g. as
"C:\FRSTOOLS\TRI". (See
below "III. Setting environment variables")
4. Compile
Start the WINDOWS EXPLORER in the ..\TRI\ directory and double-click on
"COMPSATAN.BAT".
5. Create the executable
Create the folder \COMMANDS on the same drive as
the \TRI folder, e.g. C:\COMMANDS.
Start a DOS command window in the subdirectory \FRSTOOLS\TRI\ and enter "LINK". This will create the
executable \COMMANDS\SATAN.EXE.
Remark: Some files of the C run-time library (e.g.
SHELL32.LIB) are
demanded. Therefore, either the Microsoft C compiler should be installed on your
computer, or you have to copy the necessary files of the C run-time library into one of the folders
defined in the LIB environment variable (e.g. E:\program files\IBM\VAPLI\LIB).
6. Test the installation
Start a DOS command window in the directory \COMMANDS and enter
"SATAN" to start SATAN in order to test whether the installation was successful up to
this point.
7. Set environment variable.
Make the folder \COMMANDS known to all paths by setting the PATH environment
variable. (See
below "III. Setting environment variables")
8. Install the SATAN link (SLINK) command
You may prepare a batch file SLINK.BAT to provide a dedicated link procedure for SATAN
applications. Details are given below.
9. Customizing the language-sensitive editor
(There are several versions available:"evfpprs_SATAN-V2.R1.00.dat",
"evfpprs_SATAN-V2.R1.07.dat" to "evfpprs_SATAN-V2.R1.14.dat". Please chose the file which is adapted to your
compiler version.)
The corresponding version of the modified macro file "..\TRI\evfpprs_SATAN.dat" is prepared to make the SATAN
macros kown to the language-sensitive editor, provided with the PL/I compiler by IBM.
1. Rename the original file "..\IBMPLIW\Macros\evfpprs.dat" to
"..\IBMPLIW\Macros\evfpprs_IBM.dat".
2. Copy the file "..\TRI\evfpprs_SATAN.dat" into the folder
"..\IBMPLIW\Macros\"
3. Rename "\IBMPLIW\Macros\evfpprs_SATAN.dat" into
"..\IBMPLIW\Macros\evfpprs.dat"
(Depending on your installation, the dataset "evfpprs.dat" may also be located
in another directory, e.g. "..\Program
Files\IBM\Vapli\macros\evfpprs.dat".)
When the installation is finished, the commands "SATAN" and
"SLINK" should be executable from a DOS command windows in any directory. The default
path of SLINK or SATAN for input and output is the path from which SLINK or SATAN is
called.
For further detail look also \...\TRI\README.TXT.
SETTING ENVIRONMENT VARIABLES
(In the following it is assumed, that the user files are on drive
C: ; if the user
files are on another drive, C: has to be replaced by the appropriate symbol.)
WINDOWS/XP:
Procedure to create the environment variable TRIPATH:
Start -> Settings -> Control panel -> System ->
Extended -> Environment
Proceed in the following way:
Enter the logic name of the environment variable in the field "Variable":
TRIPATH
Enter the folder name in the field "Value". Example:
C:\FRSTOOLS\TRI"
Procedure to make the commands in the folder G:\COMMANDS known
to all directories:
Start -> Settings -> Control panel -> System ->
Extended -> Environment
Proceed in the following way:
Enter the logic name of the environment variable in the field "Variable": PATH
Add the folder name in the field "Value".
Note that the different
folder names are divided by ";".
Do not delete or modify the previously existing entries in the path variable,
just add the COMMANDS folder!
Example: " ....previous entries...;C:\COMMANDS"
WINDOWS95 or WINDOWS98:
Add the environment variable TRIPATH with the
folder C:\FRSTOOLS\TRI to the dataset AUTOEXEC.BAT.
Add the folder
C:\COMMANDS to the path variable in the dataset AUTOEXEC.BAT.
Do not delete or modify the previously existing
entries in the path variable, just add the COMMANDS folder!
SPECIAL COMMANDS
SLINK: Prepare the file "\COMMANDS\SLINK.BAT" to link SATAN
applications:
(Note that the text from ILINK to kernel32.lib is contained in one line!)
@echo off
rem *******************************************************************************
rem * The SLINK command can be used from any path, after the following procedure: *
rem * This SLINK.BAT command file has to be put into the folder G:\COMMMAND
*
rem * The path \COMMAND has to be added to the PATH
variable:
*
rem * The following procedure is valid on
WINDOWS/NT:
*
rem * Start -> Settings -> Control panel -> System ->
Environment
*
rem * Enter the path in the following
way:
*
rem * in the field "Variable":
"PATH"
*
rem * in the field "Value":
"...;G:\COMMAND"
*
rem * (The three points denote any already existing
value.)
*
rem * Set the environment variable TRIPATH to the value of the TRI folder
*
rem * in the following
way:
*
rem * in the field "Variable":
"TRIPATH"
*
rem * in the field "Value":
"G:\FRSTOOLS\TRI"
*
rem * (Of course, also another drive can be used. In this case, the drive letter
*
rem * has to be replaced accordingly. It
is
*
rem * recommended to use the same drive (in this example "G:") for
the
*
rem * \COMMAND folder and for the \FRSTOOLS folder which contains the SATAN
*
rem * source
files.)
*
rem *******************************************************************************
echo.
echo SATAN Link procedure KHS 1999.
echo User modules (max. 9, must be fully qualified): %1 %2 %3 %4 %5 %6 %7 %8 %9
ILINK %1 %2 %3 %4 %5 %6 %7 %8 %9 %TRIPATH%\GRAF.OBJ %TRIPATH%\GRAF\*.OBJ %TRIPATH%\SATAN\*.OBJ %TRIPATH%\FIT\*.OBJ %TRIPATH%\LIESCHEN\*.OBJ /STACK:0x400000,0x4000 ibmws20i.lib _user32.lib _gdi32.lib cppws35.lib shell32.lib kernel32.lib
SATAN: Prepare a BAT file to start SATAN:
Create a dataset "$SATAN.BAT" in the path where you want to start SATAN.
Enter the command "SATAN" in the "$SATAN.BAT" file. Start SATAN by
double-clicking on the "$SATAN.BAT" file in the WINDOWS Explorer.