--- /dev/null
+[[TableOfContents()]]\r
+\r
+= Prerequisites =\r
+\r
+== Compilers ==\r
+\r
+To compile the standalone DomTool tools, you will need the [http://mlton.org/ MLton] [http://www.standardml.org/ Standard ML] compiler. It's available as Debian package "mlton". The version in Debian testing works fine, but the stable version is too old, so grab the Debian stable version of the latest release from [http://mlton.org/Download the MLton download page].\r
+\r
+To use DomTool from an interactive SML REPL session, you will need a recent version of [http://www.smlnj.org/ Standard ML of New Jersey]. The SML/NJ packages in non-experimental Debian are so old that I don't bother using them, opting to install SML/NJ manually 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.\r
+\r
+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.\r
+\r
+== Libraries ==\r
+\r
+You will need the OpenSSL C library with development files, available in Debian package "libssl-dev".\r
+\r
+== Utilities ==\r
+\r
+If you plan to run a server (dispatcher or slave), you'll need rsync, which is available in Debian package "rsync".\r
+\r
+= Getting the source code =\r
+\r
+You can obtain the approximately-latest version of the DomTool source code from [http://sourceforge.net/cvs/?group_id=99567 SourceForge anonymous CVS]. The module name is `domtool2`. I write "approximately" because it can take about a day for the latest changes to propagate from developer CVS to anonymous CVS. I'll duplicate the directions from that Source``Forge help page and tell you that you can check out this module by running:\r
+{{{cvs -d:pserver:anonymous@hcoop.cvs.sourceforge.net:/cvsroot/hcoop login\r
+cvs -z3 -d:pserver:anonymous@hcoop.cvs.sourceforge.net:/cvsroot/hcoop co -P domtool2}}}\r
+\r
+Just press enter when prompted for a password.\r
+\r
+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 from developer CVS, like so:\r
+{{{export CVS_RSH=ssh \r
+cvs -z3 -d:ext:developername@hcoop.cvs.sourceforge.net:/cvsroot/hcoop co -P domtool2}}}\r
+\r
+= Building the standalone tools =\r
+\r
+First, in the `domtool2` directory that you have checked out, create a file `config.sml` containing:\r
+{{{structure Config :> CONFIG = struct\r
+ open ConfigDefault\r
+end}}}\r
+\r
+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.\r
+\r
+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.\r
+\r
+Once you have that done, the rest is easy! Just run{{{\r
+make}}}\r
+\r
+This will populate `domtool2/bin/` with the compiled DomTool programs. As root, run{{{\r
+make install}}}\r
+\r
+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.\r
+\r
+== Reinstalling the standalone tools ==\r
+\r
+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.\r
+\r
+First, create a {{{config.sml}}} file as directed above, and run {{{make}}}.\r
+\r
+If the current machine is a slave, then run {{{\r
+make install_slave}}}\r
+\r
+If the current machine is a server, then run {{{\r
+make install_server}}}\r
+\r
+= Building for SML/NJ =\r
+\r
+After following the same procedure as above for `config.sml`, run{{{\r
+make smlnj}}}\r
+\r
+followed by{{{\r
+make install}}}\r
+\r
+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.\r
HCoop / hcoop / zz_old / ikiwiki / blobdiff