firstworks Installing Rudiments

Installing Rudiments

- Supported Platforms
- Prerequisites
- Installation on Linux, Unix or Unix-like Platforms

- Downloading Rudiments
- Extracting Rudiments
- Building Rudiments
- Installing Rudiments

- Installation on Windows

- Downloading Rudiments
- Extracting Rudiments
- Building Rudiments
- Installing Rudiments

Supported Platforms

Rudiments should build on Linux, Solaris, FreeBSD, NetBSD, OpenBSD, Minix, SCO OpenServer, SCO UnixWare, GNU Hurd, Haiku, and Syllable. Other Unix or Unix-like systems may also be supported.

Modern versions of Windows are also supported.

x86_64 and x86 platforms are supported, as are non-x86 architectures such as ARM, Sparc, Mips, PPC and others.

uClibc-linux systems are also supported.

Prerequisites

To build on a unix-like platform, Rudiments requires a working compiler toolchain and the make utility.

If OpenSSL and/or the Perl Compatible Regular Expression library are present on a unix-like platform then the build process will detect them and include support for them but they are not required.

To build natively on Windows, you need to install Microsoft Visual Studio or Microsoft Visual Studio Express. Versions 2005 and greater should work.

OpenSSL and the Perl Compatible Regular Expressions library are not currently supported on Windows.

Installation on Linux, Unix or Unix-like Platforms
Downloading Rudiments

You can download the most current source distribution of Rudiments from http://rudiments.sourceforge.net.

For Linux, Unix or Cygwin installations, download the tar.gz file.

Extracting Rudiments

To extract the distribution on Unix or Linux, move the file to a location on your machine that you have read/write access to and execute the following commands:

> gunzip rudiments-X.XX.tar.gz
> tar xf rudiments-X.XX.tar

(Where X.XX is replaced with the version of Rudiments that you downloaded.)

This will create a rudiments-X.XX directory.

Building Rudiments

To build Rudiments, navigate to the directory that was created by the extraction and execute the following commands:

> configure
> make

The configure script takes lots of command line options, most of which tell it which features to enable or disable or where to find prerequisite software in case any of it is installed in non-standard locations. It also takes the --prefix option in case you want to install it somewhere other than /usr/local/firstworks. For example:

> configure --prefix=/usr/local

This invocation would cause the libraries to be installed in /usr/local/lib, the header files in /usr/local/include, the binaries and scripts to be installed in /usr/local/bin, etc.

There are also options for using cross-compilers and enabling debug and profiling. To see the full list of available options, run:

> configure --help

There are several things to note when using Cygwin.

- You must use the Cygwin shell to build SQL Relay, rather than the Windows Command Line or DOS prompt.
- The file command must be present. If it is not, the build will fail and you will get a very cryptic error.
- SQL Relay cannot be built against non-Cygwin dll's. You can't, for instance, build against the Oracle, Sybase, the native Windows version of MySQL or the native Windows versions of Perl, Python, PHP, etc. Many languages and a few databases come with Cygwin though and others can be compiled from source under Cygwin.

Installing Rudiments

By default, on Unix or Linux, everything is installed under /usr/local/firstworks by default. You should either create that directory and give yourself full access permissions or install as root.

To install Rudiments run:

> make install

To uninstall Rudiments run:

> make uninstall

Installation on Windows
Downloading Rudiments

You can download the most current source distribution of Rudiments from http://rudiments.sourceforge.net.

For a native Windows installation, download the zip file.

Extracting Rudiments

To extract the distribution, move the zip file to your desktop or a location on your machine that you have read/write access, right click on the file and select "Extract All".

This will create a rudiments-X.XX directory where X.XX is replaced with the rudiments version number.

Building Rudiments

To build Rudiments on Windows, open the Visual Studio Command Prompt.

To build a 32-bit version of Rudiments, open the Visual Studio Command Prompt for x86. To build a 64-bit version of Rudiments, open the Visual Studio Command Prompt for x64.

Navigate to the directory that was created when Rudiments was extracted, and execute the following commands:

> cscript /nologo configure.vbs
> nmake

Installing Rudiments

By default, on Windows, everything is installed under C:\Program Files\Firstworks. You should either create that directory and give yourself full access permissions or install as Administrator.

To install Rudiments run:

> nmake install

To uninstall Rudiments run:

> nmake uninstall