Installing curn

Building curn

Preparation

Obtain Third-party Software

Before building curn, you'll need:

Jakarta Ant, version 1.6.5 or better, available at http://ant.apache.org/
The clapper.org utility library, available at http://www.clapper.org/software/java/util/
The prerequisite jar files for the clapper.org utility library.
The Jakarta Commons Logging API, available at http://jakarta.apache.org/commons/logging/.
The Java Mail API (available at http://java.sun.com/products/javamail/) and the Java Beans Activation Framework (available at http://java.sun.com/products/javabeans/jaf/index.jsp).
A SAX2 XML parser library. Apache Xerces (http://xerces.apache.org/) is a good choice.
The Jakarta Bean Scripting Framework (BSF) jar file, bsf.jar, available at http://jakarta.apache.org/bsf/.
The izpack-compiler.jar file from the IzPack distribution (available at http://izforge.com/izpack/). This is only necessary if you're going to build the graphical installer.

The easiest way to get everything except IzPack and Ant is to install curn via the graphical installer. Be sure to install the source, too.

Prepare the Build Environment

Once you've downloaded the various third-party jar files, place them in a directory somewhere.
Unpack the source zip file, and change your working directory to the resulting curn directory.
In the topmost source directory (i.e., the directory containing the build.xml file), create a file called build.properties containing the following line:
```
third.party.jar.dir: /path/to/directory/containing/jars
```

Building

Type ant build to compile the code and create the jar file. The jar file ends up in the build/lib subdirectory.
To create the Javadocs, type ant javadocs. (This step is optional.)
To create version-stamped release files, type ant release. The resulting files end up in the build/release directory.
To create the installer, type ant release installer. The installer jar file will end up in the

Optional Components

RSS Parsers

curn uses the ROME RSS parser by default; however, it has support for integrating other RSS parsers. See the curn User's Guide for details on using other RSS parsers at run-time.

Email Support

curn can email its output, in addition to saving it to a file. This is especially useful when multiple output handlers are used. In that case, the output of each handler is attached to the email message as a "multipart/alternative" attachment.

However, email support is built only if the clapper.org utility library's email classes are present (and those classes work only when the Java Mail API and the JavaBeans Activation Framework are present).

See the documentation for the (separate) clapper.org utility library for details.

For convenience, the third-party jar directory on this web server has snapshots of the various third-party jar files necessary to build curn.

FreeBSD users will find ports for many of the third-party libraries. Linux users may find packages (RPMs, etc.) for those libraries, as well (depending on the Linux distribution).

Copyright

License

This software is released under a BSD license.

Links

Related Links