1. Installation

1.1. Unpack Distribution

Unzip pushlet-x.y.z.zip or tar xzvf pushlet-x.y.z-tar.gz.

1.2. Directories

The unpacked distribution should contain the following directories:

                    /client additional (non-J2SE) clients
                    /src all Java sources
                    /webapps pushlet.war file with the examples; also unpacked in the pushlet subdir
                    /doc all documentation
                    /lib the pushlet.jar and pushletclient.jar libraries
                    /thirdparty external libraries

From here on file names starting with "/" are referred from the top of the install dir.

1.3. Getting from CVS

If you want to check out the current version from CVS, follow the instructions on http://sourceforge.net/cvs/?group_id=62939. Anonynmous CVS checkout can be done as follows:

                    cvs -d:pserver:anonymous@pushlets.cvs.sourceforge.net:/cvsroot/pushlets login

                    cvs -z3 -d:pserver:anonymous@pushlets.cvs.sourceforge.net:/cvsroot/pushlets co pushlets

1.4. Rebuilding

Assuming you have Ant installed, you can rebuild the .jars and .war in this distribution by typing ant in the toplevel directory. /build.xml is the Ant build file for all jars and wars.

If you want to rebuild an entire distribution from CVS which includes documentation, you need to use the build file/build-dist.xml. Pass this build file to ant as follows:ant -f build-dist.xml. If you don't care about building the documentation you may as well use /build.xml with the CVS version.

There is one nasty issue which makes the XBook documentation generation fail (NullPointerException or ArrayOutOfBoundsException) in some cases when building the distribution (using /build-dist.xml) from CVS. This has to do with xalan.jar in your CLASSPATH, either in the Ant lib dir or in J2SE 1.4 runtime. xalan.jar is also present in xbookaux.jar but must be in the same classloader as xbook.jar. I resolved this by putting both xbook jars (under /thirdparty/justobjects/xbook) in the Ant lib dir (and removing xalan.jar).