XFP eXtensible Filtering Pipelines
  Font size:      

XFP Installation




  • Set the JAVA_HOME environment variable, if not already set. This should be set to the directory where your JDK is installed.
  • Set the XFP_HOME environment variable to the directory where you installed XFP. On some operating systems the shell scripts can guess XFP_HOME, but it is better to not rely on this behavior.


Assume XFP is installed in c:\xfp\. The following sets up the environment:

set JAVA_HOME=C:\j2sdk1.4.1_01
set XFP_HOME=c:\xfp

Unix (bash)

Assume XFP is installed in /usr/local/xfp. The following sets up the environment:

export JAVA_HOME=/usr/local/j2sdk1.4.1_01
export XFP_HOME=/usr/local/xfp

Unix (csh)

Assume XFP is installed in /usr/local/xfp. The following sets up the environment:

setenv JAVA_HOME /usr/local/j2sdk1.4.1_01
setenv XFP_HOME /usr/local/xfp

JVM performance tips

In order to optimize performance run the JVM with following options (set them in XFP_OPTS):

-server -Xms***M -Xmx***M

where *** is the number of megabytes you want to reserve for the JVM memory heap.

For more info go to http://java.sun.com/docs/hotspot/PerformanceFAQ.html

Compiling sources

To compile sources you have to install and configure the following products:

  • Apache Ant. Set ANT_HOME environment variable to Ant installation directory. Add $ANT_HOME/bin to your PATH environment variable. If you're running an RPM-based Linux distro you may want to check jPackage.
  • Apache Forrest (Only needed if you want to generate the documentation). Set FORREST_HOME environment variable to point at your Forrest installation directory.

Type this command from XFP sources directory:

ant dist

the XFP distribution packages will be created inside the dist/ directory.

You may want to run ant -projecthelp to discover other targets.

by Flavio Tordini