About this Guide

This guide is intended to explain how to install the mouseTrap code found in the subversion repository.

Dependencies

The mousetrap direct dependencies are:

Package	Version	Description
gtk2	>= 2.12	The GTK+ Toolkit
pygtk	>= 2.8.4	GTK+ Python bindings
python	>= 2.4	Python platform
opencv	>= 0.9.9	Open Computer Vision Library
pyorbit	>= 2.14.0	Python bindings for ORBit2
python-xlib	>= 0.13	Python Xlib library
python-pyspi	>= 0.6	Python AT-SPI bindings
doxygen	>= 1.5	A documentation system for C++, C, Java, IDL and PHP (this package is required for building the documentation)

NOTE: Each dependency may require other dependencies to be installed.

Getting the code

The code can be obtained checking out the subversion repository:

svn checkout http://svn.flaper87.org/mousetrap mouseTrap

Installation

$ cd mouseTrap/trunk

$ ./autogen.sh

$ make

And as root:

# make install

It is possible to modify the installation path using --prefix=/non/standard/path.

Configuration

There's not a first run configuration wizard nor a text console based one, yet. To configure mouseTrap it is necessary to execute mouseTrap so it can create the configuration file automatically.

$ mouseTrap

This will set the standard configurations for mouseTrap (.mouseTrap/userSettings.py) which are:

# -*- coding: utf-8 -*-
# Este es el archivo de configuración del usuario
# Por Favor Intentar no editar este archivo manualmente
# Usar la ventana de configuración de mouseTrap. 

#flipImage
flipImage = False

#showCapture
showCapture = True

#stepSpeed
stepSpeed = 5

#showPointMapper
showPointMapper = True

#startCam
startCam = True

#reqMovement
reqMovement = 10

#mouseMode
mouseMode = 'screen|none'

#inputDevIndex
inputDevIndex = 0

#debugLevel
debugLevel = 1000

#defClick
defClick = 'b1c'

#showMainGui
showMainGui = True

NOTE: The wizard is being developed when it is ready this section will be deleted.

Documentation

Developers

To enable the compilation for the developers documentation it is necessary to use this 2 flags --enable-pydoc --enable-doxygen in the ./autogen.sh.

The developer's documentation is available using using pydoc or doxygen.

Final Users

To generate the final users documentation it is necessary to set this flag --enable-docbook in the ./autogen.sh command. After running make there will be some .html files in the docs/docbook/ folder, open the index.html to see the main page.