2003-01-17 21:28:53 +01:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
|
|
|
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>Smack Source Distribution</title>
|
|
|
|
|
<style type="text/css">
|
|
|
|
|
BODY {
|
|
|
|
|
font-size : 100%;
|
|
|
|
|
}
|
|
|
|
|
BODY, TD, TH {
|
|
|
|
|
font-family : tahoma, verdana, arial, helvetica, sans-serif;
|
|
|
|
|
font-size : 0.8em;
|
|
|
|
|
}
|
|
|
|
|
A:hover {
|
|
|
|
|
text-decoration : none;
|
|
|
|
|
}
|
|
|
|
|
TT {
|
2008-11-03 17:28:57 +01:00
|
|
|
font-family : courier new, monospace;
|
2003-01-17 21:28:53 +01:00
|
|
|
font-weight : bold;
|
|
|
|
|
color : #060;
|
|
|
|
|
}
|
|
|
|
|
PRE, CODE {
|
2008-11-03 17:28:57 +01:00
|
|
|
font-family : courier new, monospace;
|
2003-01-17 21:28:53 +01:00
|
|
|
font-size : 100%;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<body>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<font size=4>
|
|
|
|
|
Smack Source Distribution<br>
|
|
|
|
|
</font><br>
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
This document provides detailed information for developers that wish to
|
|
|
|
|
compile and make changes to the Smack source code.
|
|
|
|
|
|
|
|
|
|
<p>For additional developer resources, please visit:
|
2004-10-31 01:39:48 +02:00
|
|
|
<a href="http://www.jivesoftware.org/smack/">
|
|
|
|
|
http://www.jivesoftware.org/smack/</a>. The Smack build process is based on Ant. Visit the
|
2003-01-17 21:28:53 +01:00
|
|
|
<a href="http://jakarta.apache.org/ant/index.html">Ant website</a>
|
2007-02-14 02:56:49 +01:00
|
|
|
for more information and downloads.
|
2003-01-17 21:28:53 +01:00
|
|
|
<p>
|
|
|
|
|
This documentation is divided into two sections:
|
|
|
|
|
<ol>
|
|
|
|
|
<li> <a href="#setup">Setup</a> -- how to setup your environment for Smack development.
|
|
|
|
|
<li> <a href="#tasks">Build tasks</a> -- tasks that can be performed using the build program.
|
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
|
|
<p><a name="setup"><b><font color="#0066cc">1.</font> Setup Your Environment</b></a><p>
|
|
|
|
|
|
|
|
|
|
Getting your machine ready for Smack development requires a few steps. Wherever
|
|
|
|
|
possible, instructions are provided for both Unix/Linux and Windows users.
|
|
|
|
|
<p>
|
|
|
|
|
<b><a name="javaSetup">Configure Java</a></b>
|
|
|
|
|
<ul>
|
2007-02-04 22:24:51 +01:00
|
|
|
Java 5 (JDK 1.5 or later) must be installed and setup on your machine. To test the installation,
|
2003-01-17 21:28:53 +01:00
|
|
|
open a shell in a Unix or a MS-DOS prompt in Windows. Check your version of
|
2007-02-04 22:24:51 +01:00
|
|
|
Java with "java -version" -- it must version 1.5 or greater.
|
2003-01-17 21:28:53 +01:00
|
|
|
If Java isn't installed, download a copy from the
|
|
|
|
|
<a href="http://java.sun.com/">Java website</a>.
|
|
|
|
|
<p>
|
2003-01-20 16:29:06 +01:00
|
|
|
<font color="red">Important!</font> -- the Smack build tool needs to know
|
2003-01-17 21:28:53 +01:00
|
|
|
where Java is installed on your system. You must configure the "JAVA_HOME"
|
|
|
|
|
environment variable to point to the correct directory. Instructions on
|
|
|
|
|
how to set this variable for various platforms are as follows:
|
|
|
|
|
<p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li> Unix/Linux
|
|
|
|
|
<ol>
|
|
|
|
|
<li>Edit the ".profile" file in your home directory (or
|
|
|
|
|
corresponding file for your shell).
|
|
|
|
|
<li>Set the JAVA_HOME environment variable by adding the
|
|
|
|
|
following line to the file:
|
2008-11-03 17:28:57 +01:00
|
|
|
<p><code>
|
2007-02-04 22:24:51 +01:00
|
|
|
export JAVA_HOME=/usr/local/jdk1.5
|
2003-01-17 21:28:53 +01:00
|
|
|
</code><font face="verdana, arial, helvetica" size=2>
|
|
|
|
|
<p>
|
2007-02-04 22:24:51 +01:00
|
|
|
The value "/usr/local/jdk1.5" should be replaced with your actual
|
2003-01-17 21:28:53 +01:00
|
|
|
Java directory. Be sure there are no spaces after the end of
|
|
|
|
|
the directory name. Do not add an extra slash after the directory name.
|
|
|
|
|
<li>Save changes to the file and then "source" it:
|
|
|
|
|
<p></font><code>
|
|
|
|
|
source .profile
|
|
|
|
|
</code><font face="verdana, arial, helvetica" size=2>
|
|
|
|
|
<p>
|
2008-11-03 17:28:57 +01:00
|
|
|
The JAVA_HOME variable should now be configured correctly.</font>
|
2003-01-17 21:28:53 +01:00
|
|
|
</ol>
|
2008-11-03 17:28:57 +01:00
|
|
|
</li>
|
|
|
|
|
<p>
|
2007-02-04 22:24:51 +01:00
|
|
|
<li> Windows
|
2003-01-17 21:28:53 +01:00
|
|
|
<ol>
|
|
|
|
|
<li>Navigate to your desktop and right click on "My Computer";
|
|
|
|
|
choose properties.
|
|
|
|
|
<li>Select the "Advanced" tab and click on the
|
|
|
|
|
"Environment Variables" button.
|
|
|
|
|
<li>Click the "New..." button in the System variables section.
|
|
|
|
|
Enter the variable name "JAVA_HOME" and set the variable
|
|
|
|
|
value to the full path of your Java installation. For example,
|
2007-02-04 22:24:51 +01:00
|
|
|
"c:\jdk1.5". Be sure to not add an extra slash to the end
|
2003-01-17 21:28:53 +01:00
|
|
|
of the directory name.
|
|
|
|
|
<li>Click "OK" in all of the menus to accept the changes.
|
|
|
|
|
<li>Close any open command prompt windows. The next time you
|
|
|
|
|
open a command prompt, the "JAVA_HOME" variable will be set
|
|
|
|
|
correctly.
|
|
|
|
|
</ol>
|
|
|
|
|
</ul>
|
|
|
|
|
</ul>
|
|
|
|
|
|
2007-02-14 02:56:49 +01:00
|
|
|
<b><a name="antSetup">Configure Ant</a></b>
|
|
|
|
|
<ul>
|
|
|
|
|
Download the Ant build tool from the <a href="http://ant.apache.org">Ant website</a>. Follow
|
|
|
|
|
the setup instructions for your operating system.
|
|
|
|
|
</ul>
|
|
|
|
|
|
2003-01-17 21:28:53 +01:00
|
|
|
<p><b><a name="checkout">Test the Build Script</a></b><p>
|
|
|
|
|
<ul>
|
|
|
|
|
Navigate into the subdirectory of this distribution named "build" via the command-line.<p>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<table border=0 cellpadding=2 cellspacing=0><td bgcolor="#EEEEEE">
|
2003-01-17 21:28:53 +01:00
|
|
|
<font face="verdana, arial, helvetica" size=2>
|
|
|
|
|
<font color="red">Linux/Unix users only:</font>You must make the ant script
|
|
|
|
|
executable. From the build directory, type:
|
|
|
|
|
<p></font><code>
|
|
|
|
|
chmod u+x ant
|
2008-11-03 17:28:57 +01:00
|
|
|
</code>
|
2003-01-17 21:28:53 +01:00
|
|
|
</td></table>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Now, invoke the build tool to compile the Smack source code
|
|
|
|
|
|
|
|
|
|
<p>
|
2008-11-03 17:28:57 +01:00
|
|
|
<font face="verdana, arial, helvetica" size=2> Windows:</font><code> ant <br>
|
2003-01-17 21:28:53 +01:00
|
|
|
</code><font face="verdana, arial, helvetica" size=2>
|
|
|
|
|
Unix/Linux:</font><code> ./ant
|
|
|
|
|
</code><font face="verdana, arial, helvetica" size=2>
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
If the build tool is invoked correctly and Smack compiles, you've correctly
|
|
|
|
|
configured your copy of the Smack developer distribution.
|
2008-11-03 17:28:57 +01:00
|
|
|
</font>
|
2003-01-17 21:28:53 +01:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p><b>Finished!</b><p>
|
|
|
|
|
<ul>
|
|
|
|
|
If you've gotten this far, you've finished setting up the Smack developer
|
|
|
|
|
distribution. Now, read below to learn about all of the tasks that you can perform
|
|
|
|
|
with the build tool.
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<br><br>
|
|
|
|
|
|
|
|
|
|
<p><b><a name="tasks"><font color="#0066cc">2.</font> Build Tasks</a></b><p>
|
|
|
|
|
|
|
|
|
|
The list of build tasks is below. All build commands should be
|
|
|
|
|
run from the "build" directory of your Smack distribution.
|
|
|
|
|
|
|
|
|
|
<br><br>
|
|
|
|
|
|
|
|
|
|
For a list of the commands and a brief description from the command line, type
|
|
|
|
|
<code>ant -projecthelp</code>. For more complete help, read the documentation below.
|
|
|
|
|
|
|
|
|
|
<br><br>
|
|
|
|
|
|
|
|
|
|
To execute a build task, type <code>ant [options] targetname</code> where "targetname" is
|
|
|
|
|
one of the targets listed below:
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#noparams"><i>Default</i></a>
|
|
|
|
|
<li><a href="#compile">compile</a>
|
|
|
|
|
<li><a href="#jar">jar</a>
|
|
|
|
|
<li><a href="#javadoc">javadoc</a>
|
|
|
|
|
<li><a href="#clean">clean</a>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>
|
|
|
|
|
Each task is documented with a syntax guide and description. Optional paramaters
|
|
|
|
|
for each task are enclosed with braces.
|
|
|
|
|
|
|
|
|
|
<!--COMPILE-->
|
|
|
|
|
<p><b><a name="noparams"><i>Default</i></a></b>
|
|
|
|
|
<ul>
|
|
|
|
|
<i>Syntax:</i><p>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<code>
|
2003-01-17 21:28:53 +01:00
|
|
|
ant<br>
|
2008-11-03 17:28:57 +01:00
|
|
|
</code>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p><i>Description:</i></p>
|
|
|
|
|
|
|
|
|
|
Equivalent of calling "ant <a href="#jar">jar</a>".
|
|
|
|
|
|
|
|
|
|
<p>[<a href="#tasks">return to task list</a>]
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<!--COMPILE-->
|
|
|
|
|
<p><b><a name="compile">compile</a></b>
|
|
|
|
|
<ul>
|
|
|
|
|
<i>Syntax:</i><p>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<code>
|
2003-01-17 21:28:53 +01:00
|
|
|
ant compile <br>
|
2008-11-03 17:28:57 +01:00
|
|
|
</code>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p><i>Description:</i></p>
|
|
|
|
|
|
2003-01-20 16:29:06 +01:00
|
|
|
Compiles all the Smack source code.
|
2007-02-04 22:24:51 +01:00
|
|
|
The build directory is the "target/classes" directory under your Smack source distribution.
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p>[<a href="#tasks">return to task list</a>]
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--JAR-->
|
|
|
|
|
<p><b><a name="jar">jar</a></b>
|
|
|
|
|
<ul>
|
|
|
|
|
<i>Syntax:</i><p>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<code>
|
2003-01-17 21:28:53 +01:00
|
|
|
ant jar <br>
|
2008-11-03 17:28:57 +01:00
|
|
|
</code>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p><i>Description:</i></p>
|
|
|
|
|
|
2003-01-20 16:29:06 +01:00
|
|
|
Bundles the Smack class files into a JAR file (smack.jar)
|
|
|
|
|
that is suitable for adding
|
2003-01-17 21:28:53 +01:00
|
|
|
into the classpath of an application server.
|
|
|
|
|
<p>[<a href="#tasks">return to task list</a>]
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--JAVADOC-->
|
|
|
|
|
<p><b><a name="javadoc">javadoc</a></b>
|
|
|
|
|
<ul>
|
|
|
|
|
<i>Syntax:</i><p>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<code>
|
2003-01-17 21:28:53 +01:00
|
|
|
ant javadoc <br>
|
2008-11-03 17:28:57 +01:00
|
|
|
</code>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p><i>Description:</i></p>
|
|
|
|
|
|
2003-01-20 16:29:06 +01:00
|
|
|
JavaDocs all Smack source code in the source directory.
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p>[<a href="#tasks">return to task list</a>]
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<!--CLEAN-->
|
|
|
|
|
<p><b><a name="clean">clean</a></b>
|
|
|
|
|
<ul>
|
|
|
|
|
<i>Syntax:</i><p>
|
|
|
|
|
|
2008-11-03 17:28:57 +01:00
|
|
|
<code>
|
2003-01-17 21:28:53 +01:00
|
|
|
ant clean<br>
|
2008-11-03 17:28:57 +01:00
|
|
|
</code>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p><i>Description:</i></p>
|
|
|
|
|
|
2003-01-20 16:29:06 +01:00
|
|
|
Cleans your Smack distribution directory by deleting compiled class files, the
|
|
|
|
|
smack.jar file and Javadoc files.<p>
|
2003-01-17 21:28:53 +01:00
|
|
|
|
|
|
|
|
<p>[<a href="#tasks">return to task list</a>]
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</body>
|
2008-11-03 17:28:57 +01:00
|
|
|
</html>
|
