Anubis

h1. BuildAnubisFromSources

{{>toc}}

h1. Introduction

Motivation of using CMake instead of popular Automake+Autoconf build system lies on being able to achieve many build tasks better. Here are the main benefits:

    * cross-platform: works well on Linux (and other UNIXes), Mac OS X and Windows

    * simpler syntax, easier to learn

    * faster build times

    * nice build output with progress and colors ;-) 

Autotools have the advantage that they're far more widespread and users know very well the usual ./configure && make && make install installation. This page tries to introduce CMake system to Anubis users that want build Anubis from source. It doesn't go much to details so if you're interested in further knowledge, seek for more information on home page: http://www.cmake.org/

h1. CMake installation

To install CMake, download it from http://www.cmake.org/HTML/Download.html for your platform or use your distribution's packages. Building CMake from source shouldn't be a problem, the only dependency is a C++ compiler.

Note: Use CMake version 2.6.2 or later!

h1. Simple build

To start configuration and generation of makefiles, go to source directory and run:

<pre>

cmake .

make

make install

</pre>

The dot means that it should use current directory as a root of the build. If configuration will end without errors CMake will also generate makefiles, otherwise it will show some errors. The problems usually lie in not being able to set some variables automatically - in that case you can specify them manually.

h1. Out-of-source build

This build option is good especially for developers as it allows building several different configurations with the same sources. E.g. you can build either debug / release version, use dynamic / static linking and more options. To use out-of-source build just create a directory where it will get built - nothing complicated:

<pre>

 mkdir build

 cd build

 cmake ..

 make

 make install

</pre>

Another benefit is that it's easy to delete the whole build just by deleting its directory.

h1. Configuration

All configuration settings are variables. You can set them manually in two different ways:

* specifying on command line:

    <pre>cmake -D VAR1=VALUE1 -D VAR2=VALUE2 ...</pre>

* using an interactive tool

** Windows: cmakesetup - tool providing a dialog for configuration

** UNIX/Mac OS: ccmake - ncurses based configuration tool You need to specify path for these tools what build do you want to configure 

h1. Important variables

There are several variables that you might want to set:

|*Variable*|*Default value*|*Meaning*|

|CMAKE_INSTALL_PREFIX|/usr/local|prefix where to install application and its data|

|CMAKE_BUILD_TYPE| |whether to compile with debugging support or not (values Release or Debug)|

|CMAKE_SKIP_RPATH *|OFF|turning this ON will save you some compile time as relinking during 'make install' won't happen|

Anubis specific variables:

|*Variable*|*Default value*|*Meaning*|

|BISON| |Full path for 'bison' command line|

|FLEX| |Full path for 'flex' command line|

|M4_PATH| |Full path for 'm4' command line|

Variables marked with * are advanced - this means that they're not shown by default in CMake GUI (ccmake or cmakesetup), however it's possible to show them.

Also if you have your libraries in non-standard locations you'll probably will need to specify their include directory and library file.

h1. Platform specific notes

h2. Unix notes

If you have all dependencies in standard paths (/usr or /usr/local), configuration should be done without any problems.

It should be possible to generate KDevelop3 project files with "KDevelop3" generator.

h2. Windows notes

Currently officially supported C/C++ compiler is Visual C++ version 6. Library dependencies (OpenSSL and libjpeg) are already compiled for this compiler into 'third_dev' folder.

h2. Mac OS X notes

Mac OS X is not yet supported.

h1. Troubleshooting

In case that something goes wrong and build fails, it's useful to see the actual commands being run by 'make' to find out what's wrong. This is how to do it:

make VERBOSE=1

h1. Links

This sections lists some additional materials about CMake:

* Cross-Platform Software Development Using CMake - introduction how to create a build system for an application with CMake