OpenCCM - Utils Module Install Guide

Utils Module Install Guide

This module is a repository for various tools provided as externals libraries, and also provides ObjectWeb utilitary frameworks developped within the OpenCCM project.

The Utils module and all dependencies can be checked out by using the alias utils. Note that ALL modules of the OpenCCM repository need this utils module to work properly. Nobody should only need the utils module, apart from developers willing to use the tools it provides.

Contents Structure

The Utils module contains the following directories and files :

Directory	File	Description
	.classpath	Eclipse configuration file defining the classpath to use.
	.cvsignore	CVS configuration file defining the resources ignored by CVS.
	.project	Eclipse configuration file defining the properties of the project.
	export.xml	Ant build file that can be used by others modules.
ant/		The Ant tool configuration directory.
	build.license	License to be used in every file.
	build.properties	Common definitions of Ant properties.
cmdline/		The command line framework.
	.cvsignore	CVS configuration file defining the resources ignored by CVS.
	build.xml	Ant build file for the compilation process.
	src/	The utils commandline module source code directory.
cpp/		The C Preprocessor framework.
	.cvsignore	CVS configuration file defining the resources ignored by CVS.
	build.xml	Ant build file for the compilation process.
	src/	The utils C Preprocessor module source code directory.
externals/		Common externals tools and libraries.
	build.xml	Ant build file for the compilation process.
	export.xml	Ant build file for the importing local Ant tasks.
	ant/	Ant libraries.
	antcontrib/	Apache additional ant tasks library.
	apollon/	The Apollon tool libraries.
	fractal/	The Fractal libraries.
	jidlscript/	The JIDLScript library.
	jregex/	The Jregex library.
	junit/	The JUnit library.
	monolog/	ObjectWeb logging library.
	objectweb/	The ObjectWeb ANT tasks library.
	web/	Duplication of the WEB module builders to build each modules doc locally.
	winprocess/	Windows utilities commands.
	xerces/	Apache XML parsing library.
	zeus/	Enhydra DTD interpretor and XML parser generator tool.
misc/		The Miscellaneous framework.
	.cvsignore	CVS configuration file defining the resources ignored by CVS.
	build.xml	Ant build file for the compilation process.
	src/	The utils Miscellaneous module source code directory.
web/		Source files for this documentation.
winprocess/		Windows utilities commands sources.
	ProcessManagement.dsw	Microsoft Developer Studio Workspace File.
	exec/	The exec command sources.
	kill/	The kill command sources.
	ps/	The ps command sources.

Compilation Instructions

To compile the command line framework, execute the following command:

$ cd cmdline/
$ ant

To compile the C preprocessor framework, execute the following command:

$ cd cpp/
$ ant

To compile the launcher tool, execute the following command:

$ cd launcher/
$ ant

To compile the miscellaneous framework, execute the following command :

$ cd misc/
$ ant

Compilation Result

After compilation, the following directories and files are created in build/ directory:

Director	File	Description
bin/		commands directory.
	*.bat	Windows commands.
	*.sh	Unix commands.
class/		Java class directory.
	org/objectweb/util/*/.class	Java classes compiled.
	*.monolog	Monolog configuration files.
externals/		External tools and libraries used only during the compilation process.
	/.jar	Libraries used by Ant.
jar/		Temporary libraries.
	*.jar	Libraries generated by other modules.
	/.jar	External libraries imported by other modules.
java/		Generated Java source files.
	*/.java	Java files generated by the compilation process.
lib/		Final libraries.
	*.jar	Libraries generated by the current module.
	/.jar	External libraries.