Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 1.74 KB

INSTALL.md

File metadata and controls

67 lines (44 loc) · 1.74 KB

Building via cmake

The vcontrold package depends on libxml2.

For the build process on *nix machines, usually the libxml2-dev package is needed. To get the documentation converted from Restructured Text (similar to Markdown) to the format used by man, the rst2man utility has to be installed.

The package can be built with the normal cmake procedure. Simply execute the following steps in your source directory:

mkdir build
cd build
cmake ..
make

Build options

There are three options for the build process with their defaults:

  • MANPAGES=ON Build man pages via rst2man
  • VCLIENT=ON Build the vclient helper program (for communication with vcontrold)
  • VSIM=OFF Build the vsim helper program (for development and testing purposes)

The installation path can be altered by

  • CMAKE_INSTALL_PREFIX=/usr/local This directory is prepended onto all install directories. This variable defaults to /usr on UNIX and c:/Program Files on Windows

Invocation is e.g. as follows:

cmake -DVSIM=ON -DMANPAGES=OFF -DCMAKE_INSTALL_PREFIX=/usr/local ..

A common approach for a minimal installation (without manpages) would be:

cmake -DMANPAGES=OFF ..

Installation

To install the package, execute as root:

make install

or, on systems that use this logic (e.g. Debian, Ubuntu etc.), use sudo:

sudo make install

The whole installation can be relocated to a different directory by supplying a DESTDIR variable:

make DESTDIR=<DESTDIR> install

or

sudo make DESTDIR=<DESTDIR> install

respectively. In this case, the entire package will be installed in a directory with the installation prefix prepended with the DESTDIR value, which finally gives <DESTDIR>/<CMAKE_INSTALL_PREFIX>.