BUSH (Business Shell) Installation

This file contains instructions for building and installing BUSH.
General information about BUSH can be found in the BUSH User Guide.


SHORT VERSION

Installing the Binary Version

   1. gmake install

Building from Sources

   1. configure
   2. gmake
   3. gmake test (optional)
   4. gmake install (as root user)


LONG VERSION

The primary test plaform for BUSH is Intel/Linux.  There is also some support
for FreeBSD and HP-UX although this may be obsolete and not thoroughly tested.
Information on porting BUSH to other platforms can be found in the BUSH User
Guide: BUSH should port to a modern Unix-compatible platform within a few
hours.


REQUIREMENTS

The following software packages are required for BUSH:

  * GNU make is required; other make programs may not work.  GNU make is often
    installed under the name "gmake" and the BUSH makefile assumes this is the
    name of your software building program.

  * GCC is required; BUSH is written in Ada and C, both of which are available
    with GCC 3.x.  If you are running GCC 2.x, use add-on Ada compiler GNAT
    3.15.  Most modern Linux distributions, including Red Hat,  have GCC 3.x
    with Ada and C support active.

  * gzip is needed to unpack the source code in the first place.  If you are
    reading this, you know this already.

  * postgresql is the database engine for BUSH.  To verify that postgres is
    installed, try "psql --version".  For more information, visit
    http://www.postgresql.org.


INSTALLATION

The latest version of BUSH is always located at the PegaSoft web site,
http://www.pegasoft.ca.

1. configure

   The first step of the installation procedure is to select your operating
   system.  Run "configure" and the configure script will identify your
   operating system and create a new file called "bush_os.ads" containing the
   binding for your system calls.

   configure will also check for the basic tools needed to build BUSH
   (including an Ada compiler).  When it is finished configuring BUSH,
   configure will run the configure programs for the ADAVOX and APQ third-
   party libraries used by BUSH. The APQ configuration script will ask
   questions about your database software.  (Note: BUSH currently supports
   PostgreSQL only.)

   configure recognizes the following environment variables:

    - ARCH - this will override the machine processor architecture (normally
             determined by uname -p)
    - GMAKE - use this to specify a path to GNU make if it cannot be found

2. make

   Use GNU make to build BUSH.  Linux users can just type "make" or "make all".
   If GNU make is not your native make (e.g. FreeBSD), use "gmake".

3. (Optional) "gmake test" to run the bush regression tests.  This make take
   several minutes.

4. (Optional) "gmake install" will copy the bush executable to the
   /usr/local/bin/ directory so that other users can access it.  Alteratively,
   you can copy the bush executable and man page yourself and set the
   appropriate permission bits.

You can now run the bush executable.

Type "gmake help" for a list of all options.  There are more options in the
src directory makefile.

- END OF DOCUMENT -

