RuleWorks

Installation Guide
(ReadMe)

Introduction

This document describes the prerequisites and build procedures for the RuleWorks product on the following environments:

• Microsoft Windows
• Compaq OpenVMS
• Compaq Tru64 Unix
• Linux

Choose the appropriate instructions based upon your hardware and operating system.

Windows (Intel)

Windows (Alpha)

OpenVMS (Alpha)

OpenVMS (VAX)

Compaq Tru64 UNIX (Alpha)

Linux (Intel)

Linux (Alpha)

Prerequisites and Procedures

This section describes RuleWorks prerequisites and procedures.

Windows Intel 386/486/Pentium

This section describes the prerequisites and build procedures for RuleWorks in a Windows Intel environment.

Prerequisites

Before building RuleWorks in an Intel 386/486/Pentium environment, be certain that you have the following software already installed:

• Microsoft Windows NT 4.0 or higher
  or Microsoft Windows 95/98
• WATCOM C32 for DOS 9.5 or higher
  or WATCOM C/C++32 9.5 or higher
  or Microsoft Win32 SDK for Windows-NT
  or Microsoft Visual C++ 32-Bit Edition
  or Microsoft Visual C++ 2.0
  or Borland C++ 4.0 or higher

Note: The Microsoft and Borland products are commonly available through most software distributors. The WATCOM products are available through many of the distributors, but if you can't find it anywhere else:

WATCOM
415 Phillip Street
Waterloo, Ontario, Canada N2L 3X2
(519) 886-3700.

Kit Format

2 packages are available:

• RULSWIN.ZIP - All RuleWorks sources and build script.
• RULKIWIN.ZIP - RuleWorks compiler, run-time library and examples.

Files

The following files are included in the Intel 386/486/Pentium RuleWorks kit.

See Appendix A.

Windows Alpha Environment

Prerequisites

Before building RuleWorks in a Windows Alpha environment, be certain that you have the following software already installed:

• Microsoft Windows NT 4.0 or higher
• CLAXP compiler 8.0 or higher.

Kit Format

2 packages are available:

• RULSWIN.ZIP - All RuleWorks sources and build script.
• RULKAWIN.ZIP - RuleWorks compiler, run-time library and examples.

Files

The following files are included in the RuleWorks kit for the Windows Alpha environment.

See Appendix A.

Instructions to Build RuleWorks in a Windows Environment

To build RuleWorks in a Windows environment, use the following procedure:

• Download your file package of choice.

• Extract the files.

• Use PKZIP for Windows from Pkware.

Extracting the files will create a directory structure as follows:

.	- Contains General Public License (HTML format)
\BIN	- Contains compiler and Help file when build process is complete.
\BUILD (Source package only)	- Contains build file and intermediate files during build process.
\EXAMPLES	- Contains example files.
\INCLUDE	- Contains header files.
\LIBRARY	- Contains run-time library when build process is complete.
\SOURCE (Source package only)	- Contains sources required for build.

• Run the build script from the BUILD directory.
  • nmake -f RULE_MW.MAK KIT
    *You may have to modify the WIN32.MAK pointer in MAK file
  
  

  OpenVMS Alpha or OpenVMS VAX

  Prerequisites

  Before building RuleWorks in an OpenVMS environment, be certain that you have the following software already installed:

  • OpenVMS Alpha V6.2 or greater or OpenVMS VAX V6.0 or greater
  • DEC C V4.0 or greater or VAX C V3.2

  Kit Format

  3 packages are available:

  • RULSVMS.ZIP - All RuleWorks sources and build script.
  • RULKAVMS.ZIP - RuleWorks compiler, run-time library and examples. (Alpha)
  • RULKVVMS.ZIP - RuleWorks compiler, run-time library and examples. (VAX)

  Files

  The following files are included in the RuleWorks VMS kit.

  See Appendix A.

  Build Instructions

  Use the following procedure to build RuleWorks in an OpenVMS environment.

• Download your file package of choice.

• Extract the files.

• In the OpenVMS environment use the UNZIP facility available on the the OpenVMS FreeWare CD.

Extracting the files will create a directory structure as follows:

.	- Contains General Public License (HTML format)
\BIN	- Contains compiler and Help file when build process is complete.
\BUILD (Source package only)	- Contains build file and intermediate files during build process.
\EXAMPLES	- Contains example files.
\INCLUDE	- Contains header files.
\LIBRARY	- Contains run-time library when build process is complete.
\SOURCE (Source package only)	- Contains sources required for build.

