Detailed documentation

After installation, make sure to run "ant -f bootstrap.xml xdoc" in the antmod directory.
Result: in the "build/xdocs" directory you will find all documentation you want for Antmod.


You need to make sure you meet the following prerequisites before starting with this quick start guide:

  • JDK 1.4.2+
    Make sure that ${JAVA_HOME}/bin is in your PATH environment variable.
  • Ant 1.6.1+
    Make sure that ${ANT_HOME}/bin is in your PATH environment variable.
  • CVS or Subversion command-line client
    Make sure that the directory containing cvs or svn is in your PATH environment variable.
  • Access to a repository
    Make sure you have access to a CVS or Subversion repository. When using CVS, make sure that you have the CVSROOT environment variable set. You can also work with a repository on your local machine (see "creating a CVS repository" or "Subversion repository creation").

Setting up Antmod

  1. Unpack the downloaded install archive in a directory of your choice. This will create a subdirectory named antmod-VERSION, where VERSION is the version you downloaded (for example 1.1-rc1).

  2. Set the ANTMOD_HOME environment variable to the directory where you just unpacked the install archive. Add ${ANTMOD_HOME}/bin to your PATH environment variable.

  3. Create a ".antmodrc" file in your home directory (on Windows usually %HOMEPATH%), containing:
  4.     # the directory where you want each release to be checked out by Antmod

    # define a repos called "default"
    # CVS examples: scm:cvs:pserver:user:password@host:/cvs/root
    # Subversion example: scm:svn:,

Setting up the repository

If the default repository has not been used with Antmod before, it needs to be setup first. This means that you need to create a "releases" and a "javalib" module in it.

Doing this is very easy: run "antmod setuprepos" and it will interactively guide you through the process and create the "releases" and "javalib" modules in CVS or Subversion.