1.2 Tools Required

To build and work with the documentation toolset, you will need to install some additional tools, all of which are open source software. The exact list of tools required will depend on what you plan to do with the DocBook sources.

  • A text editor capable of handling plain text files. We use a variety of editors, for example oXygen (a commercial product), vi, kate, jEdit, or Notepad++.

  • make: You will need a standard make tool, either the one provided with your operating system, or preferably GNU make. On Windows, this might require you to install Cygwin or a similar Unix emulator that has make support.

  • XML tools: The XML toolkit from http://xmlsoft.org provides a number of utilities that are required to work with the DocBook XML, including xmllint and xsltproc. You may find that your operating system already comes with the XML tools installed.

  • Perl: Required for some of the additional tools we use to support the production process. In addition to Perl itself, you will also need to install the Expat library, and the XML::Parser::PerlSAX, IO::String, and IO::File modules.

If you want to build PDF versions of documentation, you need to install a suitable Java Runtime (v1.5 or better) and the Apache FOP tool (version 1.0 or better, http://xmlgraphics.apache.org/fop/).

When installing FOP under Unix/Linux/OS X, install the package into a directory and then create a link to the fop.sh command as fop, for example:

shell> ln -s /usr/local/fop-1.1/bin/fop.sh /usr/local/bin/fop

You may also need to increase the amount of memory allocated to FOP when building the full reference manual. You can do this by adding the -Xmx##m command-line option to the final line of the fop.sh or fop.bat script:

shell> JAVACMD -Xmx2048m -classpath "$LOCALCLASSPATH" $FOP_OPTS org.apache.fop.apps.Fop "$@"