welcome: please sign in

DomTool / Building

1. Prerequisites

1.1. Compilers

To compile the standalone DomTool tools, you will need the MLton Standard ML compiler. It's available as Debian package "mlton", and versions in Debian releases starting with lenny are new enough to use from main.

To use DomTool from an interactive SML REPL session, you will need a recent version of Standard ML of New Jersey. The SML/NJ packages in Debian Squeeze are acceptably modern to compile domtool, but for older releases you must install SML/NJ manually by following the directions on the SML/NJ web site. Chances are you can get by just fine without support for interactive REPL use and can skip installing SML/NJ if you don't want it for some other purpose.

Why am I referencing two different compilers here? Well, developing with SML/NJ and building release binaries with MLton is standard practice in the SML world. SML/NJ supports separate compilation and interactive use, which are very helpful during development. MLton is a whole-program optimizing compiler that produces extremely efficient binaries, at the cost of much greater compile-time time and memory usage than SML/NJ.

1.2. Libraries

You will need the OpenSSL C library with development files, available in Debian package "libssl-dev", and PCRE development files in package "libpcre3-dev".

1.3. Utilities

If you plan to run a server (dispatcher or slave), you'll need rsync, which is available in Debian package "rsync".

2. Getting the source code

You can obtain the approximately-latest version of the DomTool source code from HCoop Anonymous Git. To clone simply execute:

git clone git://git.hcoop.net/git/hcoop/domtool2.git

If you have been granted write permission to the repository and plan to commit code changes, then you'll want to check the repo out either via ssh or openafs using an account with credentials to write to the domtool git directory.

git clone ssh://USER@ssh.hcoop.net/afs/hcoop.net/user/h/hc/hcoop/.hcoop-git/domtool2.git
git clone /afs/hcoop.net/user/h/hc/hcoop/.hcoop-git/domtool2.git

3. Building the standalone tools

First, in the domtool2 directory that you have checked out, create a file config.sml containing:

structure Config :> CONFIG = struct
  open ConfigDefault

Heck, you could even go ahead and set some non-standard configuration values! If you leave it as is, you inherit the defaults, which should be appropriate for HCoop servers.

Even if you set configuration parameters until you're blue in the face, this stuff probably won't work very well in environments that don't look much like Linux. Perhaps some day greater portability will become enough of a priority for us to fix that.

Once you have that done, the rest is easy! Just run


This will populate domtool2/bin/ with the compiled DomTool programs. As root, run

make install

to copy these programs and some additional scripts to appropriate standard locations. Consult the Makefile if you'd like to see what those locations are ahead of time.

3.1. Reinstalling the standalone tools

If you want to reinstall domtool on machines that are running it already, then it is best to use a slightly modified set of instructions.

First, create a config.sml file as directed above, and run make.

If the current machine is a slave, then run

make install_slave

If the current machine is a server, then run

make install_server

4. Building for SML/NJ

After following the same procedure as above for config.sml, run

make smlnj

followed by

make install

as root. Now you should be able to run sml in the base domtool2 directory and run CM.make "src/domtool.cm";. If you don't see any error messages, then the DomTool modules are loaded and you can start poking them. For instance, running open Main; should print information on the primary entry-points.

You may need to manually apt-get install these Debian packages: ml-nlffigen, libmlnlffi-smlnj, ml-yacc

DomTool/Building (last edited 2010-12-05 20:21:14 by ClintonEbadi)