Skip to content

Installation

Jump to bottom
Julio Merino edited this page Feb 4, 2014 · 2 revisions

Introduction

Lutok is a very simple library. As such, getting it to run on your system should be a fairly straightforward process. In the general case, you will want to install Lutok as a shared library and configure dependent programs use it from its installed location. This page provides instructions as to how to do so.

Once you have installed Lutok, make sure to read the provided HTML documentation in /usr/local/share/dox/lutok/index.html or the Examples page.

Binary packages

The preferred mechanism to get Lutok is to use a binary package for your platform if at all available. Unfortunately, because Lutok is a very recent project, the availability of binary packages is reduced.

To our knowledge, the following packages exist:

  • Fedora: There is an RPM package in the repository. Install lutok for the binary library, lutok-devel for the header files and lutok-doc for the HTML documentation.
  • pkgsrc: There is a package in pkgsrc under the pkgsrc/devel/lutok directory. pkgsrc is the NetBSD packages collection, but also runs on other operating systems such as other BSDs and multiple flavors of Linux.

Building from sources

Building Lutok is a fairly straightforward process. This assumes that you use one of the published release files; however, if you want to build the tree from the Subversion repository, you will have to read the full installation notes in the INSTALL document.

The quick recipe to build, say, Lutok 0.4, and install it alongside the rest of your system would involve the following steps:

$ tar xzvf lutok-0.4.tar.gz
$ cd lutok-0.4
$ ./configure
$ make
$ make check
$ sudo make install
$ make installcheck

If any of Doxygen and/or ATF give you trouble during the steps above, try running configure with the --without-atf --without-doxygen flags. You can also choose to install Lutok into a different location than the default (/usr/local) by specifying the desired location with the --prefix flag.

Bundling Lutok into your own project

Due to the nature of Lutok and Lua, you might also be interested in using these components without relying on external installed components (or binary packages). If that is the case, you have the option of bundling a copy of Lutok's source within your project.

I have not attempted to do this, so unfortunately I cannot provide you further details on how to achieve this goal. If you are using GNU Autoconf in your own project, the AC_CONFIG_SUBDIR macro may be of help. Otherwise, you will have to write your own Makefile rules to hook Lutok into your binary, but that should be relatively easy due to the simplicity of Lutok's sources.

Clone this wiki locally