Installation

Note:

The manual covers only installation from source.

peekabot is divided into two distinct parts: the server and the client API. Both are built by default but you can disable building of either of them by configuring with --disable-server or --disable-client-lib. Building the client only requires less dependencies.

Before starting the installation, make sure your system has all the dependencies listed below installed:

• Boost 1.34.0+
  • Boost.Thread
  • Boost.DateTime
  • Boost.Filesystem*
  • Boost.ProgramOptions*
  • (Boost.Test**)
• Xerces-C++ 2.7.0+*
• FLTK 1.1.6+*
• OpenGL*
• GLU*
• libpng*

* Not required when building only the client API. ** Only needed if building the unit tests (disabled by default).

All set and ready to continue? Good.

peekabot leverages GNU Autoconf and friends for building - if you've ever used open source software on a unix you're probably already familiar with them. The usual ./configure, make, make install-ritual usually does the trick:

$ tar xvzpf peekabot-x.y.z.tar.gz 
$ cd peekabot-x.y.z
$ ./configure --prefix=/usr
$ make
# run as root:
$ make install 

Mac OS X users also have to issue the following command for the installed executable:

$ /Developer/Tools/Rez Carbon.r -o /path/to/peekabot 

If everything went according to plan, you should be able to start the peekabot server by typing peekabot in your terminal.

Note:

If you want to build the included examples, configure with the --enable-examples flag.

If configuring fails, ./configure --help lists options that you might be able to use to solve your problem.

Continue to the tutorial...