Configuration Variables

Here is a brief description of (most of) the variables controlling the configuration and run-time behavior of the omegahat script. the command to create a new directory. The default uses the GNU (and Solaris) facility which allows the creation of multiple directories in a single call, creating intermediate ancestor directories.
Variable Default Description
JAVA_HOME/usr/jdk1.2 location of the Java distribution, i.e. the directory in which the bin/ and lib/ directories containing the Java scripts and libraries reside.
JAVA2true flag which if defined indicates that the version of Java is Java 2, not 1.1 (or lower). This is used when constructing flags to invoke the Java scripts.
INSTALL_HOME$OMEGA_HOME the top-level directory which is used to contain the installed version of different files, typically the bin/, lib/ and include/ directories and their contents.
INSTALL_CORBA_INCLUDES $OMEGA_HOME/include/Corba directory into which the Omegahat CORBA header files are installed.
JDK_PLATFORM computed by jniParameters. Parameterizes the include and library locations in the C code for embedding of Java within S and R.
SWING_HOME${OMEGA_HOME}/Jars qualifier for the swingall.jar file used to compute the value of ${SWING} if it is unspecified as SWING_HOME/swingall.jar.
For Java2, this is not necessary. However, there are several bugs which can be fixed by replacing the boot classpath with a Jar file.
SWING${SWING_HOME}/swingall.jar complete name of the location of the Swing package. Not needed for Java2.
JAS${OMEGA_HOME}/Jars/jas.jar location of the Jas byte-compilation package .
ANTLR${OMEGA_HOME}/Jars/antlr.jar location of the Antlr 2.4.0 package needed for the generation of the parser and lexer and at run time by these derived classes.
CORBA${OMEGA_HOME}/Jars location of the different Jar files for CORBA. (Need to fix the makfiles to be more specific about include files, jar files, C++ libraries, etc.)
PERLperl command by which perl can be invoked. Default assumes in path.
WEBnotangle command by which the notangle executable can be executed to convert . Default assumes in path.
JAVA${JAVA_HOME}/bin/java the command for invoking the JVM. Override this if it is not in the standard place within the Java distribution, e.g. if you are using kaffe or japhar.
JAVA_CORE_CLASSES${JAVA_HOME}/lib/classes.zip for non-Java2 use, this specifies the core Java classes that must be included in the classpath argument to the JVM.
JAR${JAVA_HOME}/bin/jar the command for invoking the Java jar executable.
JDB${JAVA_HOME}/bin/jdb the command for invoking the Java debugger.
JAVAC${JAVA_HOME}/bin/javac the command for invoking the Java compiler. Override this if you are using guavac or jikes
JCFLAGS<empty> flags passed to the Java compiler such as -O, -g, etc.
JAR_FLAGScvMf flags controlling the creation of Jar files.
JAVA_DOCS_DIR$OMEGA_HOME/api target directory into which the files created by the javadoc command (and make rule) are written.
OMEGA_DEVELOPERtrue flag indicating whether we want to use the .class files in the source tree, or the Jar files which may not reflect any changes.
JHELP../Jars/jhall.jar location of the JHelp package from Sun, needed by the InteractiveEvaluator.
XML_CLASSES<empty> name of the directory or jar file containing the XML classes from Sun. With a few changes, the parser from IBM can be used.
NOERR<empty> the noerr.pl file which is used when compiling noweb code so that errors are reported relative to the .jweb file rather than .java. If this is not defined, it is not used.
COPYIFcpif command to execute the cpif executable which can be used to create source files from noweb source only if the contents have changed so as to minimize the number of compilations detected by make.
PRETZELprettyjava command to invoke the pretty printer for Java used to create documentation (e.g. dvi files) from the noweb files
WEBFOOTER$OMEGA_HOME/Docs/WebFooter name of the file (both LaTeX and HTML) appended to each documentation file created from its noweb source.
WEAVEXREF<empty> name of the file (both LaTeX and HTML) prefixed to each documentation file created from its noweb source.
SUPPORT_SIGNALS<empty> flag which if defined adds certain Java source files to the list to be compiled which rely on the Signals handling facility.
JDK_HOME$JAVA_HOME needed by the embedded JVM within S and R compilation
JDK_PLATFORM<computed> used in the flags for compiling the embedded JVM code for R and S.
JDK_HARDWARE<computed> used in the flags for compiling the embedded JVM code for R and S.
JNI_LIBS$JAVA_HOME/jre/lib/ used in the flags for linking the embedded JVM code for R and S. Depends on whether one is using Java2 or not, and the OS on which the libraries are being compiled.
INTERFACE_HOME$OMEGA_HOME/Interfaces/NativeInterface Used in the embedded Java material for R and S
IDL_INSTALL_INCLUDE_DIR ${INSTALL_HOME}/include/IDL Directory into which the IDL files in IDLTypes/ are copied during the installation of the CORBA material.
WEAVEHTML-filter l2h -index -html flags used by noweave when creating HTML files from noweb source.
WEAVETEX-filter prettyjava -index flags used by noweave when creating LaTeX files from noweb java source.
DOC_DEPSWebHeader WebFooter files on which HTML and LaTeX files created from noweb source depend and the associated derived files (e.g. dvi, ps, pdf, etc.) should be reprocessed if these changes. These live in $OMEGA_HOME/Docs/
WEBFLAGS-L'// line %L "%F"%N' flags used by notangle when converting noweb source to Java code.
SWEBFLAGS-L' \# line %L "%F"%N' flags used by notangle when converting noweb source to S code from Sweb files. Not used anymore.
WEAVEFLAGS-delay flags used by noweave to create This removes the default headers, etc.
SHOME/home/duncan/Projects/S4 the location of the installation of S4 or Splus5 (i.e. the directory identified as the default value for SHOME in the S or Splus5 script)
R_HOME /home/duncan/Projects/R the location of the R distribution, which is version 0.65 or higher. (You can find this by look at the default value in the R script.)
FINDfind command for executing the GNU find application.
CPcp -f command to copy one or more files.
MVmv command to move one or more files
MKDIRmkdir -p
TARtar command for running tar, should be GNU tar.

Other Runtime Configuration Variables

Ensure that you have an appropriate value for the environment variable OMEGA_HOME or that the default value in the omegahat script is set to the directory in which the distribution was installed (org/omegahat/). This can be done via the javaConfigure script that should be run from the org/omegahat/ directory.

When running the CORBA or embedded Java facilities in R or S, ensure that the LD_LIBRARY_PATH is set to include the appropriate directories. You will need the different Omega libraries usually installed in $OMEGA_HOME/lib.


Duncan Temple Lang <duncan@research.bell-labs.com>
Last modified: Wed Mar 22 14:41:50 EST 2000