Installing VPP

Getting VPP

The VPP source is available from the SourceForge project web site as both a .zip or as a .tar.gz. Get the latest release from here.

See the section Building VPP on how to build VPP from the source code.


System Requirements

VPP should run virtually anywhere that Ant runs, including including Linux, Cygwin, commercial flavors of Unix such as Solaris, AIX, HP-UX, Windows 9x and NT, Novell Netware 6 and MacOS X.

To build and use VPP, you must have an Ant 1.5.x or 1.6.x release installed and ANT_HOME defined. The necessary Velocity libraries are included with the VPP.

Finally, to execute VPP, you will also need a JDK installed on your system, version 1.2 or later.


Installing VPP

Before Ant 1.6, extensions were installed by copying .jars into $ANT_HOME/lib. Since 1.6, there is a new way to extend Ant using the Antlib convention. VPP may either be installed as an extension or as an Antlib.

Note: How you will use VPP in your projects depends on whether you install VPP as an extension or as an Antlib.

Install VPP as an Extension (the 'Old Way')

This method is supported by both Ant 1.5 and 1.6 releases, so is currently the safest to use.

  1. Install Ant and define ANT_HOME, if you haven't already
  2. Download and uncompress the VPP release on your local system.
  3. Change directory to your VPP installation directory and execute
    	ant deploy
    
  4. You are now ready to use VPP in your build files as an extension, so see the section on Using VPP to see what to do next.

Install VPP as an Antlib (the 'New Way')

This method is only supported by 1.6 releases.
  1. Install Ant and define ANT_HOME, if you haven't already.
  2. Download and uncompress the VPP release on your local system.
  3. Add $VPP_HOME/foundrylogic-vpp-2.0.0a2.jar to your CLASSPATH.
  4. You are now ready to use VPP in your build files as an Antlib, go so the section on Using VPP to see what to do next.

What Gets Installed

The VPP distribution consists of the following directory layout:

   $VPP_HOME          // installation directory
   |
   +--- doc           // contains documentation
   |    |
   |    +--- api      // contains VPP Javadoc API
   |    |
   |    +--- howto    // contains various VPP howto guides
   |    |
   |    +--- manual   // contains this manual
   |
   +--- example       // contains a simple project demonstrating VPP
   |
   +--- lib           // contains VPP and dependent jars
   |
   +--- src           // contains VPP sources

Building VPP

Building VPP from source requires Ant 1.6 or later.

To build, simply:

  1. Change directory to your VPP installation directory.
  2. Execute ant build deploy.

Library Dependencies

VPP depends on the following libraries:

Jar Name Version Available At
ant.jar
  • 1.5.x (to run only)
  • 1.6.x (to build VPP and run)
  • http://ant.apache.org
    velocity-dep-1.3.1.jar 1.3.1 http://jakarta.apache.org/velocity


    Copyright © 2002-2004 FoundryLogic, LLC. All rights Reserved.