• Run the build script from the BUILD directory.
  • In the OpenVMS environment
    @RULE_VMS.COM KIT
  
  

  Compaq Tru64 Unix

  Prerequisites

  Before building RuleWorks in a Compaq Tru64 Unix environment, be certain that you have the following software already installed:

  • Compaq Tru64 Unix (Alpha) V4.0 or higher
  • DEC C V1.2 or greater

  Kit Format

  2 packages are available:

  • RULSLUNX.TAR - All RuleWorks sources and build script.
  • RULKAUNX.TAR - RuleWorks compiler, run-time library and examples.

  Files

  The following files are included in the Compaq Tru64 Unix RuleWorks kit.

  See Appendix A.

  Build Instructions

  Use the following procedure to build RuleWorks in a Compaq Tru64 Unix environment.

• Download your file package of choice.

• Extract the files.

• In the Unix environment use the TAR facility.

Extracting the files will create a directory structure as follows:

.	- Contains General Public License (HTML format)
\BIN	- Contains compiler and Help file when build process is complete.
\BUILD (Source package only)	- Contains build file and intermediate files during build process.
\EXAMPLES	- Contains example files.
\INCLUDE	- Contains header files.
\LIBRARY	- Contains run-time library when build process is complete.
\SOURCE (Source package only)	- Contains sources required for build.

• Run the build script from the BUILD directory.
  • In the Unix environment
    make -f RULE_UNX.MAK KIT
  
  

  Linux (Intel / Alpha)

  Prerequisites

  Before building RuleWorks in a Linux environment, be certain that you have the following software already installed:

  • Operating System (tbd)
  • C compiler (tbd)

  Kit Format

  3 packages are available:

  • RULSLUNX.TAR - All RuleWorks sources and build script.
  • RULKALNX.TAR - RuleWorks compiler, run-time library and examples. (Alpha)
  • RULKILNX.TAR - RuleWorks compiler, run-time library and examples. (Intel)

  Files

  The following files are included in the Linux RuleWorks kit.

  See Appendix A.

  Build Instructions

  Use the following procedure to build RuleWorks in a Linux environment.

• Download your file package of choice.

• Extract the files.

• In the Linux environment use the TAR facility.

Extracting the files will create a directory structure as follows:

.	- Contains General Public License (HTML format)
\BIN	- Contains compiler and Help file when build process is complete.
\BUILD (Source package only)	- Contains build file and intermediate files during build process.
\EXAMPLES	- Contains example files.
\INCLUDE	- Contains header files.
\LIBRARY	- Contains run-time library when build process is complete.
\SOURCE (Source package only)	- Contains sources required for build.

• Run the build script from the BUILD directory.
  • In the Linux environment
    make -f rule_lnx.mak KIT
  
  

  Appendix A

  Source Packages

  Folder	No. Files	Details	Comment
  .	1	Gpl.html	Copy of GPL
  Bin	1	Bin.tmp	Required to build directory on UNZIP
  Build	10	Rul_*.mak (x3) rul_vms.com *.c (x6)	Product build files Intermediate files from *.LEX and *.Y
  Examples	7	Exam_*.mak (x3) Exam_vms.com *.rul (x3)	Examples with build files
  Include	3	Rul_rtl.* (x3)	API header files
  Library	1	Lib.tmp	Required to build directory on UNZIP
  Source	155	*.c (x83) *.h (x60) *.lex (x3) rulework.1 rulework.cld *.y (x2) *.sqlmod (x3) *.hlp (x2)	Sources
  	178

  
  

  Kit Packages

  Folder	No. Files	Details	Comment
  .	1	Gpl.html	Copy of GPL
  Bin	2 (3 in OpenVMS)	Rulework.exe Rulework.hlp (.1) (rulework.cld)	Compiler Help file (Man) (Command defn)
  Examples	7	Advent.rul Count.rul Tourney.rul Exam_*.mak (x3) Exam_vms.com	Example programs and build files.
  Include	4	Rul_rtl.* (x3) Rul_gend.h	API header files Header file for C generated code
  Library	1	Rul_rtl*.*	Run-time library
  	15 (16 in OpenVMS)