jMax documentation

Compiling jMax

Introduction
Prerequisites
Compilation
Building rpms

Introduction

This document explains how to recompile jMax from a source distribution.

Thanks to Michael Lechasseur (mlecha@music.mcgill.ca) for contributions to this document.

Prerequisites

The following elements are needed to recompile jMax:

the Java Development Kit (JDK) version 1.2 or higher.
the C compiler
GNU make

Check Installing jMax documentation for further information on JDK download and installation.

SGI platform

On SGI platform, GNU make resides in /usr/freeware/bin/gmake. Makefiles will not work with standard make.

Linux platform

You can install the JDK in the directory of your choice, as long as the JDK directory is defined in environment variables. The following place can be used for example: /usr/local/java.

Once you have defined installation directory, you must add environment variables definition. This can be done by adding the following lines (modify JAVA_HOME to reflect the current settings of your system):

JAVA_HOME="/usr/local/java"
PATH="$JAVA_HOME/bin:$PATH"

to your .bashrc file in your home directory (modify accordingly if you are using another shell).

Once this is done, you can check that the environment is correct by running the Java VM:

echo $PATH
echo $CLASSPATH
java -version

If the "Kaffe Java Virtual Machine" is installed on your system, you'll need to make sure that jMax finds the JDK binaries before it finds the Kaffe binaries. If you have Kaffe installed you'll get the output "Kaffe Virtual Machine" by typing "java -version" at the command line. You need to make the path to your JDK directory apprear first in your PATH statement, or you need to rename the Kaffe files to prevent their use:

  mv /usr/bin/java /usr/bin/java-kaffe
  mv /usr/bin/javac /usr/bin/javac-kaffe
  mv /usr/bin/jar /usr/bin/jar-kaffe

Note: it has been reported that Kaffee does not currently run jMax. We recommend that you use JDK instead.

Compilation

The compilation must be started in jMax sources root directory. Compilation command must specify both a target and an architecture which is passed in make variable ARCH.

General compilation targets

The following targets are defined in the top-level Makefile:

all: to recompile both C and Java part. The make variable ARCH must be defined
clean: to remove all C objects, executables, libraries and all Java .class and .jar files. The make variable ARCH must be defined
all_c: to recompile only C part. The make variable ARCH must be defined
clean_c: to remove all C objects, libraries and executables. The make variable ARCH must be defined
clean_java: to remove all Java .class and .jar files. The make variable ARCH must be defined

Compilation architecture

The following architecture names are defined:

i386-linux: Linux on Intel Pentium compatible processors
i686-linux: Linux on Intel Pentium-II compatible processors
r10k-irix6.5: Irix 6.5 on MIPS R10000 processors
r4k-irix6.5: Irix 6.5 on MIPS R4000 processors
r5k-irix6.5: Irix 6.5 on MIPS R5000 processors
ppc-linux: Linux on PowerPC processors
ppc-macosx: MacOS-X on PowerPC processors

These architecture names are passed to the makefiles by the ARCH variables, as in:

make clean ARCH=i686-linux

Platform specific targets

The following platform specific targets are defined:

i386-linux: compilation of C and Java parts for architecture i386-linux
i686-linux: compilation of C and Java parts for architecture i686-linux
ppc-linux: compilation of C and Java parts for architecture ppc-linux
ppc-macosx: compilation of C and Java parts for architecture ppc-macosx
sgi: compilation of C and Java parts for architectures r10k-irix6.5 and r5k-irix6.5
r5k-irix6.5: compilation of C and Java parts for architecture r5k-irix6.5
r10k-irix6.5: compilation of C and Java parts for architecture r10k-irix6.5

Compilation commands

To compile both C and Java on Linux/Intel:

make i686-linux

or equivalent:

make all ARCH=i686-linux

To do a 'clean' on Linux/Intel:

make clean ARCH=i686-linux

Building rpms

jMax sources can be used to build rpms, in order to ease installation and distribution on Linux platforms.

The necessary files for rpm building are included in the source rpm of jMax and in the jMax source distribution.

Building rpms from source rpm

After installing the source rpm (jMax-<VERSION>.src.rpm), just cd to the rpm spec directory (usually /usr/src/redhat/SPECS) and start building by:

rpm -ba jmax.spec

Building rpms from source distribution

This apply if you installed jMax sources from a .tar.gz file.

The file jmax.spec is in the source distribution, in subdirectory pkg/rpm/jmax.spec. For rpm building, the following files must be copied:

jmax.spec to the rpm spec directory, (usually /usr/src/redhat/SPECS)
jmax-<VERSION>.tar.gz to the rpm sources directory, (usually /usr/src/redhat/SOURCES)

After copying those files, just cd to the rpm spec directory and start building by:

rpm -ba jmax.spec