home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / conapi.zip / TAU / README / CONAPI / ReadMe.TXT < prev   
Text File  |  2000-02-09  |  3KB  |  84 lines
  1.  
  2.                   32-bit Unicode Console API "read me!"
  3.  
  4.             Copyright (c) 1999-2000 Jonathan de Boyne Pollard.
  5.          c/o 1 Queen's Close KENILWORTH  CV8 1JR, United Kingdom
  6.  
  7.               Jonathan de Boyne Pollard, FIDONET#2:257/609.3
  8.               Jonathan de Boyne Pollard, FIDONET#1:109/921.70
  9.           Jonathan de Boyne Pollard <J.deBoynePollard@tesco.net>
  10.  
  11.  
  12.     Guarantee and Software licence
  13.     ──────────────────────────────
  14.  
  15.     The 32-bit Unicode Console API is copyrighted software, with all
  16.     rights reserved by the author, which the author encourages everyone to
  17.     share and to use freely.  The terms and conditions of the software
  18.     licence, and the guarantee information, are contained in the on-line
  19.     help document CONCALLS.INF.
  20.  
  21.  
  22.     Installation
  23.     ────────────
  24.  
  25.     To install the Console API simply unpack the distribution archive into
  26.     a directory of your choice.
  27.  
  28.         PKZIP -extract -dir=curr CONAPI C:\CONAPI\ *
  29.  
  30.     ( This assumes that the distribution archive that you received was in
  31.       ZIP format, and that you are using PKZIP version 2.50 for OS/2. )
  32.  
  33.     This will extract the files that comprise the utilities into various
  34.     subdirectories of C:\CONAPI.  You will then need to add the relevant
  35.     subdirectories to the LIBPATH and BOOKSHELF environment variables, and
  36.     possibly the INCLUDE, LIB, IPATH, OS2_INCLUDE, or LIBOS2 environment
  37.     variables as well, depending from your compiler.
  38.  
  39.         Add C:\CONAPI\TAU\BOOK to your BOOKSHELF environment variable
  40.         Add C:\CONAPI\OS2\DLL to your LIBPATH directive
  41.  
  42.         Prepend C:\CONAPI\TAU\Include\OS2 to your C++ compiler's
  43.             include path
  44.         Add C:\CONAPI\OS2\Lib;C:\CONAPI\TAU\Lib to your C++ compiler's
  45.             library path
  46.  
  47.     Using the Console API
  48.     ─────────────────────
  49.  
  50.     Using the Console API is simple.  Simply define the INCL_CONSOLE macro
  51.     before the first inclusion of the <os2.h> header.  This will enable
  52.     the declarations of the console API functions and types.
  53.  
  54.     Notice that with the modified <bse.h> that is supplied, defining the
  55.     INCL_BASE enabling macro will now no longer automatically enable the
  56.     declarations for the VIO, KBD, and MOU subsystems when <os2.h> is
  57.     included.  To use the 32-bit VIO, KBD, and MOU subsystems, explicitly
  58.     define the INCL_VIO, INCL_KBD, and INCL_MOU macros.
  59.  
  60.     The 16-bit subsystems are not available unless you explicitly retain
  61.     your old <bsesub.h> header from the OS/2 Developers' Toolkit.
  62.     Because, if you have followed the installation instructions, your C++
  63.     compiler will locate the <bsesub.h> header supplied with this package
  64.     before any other, it is suggested that you rename your old <bsesub.h>
  65.     header to <bsesub16.h> and explicitly include it by that name.
  66.  
  67.     To link to the 32-bit VIO, KBD, and MOU subsystems, include the
  68.     CON3216.LIB import library in the files passed to your linker.
  69.  
  70.     To link to the 32-bit Unicode Console API, include the CONCALLS.LIB
  71.     import library in the files passed to your linker.
  72.  
  73.  
  74.     Getting help after installation
  75.     ───────────────────────────────
  76.  
  77.     The on-line documentation is in the book CONCALLS.INF.  To read it,
  78.     either double-click on the file on your Workplace Shell desktop or run
  79.     the command
  80.  
  81.         VIEW CONCALLS
  82.  
  83.     at the command line.
  84.