 ------------------------------------------------------------------------------
        INSTALL for the OS/2 Warp Connect 'hack' of mSQL version 1.0.x
 ------------------------------------------------------------------------------
Please read the note README.OS2 in DOC/ for more infos about this version
(bugs, other behaviour as original version, development environment, etc.).


Configuration of mSQL / W3-mSQL:
--------------------------------

  All configuration is done by one single configuration file - SRC\site.OS2
  Normally you only (if any) have to make changes in the first section:
    * LANG_ENGLISH (*)       enable only one of these flags for the language
      LANG_FRENCH            to be used within error messages. I hope the
      LANG_GERMAN            strings are translated well and are understand-
                             able ;-)                  (*) = default setting
    * BCPP                   enable this if you use a C compiler not knowing
                             '_System' and '_Optlink' (e.g. Borland C++)
    * VACPP                  enable this if you use IBM Visual Age C/C++
                             (enable compiler optimations)
    * DEBUG_MODE             enable this if you want to run ipmd or any
                             other debuger on the executables
    * DYNAMIC_LINKING        enable this option in order to build EXEs that
                             use the dynamic link libraries with the compiler
                             (default: static linkage)
    * MMAP                   disable this if you don't want mmap() emulation
                             but normal disk I/O calls instead
    * INSTPATH               installation directory (default: \public\mSQL)
    * TCPIP_PORT             TCP/IP port number used by the server
                             (the default 4333 should be used for maximum
                              compatibility with the original mSQL software)
  If you use a special compiler or have to make more changes, see the files
    * SRC\COMMON/config.h
    * SRC\COMMON/portable.h
    * SRC\COMMON/site.h
  too.



Linking:
--------

  There are two ways on linking:
    - static
    - dynamic
  Static linking is set default, because this will cause executable that can
  run on systems not having a development environment ("toolkit").
  Dynamic linking on the other hand results smaller executables (50% and more
  less in file size, msqld.exe: 90kB vs. 153kB) and reduces the redundancy
  of data on the hard disk.

  It's yours to change the linkage method. The mSQL library itself is created
  as a static library, since the original code is not that good for creating
  a DLL - and I'm not thinking about re-writing many parts of the sources!



Installation:
-------------

  To compile the source you need IBM C/C++ Set/2 or any equivalent compiler.
  I've tested the source with IBM C/C++ FirstStep Tools:
    nmake                              compile all
    nmake all                          compile all
    nmake clean                        delete all object files
    nmake delete                       delete all EXEs and object files
    nmake delete_all                   like 'delete', but deletes all INFs
                                       DOC\ and all files in BIN\, INCLUDE\
                                       and LIB\ as well as all output files
                                       (*.c & *.h) created by the compiler-
                                       compiler (bison/lex)
    nmake dist                         create a distribution archive
    nmake install                      create destination directory struc-
                                       ture and install files

  If you don't have a C compiler, you may install the pre-compiled binaries
  with the following command entered from the top of the mSQL archive direc-
  tory:
    scripts\install                    (\SCRIPTS\ -> install.cmd, REXX)

  Be sure, that the dynamic link library mSQL.DLL is located to a directory
  which can be access via LIB_PATH! The best is to extend your LIB_PATH
  entry in the CONFIG.SYS file with the library directory of mSQL.



TESTING:
--------

  To test the result do the following:
    1) cd \public\msql\bin             change to installation directory
    2) start msqld                     start server
    3) msqladm version                 check version
    4) msqladm create test             create a database "test"
    5) msql test < test.msl > xxx      run test script
    6) msqladm drop test               drop database "test"
    7) del xxx                         remove test result file
    8) msqladm shutdown                stop server
  On 3) you should see the correct program version. 4) will create a database
  located in the directory "\public\msql\msqldb\test", 6) will remove this
  directory. Check "xxx" against the source "test.msl" - all querys should
  succeed with the exception of twos (not null, non-unique key). After the
  check step 7) should be performed ...


Configuration of the server:
----------------------------

  After the first installation there is a file "sample.acl" in the root
  directory of the installation (default: "\public\msql"). Copy the file
  to "msql.acl" and edit that one to fit your needs. The file is read by
  the msqld.exe every time it's started or at "msqladm reload".


Mail Address:
-------------

  This small note and the 'hack' was written by
  Dirk Ohme, eMail: Dirk.Ohme@transtec.de
                    ohme@rzsco.fh-albsig.de
                    Dirk_Ohme@p9.f2001.n246.z2.fidonet.org (2:246/2001.9)

 ------------------------------------------------------------------------------
                     M”ssingen (Germany), July 2nd, 1996
 ------------------------------------------------------------------------------
