Gamma README
Copyright (C) 2002, 2004, 2007, 2010 Sergey Poznyakoff
See end of file for copying conditions

* Introduction

This file contains brief information about configuring, testing
and running Gamma. It is provided as a brief reference only.
More specifically, is *not* intended as a replacement for the
documentation. The complete documentation for Gamma is available
in the doc/ subdirectory. To read it without installing the package
run `info -f doc/gamma.info'. After the package is installed
the documentation can be accessed running `info gamma'. 

An online copy of the documentation in various formats is available
at http://gamma.man.gnu.org.ua.

* Overview

Gamma is a set of assorted modules for Guile. It includes:

** (gamma sql)

This module provides interfaces for two SQL DBMS: MySQL and PostgreSQL.

** (gamma expat)

Interfaces to Expat: a library for parsing XML documents.

** (gamma syslog)

Interfaces to syslog(2).

* Uses

Gamma is the main working horse for xmltools[1], a parser engine
powering Ellinika[2] and Runasimi[3] web projects.

For more info on these, see:

[1] http://puszcza.gnu.org.ua/projects/xmltools/
[2] http://ellinika.gnu.org.ua
[3] http://www.runasimi.org

* Installation

For generic instructions on how to use configure, see the INSTALL file
in this directory. The following is a list of Gamma-specific options:

** --disable-expat

Disables building of the expat module

** --disable-sql

Disables building of the sql module

** --disable-syslog

Disables building of the syslog module

** --without-mysql

Configure to work without MySQL

** --without-postgres

Configure to work without Postgres

** --with-guiledir=DIR

Specify the directory where to install guile modules.

The algorithm for determining where to install Guile modules is:

1. If --with-guiledir=DIR is specified, use DIR
2. Otherwise, obtain the site-wide Guile modules directory by
running `guile-config info pkgdatadir' and install the files
there *if* this directory lies inside the current install prefix
or --with-guiledir (without argument) is given.
3. Otherwise use $(datadir)/guile/site

** --with-include-path=PATH

Specify additional directories where to look for C include files. PATH is
a list of directory names separated by colons. Running

  ./configure --with-include-path=/usr/mysql/include:/usr/pgsql/include

is equivalent to running

  ./configure CPPFLAGS="-I/usr/mysql/include -I/usr/pgsql/include"


** --with-lib-path=PATH

Specify additional directories where to look for libraries. PATH is a list of
directory names separated by colons. Running

  ./configure --with-lib-path=/usr/mysql/lib:/usr/pgsql/lib

is equivalent to running

  ./configure LDFLAGS="-L/usr/mysql/lib -L/usr/pgsql/lib"

* Bug reporting.		

Send bug reports to <gray+gamma@gnu.org.ua>. 


* Copyright information:

Copyright (C) 2002, 2004, 2007, 2010 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.
  

Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End: