INSTALLATION INSTRUCTIONS FOR OPENVAS-LIBRARIES
===============================================

Please note: The reference system used by most of the developers is Debian
GNU/Linux 'Lenny' 5.0.  The build might fail on any other systems.  Also
it is necessary to install dependent development packages.

Compiling openvas-libraries
---------------------------

Prerequisites:
* libglib >= 2.12
* libgnutls >= 2.0
* libpcap
* libgpgme >= 1.1.2
* uuid-dev (from e2fsprogs)

Apart from these, some tools are required:
* a C compiler (e.g. gcc)
* bison
* flex
* cmake
* pkg-config

Prerequisites for building documentation:
* Doxygen
* xmltoman (optional, for building man page)
* sqlfairy (optional, for producing database diagram)

Recommended to have WMI support:
* wmiclient library (see doc/wmi-howto.txt)

If you have installed required libraries to a non-standard location, remember to
set the PKG_CONFIG_PATH environment variable to the location of you pkg-config
files before configuring:

    $ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/your/location/lib/pkgconfig

Configure the build with

    $ cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/installation .

or (if you want to use the default installation path /usr/local)

    $ cmake .

This only needs to be done once.

Thereafter, the following commands are useful.

    $ make                # build the scanner
    $ make doc            # build the documentation
    $ make doc-full       # build more developer-oriented documentation
    $ make install        # install the build
    $ make rebuild_cache  # rebuild the make system cache


$ make install

Please note that you may have to execute this command as root, especially if you
have specified a prefix for which your user does not have full permissions.

Configuration Options
---------------------

During compilation, the build process uses a set of compiler options which
enable very strict error checking and ask the compiler to abort should it detect
any errors in the code. This is to ensure a maximum of code quality and
security.

Unfortunately, some (especially newer) compiler can be more strict than others
when it comes to error checking. While this is a good thing and the OpenVAS
developers aim to address all compiler warnings, it may lead the build process
to abort on your system. Below you will find a list of the most common warnings
and what you can do about them.

* "call to function ‘xyz’ without a real prototype"

This warning shows up on recent openSUSE versions due to a compiler option only
present on these systems. To tell the build process to not abort the build
process on this warning, add -DIGNORE_UNPROTOTYPED_CALLS=1 to your configuration
command, for example:

    $ cmake -DIGNORE_UNPROTOTYPED_CALLS=1 .

Should you notice any other error messages causing your build process to abort,
do not hesitate to contact the OpenVAS developers using the mailing lists or IRC
chat. Don't forget to include the name and version of your system and
distribution in your message.