Setup
STEP Tools® software applications, makefiles, and project files use several environment variables to find runtime data, link libraries, and header files.
On Windows, the installer sets environment values and registry
keys. On MacOS and UNIX the rose_logicals.sh
file sets
environment variables using Bourne/Korn syntax,
while rose_logicals.csh
uses csh
syntax.
These files append $ROSE_BIN
to your search path and may
set $ROSE_LIB
to the shared library path.
In the following example, replace /usr/steptools
with
your STEP Tools® software installation
directory:
$ . /usr/steptools/rose_logicals.sh # Bourne/Korn users % source /usr/steptools/rose_logicals.csh # CSH users
Variables
The full list of possible environment variables is shown below.
The main variable is $ROSE
, which points to the root of the
installation.
STEP Tools® software may include versions
of the libraries built for different compilers or link options.
The ROSE_LIB
and
ROSE_CONFIG
variables are used by the Makefiles included
with the sample programs. These variables are set by the install
script to the default library version, but you can change them later
if you need to use alternate library versions.
- ROSE
- The STEP Tools® software install
directory. On Windows this is also set in the registry
under
Software\STEP Tools, Inc.\ST-Developer
. - ROSE_BIN
- Directory containing executables. Usually a platform specific
directory under
$ROSE/bin
. On Windows, this is added to your search path by the installer. On MacOS or UNIX, add this to your shell search path. - ROSE_INCLUDE
- Directory containing the STEP Tools®
software C and C++ header files. Usually
$ROSE/include
. Used by makefiles and Visual Studio project files. - ROSE_LIB
- Directory containing STEP Tools® software
C++ libraries. This variable points to one of the directories
under
$ROSE/lib
with the copies of libraries built with a particular compiler or link options. Only used by makefiles. Visual Studio projects explicitly refer to the matching compiler version. - ROSE_DLLDIR
- Windows only. Directory containing DLL versions of the STEP
Tools® software libraries.
Usually
$ROSE/dlls
. This directory is automatically added to your search path by the Windows installer. - ROSE_CONFIG
- Some C++ compilers require flags or other special treatment. This
is handled by makefile definitions in the
$ROSE/config
directory. Makefiles include one of these configuration files through the$ROSE_CONFIG
environment variable. The config file is usually chosen in the STEP Tools® software installation script. - ROSE_RUNTIME
- Optional, UNIX only. Location of the ST-Runtime support files. Applications built with the STEP and IFC programming libraries are self contained and do not need any of these. If not set, the ROSE library searches several alternate locations.
- ROSE_LICENSE
- Optional, UNIX only. Gives an alternate location for the STEP
Tools® software license key file. If not
set, tools look at
$ROSE/license
. On Windows, keys are found through the registry.
Early versions of STEP Tools® software
used the $ROSE_DB
variable to specify a list of
directories to search for data files. The dirs were separated by
colons (UNIX) or semicolons (Windows). This has been retired and API
calls that read files should be given a full path.