
                  32-bit Unicode Console API "read me!"

         Copyright (c) 1999,2000,2009 Jonathan de Boyne Pollard.

          Jonathan de Boyne Pollard <J.deBoynePollard@tesco.net>


Guarantee and Software licence


The 32-bit Unicode Console API is copyrighted software, with all
rights reserved by the author, which the author encourages everyone to
share and to use freely.  The terms and conditions of the software
licence, and the guarantee information, are contained in the on-line
help document CONCALLS.INF.


Installation and Configuration


This version of the Console API follows the TAU application
installation and configuration philosophy:

   The package installs in a "JdeBP\CONAPI" subdirectory of your
    chosen Applications files directory.
   Configuring your system to use the package involves setting some
    environment variables and/or DLL search paths.

To install, simply pick an Applications files directory, if you don't
already have one, and unpack the archive there.  For example, if your
applications directory is C:\APPS, extract as follows:

    PKZIP -extract -dir=curr CONAPI C:\APPS\ *

( This assumes that the distribution archive that you received was in
  ZIP format, and that you are using PKZIP version 2.50 for OS/2. )

To configure, you must make the following changes to your CONFIG.SYS

    Add C:\Apps\JdeBP\CONAPI\OS2\DLL to your LIBPATH directive
    Add C:\Apps\JdeBP\CONAPI\OS2\BOOK to your BOOKSHELF environment variable
    Add C:\Apps\JdeBP\CONAPI\OS2\Include to your C++ compiler's
        include path (variously IPATH, INCLUDE, or OS2_INCLUDE for
        different compilers)
    Add C:\Apps\JdeBP\CONAPI\OS2\Lib to your C++ compiler's
        library path (variously LIB or LIBOS2 for different compilers)

and restart your system.


Note


This package is not required on TAU.  The "OS2" in the pathname is
there in part in order to indicate this.  If you configure a TAU
system to use this package, you will find that parts of the system
will fail to operate correctly.  A 32-bit Console system is built in
to TAU, and the The TAU ADK contains the correct headers and link
libraries already.


Using the Console API


Using the Console API is simple.  Simply define the INCL_CONSOLE macro
before the first inclusion of the <os2.h> header.  This will enable
the declarations of the console API functions and types.

Notice that with the modified <bse.h> that is supplied, defining the
INCL_BASE enabling macro will now no longer automatically enable the
declarations for the VIO, KBD, and MOU subsystems when <os2.h> is
included.  To use the 32-bit VIO, KBD, and MOU subsystems, explicitly
define the INCL_VIO, INCL_KBD, and INCL_MOU macros.

The 16-bit subsystems are not available unless you explicitly retain
your old <bsesub.h> header from the OS/2 Developers' Toolkit.
Because, if you have followed the installation instructions, your C++
compiler will locate the <bsesub.h> header supplied with this package
before any other, it is suggested that you rename your old <bsesub.h>
header to <bsesub16.h> and explicitly include it by that name.

To link to the 32-bit VIO, KBD, and MOU subsystems, include the
CON3216.LIB import library in the files passed to your linker.

To link to the 32-bit Unicode Console API, include the CONCALLS.LIB
import library in the files passed to your linker.


Getting help after installation


The on-line documentation is a set of HTML pages in the directory
%APPS%\JdeBP\CONAPI\OS2\Doco\ which can be browsed with a WWW browser.
