Minimalist Online Docmentation

Download

Note: It is recommended that most users download the current development version of MOD (1.1.x). Other than the code for dynamic navigation trees (which are not enabled by default), this branch is quite stable, and much more user-friendly than the stable 1.0.x branch.

The current version is available from the sourceforge projects web page for MOD:

http://sourceforge.net/projects/moddoc/

The tarball also contains the MOD source for this web site.

Distributions are now signed using GnuPG. My public key is available here or from any of the PGP public keyservers.

Install required modules

mod2html requires that you have the perl modules Tree::DAG_Node and Digest::MD5 installed on your system. If you're in a hurry to get started, these should be the only ones you absolutely need to install.

(Optional) Install supporting modules

mod2html does have some useful features that make use of a fair number of non-standard perl modules, so odds are you'll have to download and install at least a couple of them if you really want to get the full benefit of the program. Here are the various extra features and the modules that they require:

File locking: LockFile::Simple. This is highly recommended if you have more than one person potentially using mod2html.

Tar file destinations: Archive::Tar. This module allows you to specify *.tar files as destinations so that they're ready to transfer to another location. Install the Compress::Zlib if you'd also like to create compressed *.tar.gz files.

FTP destinations: Both File::Temp and the libnet module bundle are required if you want to use ftp:// destinations to have mod2html upload the necessary destination files directly to an ftp server.

Limits on memory use: mod2html can use the BerkeleyDB database to store its information if the source files become larger than the threshold specified in the site configuration. To use this feature, you'll need BerkeleyDB and the File::Temp and DB_File modules.

Run install.pl

After untarring the distribution, edit the install.pl script and make sure the variables at the top of the file are set to the correct values for your system. After you're done, su to root, and run the script while you're in the same directory, e.g.

# perl install.pl

This will install the mod2html script, its supporting files, and the man page.

Use it

That's it for site-wide installation and configuration; you're ready to set up a new MOD source directory. Use the tutorial and reference to learn how to get started.