GAMGI Installation: Configuration

Installation Configuration

### Run GAMGI from any directory

If GAMGI was compiled from source and the GAMGI root directory is, for example, /home/carlos/gamgi, then the full path for the executable is /home/carlos/gamgi/gamgi_version/src/gamgi.

To make GAMGI run from any directory, we suggest making first a soft link from gamgi to gamgi_version, in the GAMGI root directory:

    cd /home/carlos/gamgi
    ln -s gamgi_version gamgi

and then a second soft link from /usr/local/bin to the executable, typing as root:

    cd /usr/local/bin
    ln -s /home/carlos/gamgi/gamgi/src/gamgi gamgi

Because /usr/local/bin is one of the standard directories where Unix systems search for executables, GAMGI will be found when called from any directory on the system.

Changing to a new version of GAMGI requires only to change the local link (in /home/carlos/gamgi), while the global link (in /usr/local/bin), that needs root permission, must be done only the first time GAMGI is installed.

### Set the GAMGI_HELP environment variable

To inform GAMGI where the help documentation files are, set the GAMGI_HELP environment variable, pointing to the doc/ directory, where the documentation starts. This can be done by adding a line as this, to the user .bashrc file:

    GAMGI_HELP=/home/carlos/gamgi/gamgi/doc; export GAMGI_HELP

Alternatively, this information can abe given directly in GAMGI, selecting Help->Config, or in a config block in a GAMGI XML file.

### Set the GAMGI_TEXT environment variable

To inform GAMGI where are the Truetype font files, set the GAMGI_TEXT environment variable, pointing to the directory with the files. This can be done by adding a line as this, to the user .bashrc file:

    GAMGI_TEXT=/usr/X11R6/lib/X11/fonts/truetype/; export GAMGI_TEXT

GAMGI comes with all the needed font files, in the directory $GAMGI/gamgi_version/src/io/fonts/, in case they are not available in the system.

### Set the BROWSER environment variable

GAMGI can be configured to automatically launch a browser pointing to the adequate help web page. To inform GAMGI which browser should be launched, set the BROWSER environment variable, pointing to the browser executable. This can be done by adding a line as this, to the user .bashrc file:

    BROWSER=/usr/X11/bin/mozilla; export BROWSER

Alternatively, this data can also be given directly in GAMGI, selecting Help->Config, or in a config block in a GAMGI XML file.

### Install pnmtopng, pnmtojpeg and pnmtotiff

These tools come with every Linux distribution and are usually installed by default. GAMGI uses them to export .png, .jpeg and .tiff files.

### Define automatic default settings

More experienced users, can define their own default settings in a XML file and load it automatically everytime GAMGI is called. This can be done, just adding a line as this, to the user .bashrc file:

    alias gamgi='gamgi my_defaults.xml'

This works even if other files are called. For example, calling:

    gamgi my_objects.xml

would be understood as:

    gamgi my_defaults.xml my_objects.xml

and defaults in my_defaults.xml would be already applied to objects in my_objects.xml.

### Install the man page

Go to directory doc/man/ in GAMGI documentation, compress the man page and copy it to the system man1 directory, with the name gamgi.1.gz:

    cd /home/carlos/gamgi/gamgi/doc/man
    gzip page
    cp page.gz /usr/share/man/man1/gamgi.1.gz

### Get quick access to the files

For developers, who need to have quick access to the code, we suggest creating a few alias in .bashrc to permit easy navigation through the GAMGI directories, for example:

    alias sgi='cd /home/carlos/gamgi/gamgi/src'

These alias remain the same when a new GAMGI version is installed, if the second symlink described above was made.
Home