Smack Source Distribution

This document provides detailed information for developers that wish to compile and make changes to the Smack source code.

For additional developer resources, please visit: http://www.jivesoftware.org/smack/. The Smack build process is based on Ant. Visit the Ant website for more information. There is no need to download and install Ant - a version of it is included in this distribution.

This documentation is divided into two sections:

  1. Setup -- how to setup your environment for Smack development.
  2. Build tasks -- tasks that can be performed using the build program.

1. Setup Your Environment

Getting your machine ready for Smack development requires a few steps. Wherever possible, instructions are provided for both Unix/Linux and Windows users.

Configure Java

Test the Build Script

Finished!



2. Build Tasks

The list of build tasks is below. All build commands should be run from the "build" directory of your Smack distribution.

For a list of the commands and a brief description from the command line, type ant -projecthelp. For more complete help, read the documentation below.

To execute a build task, type ant [options] targetname where "targetname" is one of the targets listed below:

Each task is documented with a syntax guide and description. Optional paramaters for each task are enclosed with braces.

Default

compile

jar

javadoc

clean