Installation instructions

By Julio Merino, The NetBSD Foundation

Contents

  1. Introduction

  2. Dependencies

  3. Regenerating the build system

  4. General build procedure

  5. Configuration flags

  6. Post-installation steps

Introduction

ATF uses the GNU Automake, GNU Autoconf and GNU Libtool utilities as its build system. These are used only when compiling the application from the source code package. If you want to install ATF from a binary package, you do not need to read this document.

For the impatient:

$ ./configure
$ make
Gain root privileges
# make install
Drop root privileges
$ make installcheck

Or alternatively, install as a regular user into your home directory:

$ ./configure --prefix ~/local
$ make
$ make install
$ make installcheck

Dependencies

To build and use ATF successfully you need:

If you are building ATF from the code on the repository, you will also need the following tools. The versions listed here are the ones used to build the files bundled in the last formal release, but these are not strictly required. Newer ones will most likely work and, maybe, some slightly older ones:

If you are building the XML documentation (which is a requisite to be able to generate a distfile), you will also need the following tools:

Regenerating the build system

If you are building ATF from code extracted from the repository, you must first regenerate the files used by the build system. You will also need to do this if you modify one of configure.ac or Makefile.am.m4. To do this, simply run:

$ ./autogen.sh

For formal releases, no extra steps are needed.

General build procedure

To build and install the source package, you must follow these steps:

  1. Configure the sources to adapt to your operating system. This is done using the 'configure' script located on the sources' top directory, and it is usually invoked without arguments unless you want to change the installation prefix. More details on this procedure are given on a later section.

  2. Build the sources to generate the binaries and scripts. Simply run 'make' on the sources' top directory after configuring them. No problems should arise.

  3. Install the program by running 'make install'. You may need to become root to issue this step.

  4. Issue any manual installation steps that may be required. These are described later in their own section.

  5. Check that the installed programs work by running 'make installcheck'. You do not need to be root to do this, even though some checks will not be run otherwise.

Configuration flags

The most common, standard flags given to 'configure' are:

The following environment variables are specific to ATF's 'configure' script:

The following flags are specific to ATF's 'configure' script:

Post-installation steps

After installing ATF, you have to register the DTDs it provides into the system-wide XML catalog. See the comments at the top of the files in ${datadir}/share/xml/atf to see the correct public identifiers. This directory will typically be /usr/local/share/xml/atf or /usr/share/xml/atf. Failure to do so will lead to further errors when processing the XML files generated by atf-report.