--- projects/cms/source/server/README 2001/01/07 21:28:06 1.6 +++ projects/cms/source/server/README 2002/06/07 16:12:47 1.11 @@ -1,6 +1,27 @@ i-scream Server README ====================== +ANT build vs Make build +----------------------- + +** We have revamped the Makefile, but not the ANT build ** +** So please use the Makefile for now ** + +There are now two methods of compiling the server distribution. The existing +Makefile method is still supported, but is of course limited in the OS's on +which it can be run. The preffered method will be an XML based build script +using ANT (http://jakarta.apache.org/ant) which will run on any platform. +However, at this stage the ANT scripts are not completely finished and may +have some odd behaviour. + +We envisage both the Makefile and ANT setups being maintained for some time, +giving the developer a choice. This document still outlines the Makefile +method of compiling, and will do so until such a point as the ANT scripts +are deemed reliable. If, however, you wish to give the ant script a whirl, +try the following after setting up ANT (see the ANT website for details); + +ant help + Compiling --------- @@ -35,6 +56,7 @@ DBInterface FilterManager RootFilter FilterMain +Client It is not necessary to start both the ClientInterfaceMain and DBInterface, the server will handle only one or both. Multiple Filter's can be started @@ -75,13 +97,32 @@ install Installs the server to a given directory. Also takes a prefix; make install prefix = /usr/i-scream -cvsbuild +dist + Builds a full distribution of the server. + make dist ver = 1.0 + Default ver is HEAD. - Builds any tagged version of the server from CVS. This saves the need to - checkout a version to build it, as it's all done automatically; - make install rev = RELEASE_1 - Default tag is HEAD. +dist-bin + Builds a binary distribution of the server. + make dist ver = 1.0 + Default ver is HEAD. javadoc Builds all the javadoc pages in the `doc' directory. + +buildutil + + (it is recommended you run a "make clean" first) + Builds a seperate JAR file, in `build' called `iscream-util.jar'. + This file contains just the uk.ac.ukc.iscream.util package for + use in other parts of the system, such as the clients. + +createtable + + Creates the ipacket table in the mySQL database. This is required for + the database side of the server. + +droptable + + Drops an ipacket table from the mySQL database if one exists.