home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / odtlktv5.zip / ODTLKT / TOOLKIT / README next >
Text File  |  1995-12-14  |  13KB  |  386 lines
  1. __________________________________________________________________
  2.  
  3. IBM DEVELOPER'S TOOLKIT FOR OS/2 WARP README FILE
  4. __________________________________________________________________
  5.  
  6. Welcome to the IBM* Developer's Toolkit for OS/2* Warp (Toolkit).
  7. In addition to this README, the book--"Using Your Toolkit"--is
  8. included to help you:
  9.  
  10.    -  See what is new and what has changed in the Toolkit
  11.    -  Become familiar with the Toolkit
  12.    -  Access information about the Toolkit more easily and quickly
  13.  
  14. This README, a supplement to "Using Your Toolkit," contains the following
  15. information:
  16.  
  17.    1. Introduction to the Toolkit
  18.    2. Installing the Toolkit
  19.    3. Updates to CONFIG.SYS
  20.  
  21. Use a non-proportional font to view this file.
  22.  
  23.  
  24. INTRODUCTION TO THE TOOLKIT
  25. __________________________________________________________________
  26.  
  27. The Toolkit helps you develop applications for OS/2 by providing you with:
  28.  
  29.      - Header files
  30.      - Library files
  31.      - Online documents
  32.      - Programming tools
  33.      - Sample application programs
  34.  
  35. This version of the Toolkit has been updated to the SOM Version which 
  36. corresponds to the level of SOM  in FixPak XR_W016 and OpenDoc for OS/2.  
  37.  
  38.  
  39. INSTALLING THE TOOLKIT
  40. __________________________________________________________________
  41.  
  42. This section provides a step-by-step procedure for installing the
  43. Toolkit.
  44.  
  45. You can install the Toolkit from CD-ROM or from diskettes created from
  46. diskette images on the CD-ROM.
  47.  
  48.  
  49. System Requirements
  50. __________________________________________________________________
  51.  
  52. The following is the prerequisite software required:
  53.  
  54.    o  OS/2 Warp, Version 3 or
  55.       OS/2 Warp with WIN-OS/2, Version 3 or
  56.       OS/2 Warp Connect or
  57.       OS/2 Warp Connect with WIN-OS/2 
  58.                     
  59.    o  OS/2 Warp FixPak XR_W016 (available on the Developer Connection 
  60.                                 Special Edition)
  61.  
  62.    o  Various components have additional software requirements as follows:
  63.       -  Developer API Extensions components require IBM Developer API 
  64.          Extensions for OS/2
  65.       -  OpenDoc related components require OpenDoc for OS/2
  66.       -  REXX components related to SOM or WPShell require OpenDoc for OS/2
  67.       -  Libraries component requires OpenDoc for OS/2 and IBM Developer API 
  68.          Extensions for OS/2
  69.       -  Beta component networking sample requires Networking Support 
  70.          (TCP/IP 2.0 or later)
  71.  
  72.  
  73. Only the functions available in the version of OS/2 you have installed 
  74. will be available in the Toolkit.
  75.  
  76. Before you install the Toolkit, make sure you have:
  77.  
  78.    -  A personal computer that has an Intel386** (or higher)
  79.       microprocessor with OS/2 installed
  80.  
  81.    -  A minimum of 4MB of memory (8MB or more is recommended)
  82.  
  83.    -  A high capacity 3.5-inch diskette drive or CD-ROM drive
  84.  
  85.    -  A hard disk drive with 100MB of free disk space (to install
  86.       the entire Toolkit)
  87.  
  88. We recommend that you install a mouse.
  89.  
  90.  
  91. Installation Program
  92. __________________________________________________________________
  93.  
  94. Install all or part of the Toolkit through the Toolkit Installation Program
  95. (a Presentation Manager/2* (PM) application). This program is available
  96. through either CD-ROM or diskettes made from diskette images on the CD-ROM.
  97. Through the Toolkit Installation Program, you can install:
  98.  
  99.      - Header files
  100.      - Library files
  101.      - Online documents
  102.      - Programming tools
  103.      - Sample application programs
  104.  
  105. By default, the Toolkit installation will copy chosen files to your machine
  106. and update CONFIG.SYS with respect to the locally installed files.
  107.  
  108.  
  109. Installation Help
  110. __________________________________________________________________
  111.  
  112. When installing the Toolkit, get online help for installation by doing one
  113. of the following:
  114.  
  115.    -  Press the F1 key
  116.    -  Select the Help push button
  117.    -  Choose one of the help choices from the Help menu
  118.  
  119.  
  120. Creating Diskettes from Diskette Images on the CD-ROM
  121. __________________________________________________________________
  122.  
  123. If you are installing the Toolkit directly from CD-ROM, go to the next
  124. section "Installing the Toolkit."
  125.  
  126. Create diskettes from diskette images on the CD-ROM by using The Developer
  127. Connection for OS/2 Catalog program as follows:
  128.  
  129.    1. Open The Developer Connection folder on your desktop.
  130.  
  131.    2. Open The Developer Connection for OS/2 folder from The Developer
  132.       Connection folder.
  133.  
  134.    3. Open The Developer Connection Catalog program from The Developer
  135.       Connection for OS/2 folder.
  136.  
  137.    4. Find the product entitled:
  138.  
  139.       IBM:  The Developer's Toolkit for OS/2 Warp:  3.5" Diskettes
  140.  
  141.       Note:  This product is located in the Developer Toolkits category.
  142.  
  143.    5. Start the diskette creation process by selecting the "Install
  144.       product" pop-up menu item.  By default, all diskettes will be
  145.       created.
  146.  
  147.    6. Select the "Proceed" button to start the diskette creation and
  148.       follow the instructions presented.
  149.  
  150.    7. Once you have made all the diskettes, follow the steps in the next
  151.       section "Installing the Toolkit."
  152.  
  153. If you prefer to create the diskettes without using The Developer
  154. Connection for OS/2 Catalog program, you create the diskettes as
  155. follows:
  156.  
  157.    1. Start an OS/2 Window or OS/2 Full Screen session.
  158.  
  159.    2. Change to the following directory on the CD-ROM drive:
  160.  
  161.          TOOLKITS\WARPTLKT\IMAGES
  162.  
  163.    3. Insert a blank diskette in drive A.  At the command prompt, type:
  164.  
  165.          LOADDSKF TK03401.IMG  A:/f
  166.  
  167.       This will create diskette one.
  168.  
  169.    4. Repeat step 3 for TK03402.IMG through TK03424.IMG.
  170.  
  171.    5. Once you have made all the diskettes, follow the steps in the next
  172.       section "Installing the Toolkit."
  173.  
  174.  
  175. Installing the Toolkit
  176. __________________________________________________________________
  177.  
  178. To install the Toolkit, do the following:
  179.  
  180.    1. Start the Toolkit Installation Program from diskettes or CD-ROM
  181.       as follows:
  182.  
  183.       -  Diskettes: Put the first diskette into the a: drive (or
  184.          other drive) and type the following:
  185.  
  186.             a:\TKINSTAL
  187.  
  188.       -  CD-ROM: From The Developer Connection for OS/2 Catalog, find
  189.          the product entitled:
  190.  
  191.             IBM: The Developer's Toolkit for OS/2 Warp: CD Install
  192.  
  193.          Note:  This product is located in the Developer Toolkits
  194.          category.  Install the product by selecting the "Install
  195.          product" pop-up menu item.  This action will bring up the
  196.          Toolkit Installation program.
  197.  
  198.          If you prefer to install the Toolkit without using The
  199.          Developer Connection for OS/2 Catalog, start an OS/2 Window
  200.          or OS/2 Full Screen session.  Put the CD-ROM containing the
  201.          Toolkit in the CD-ROM drive and change directories as follows:
  202.  
  203.             CD TOOLKITS\WARPTLKT
  204.  
  205.          Type the following and press Enter:
  206.  
  207.             TKINSTAL
  208.  
  209.  
  210.    2.  The system displays the "IBM Developer's Toolkit for OS/2 Warp
  211.        Installation" window.  Select each component you want to install.
  212.        Depending on the components you select for installation,
  213.        additional components might be automatically selected for
  214.        installation.  A plus (+) sign in a box in front of a component
  215.        indicates that the component has at least one level of
  216.        subcomponents from which you can select.  Select the plus sign in
  217.        front of the component to expand the list of components.
  218.  
  219.    3. If desired, change the default destination for the selected
  220.       components by editing the "Destination" entry field.  If the entire
  221.       Toolkit is not required, components may still be deselected in the
  222.       usual manner.  However, it is important that the paths are not
  223.       changed from their defaults for all components other than the root,
  224.       because the directory structure on the CD-ROM cannot be changed.
  225.  
  226.    4. Select the "Options" push button to specify what updates to your
  227.       system are required.  You can choose to:
  228.  
  229.          -  Install the selected files
  230.          -  Register Workplace Shell* classes
  231.          -  Create Workplace Shell objects
  232.          -  Select the file where any CONFIG.SYS updates are to be made,
  233.             or deselect the "Write CONFIG.SYS updates to:" check box to
  234.             prevent the Toolkit Installation program from updating
  235.             CONFIG.SYS.
  236.  
  237.    5. To install all selected components of the Toolkit:
  238.  
  239.          a. Select the "Install" push button.
  240.          b. Follow the prompts in the message boxes to complete the
  241.             installation.
  242.  
  243.    6. The system displays a message box indicating successful completion
  244.       of the installation.
  245.  
  246.    7. To make the changes effective and have the Toolkit folder appear
  247.       on the Desktop, shut down and restart your system.  After the
  248.       Toolkit is installed, the Toolkit folder appears on the desktop,
  249.       represented by the toolbox icon.  If you installed the entire
  250.       Toolkit, the folder will contain the following subfolders for
  251.       the installed components:
  252.  
  253.          -  Beta
  254.          -  C REXX Samples
  255.          -  Development Tools
  256.          -  Multimedia Bit maps
  257.          -  Multimedia Sample Programs
  258.          -  OS/2 Samples
  259.          -  Presentation Manager/2 Samples
  260.          -  Toolkit Information
  261.          -  Try Me!
  262.          -  Workplace Shell Samples
  263.  
  264.  
  265. UPDATES TO CONFIG.SYS
  266. __________________________________________________________________
  267.  
  268. The Toolkit Installation Program adds the paths of all needed
  269. environment variables with the appropriate Toolkit path.  These
  270. variables include, but are not limited to:
  271.  
  272.    -  BOOKSHELF
  273.    -  DPATH
  274.    -  HELP
  275.    -  INCLUDE
  276.    -  LIB
  277.    -  LIBPATH
  278.    -  PATH
  279.    -  SMEMIT
  280.    -  SMINCLUDE
  281.    -  SOMBASE
  282.    -  SOMIR
  283.    -  TMP
  284.  
  285.  
  286.  
  287. Application Programming Interface
  288. __________________________________________________________________
  289.  
  290. The following Bidi Spooler APIs are not
  291. available:
  292.  
  293. SplCreatePort
  294. SplDeletePort
  295. SplDisable
  296. SplDisplayControlPanel
  297. SplEnable
  298. SplGetControlPanelList
  299. SplGetPortFromQ
  300. SplQmGetJobID
  301. SplQmGetNewPage
  302. SplQueryControlPanel
  303. SplQueryPath
  304. SplQueryPort
  305. SplRegister
  306. SplRegisterControlPanel
  307. SplSetPort
  308. SplUnRegister
  309.  
  310.  
  311. OpenDoc
  312. __________________________________________________________________
  313.  
  314. If you are compiling an OpenDoc part with DTS and define the 
  315. symbol INCL_OD, you will also need to define the following 5 
  316. symbols to prevent compile errors:
  317.  
  318.         _DTS_HH_INCLUDED_comp
  319.         _DTS_HH_INCLUDED_compmgr
  320.         _DTS_HH_INCLUDED_osaterm
  321.         _DTS_HH_INCLUDED_osasc
  322.         _DTS_HH_INCLUDED_osagsc
  323.  
  324.  
  325. For more exciting information on OpenDoc development, join
  326. Club OpenDoc on the World Wide Web at:
  327.  
  328.         http://www.software.ibm.com/clubopendoc
  329.  
  330. Highlights include news and information, community spirit interaction, 
  331. and technical information in a two-way communication channel.
  332.  
  333. Come on aboard!
  334.  
  335.  
  336. __________________________________________________________________
  337.  
  338. Thank you for your continued interest in OS/2.
  339. __________________________________________________________________
  340.  
  341.  
  342. TRADEMARK INFORMATION
  343. _____________________
  344.  
  345.  
  346. The following terms, denoted by an asterisk (*) in this file, are
  347. trademarks or registered trademarks of the IBM Corporation in the United
  348. States or other countries:
  349.  
  350.    -------------------------------------------------------
  351.    C Set ++
  352.    -------------------------------------------------------
  353.    IBM
  354.    -------------------------------------------------------
  355.    OS/2
  356.    -------------------------------------------------------
  357.    Presentation Manager/2
  358.    -------------------------------------------------------
  359.    VisualAge
  360.    -------------------------------------------------------
  361.    Workplace Shell
  362.    -------------------------------------------------------
  363.  
  364.  
  365. The following terms, denoted by a double asterisk (**) in this
  366. publication, are trademarks of other companies:
  367.  
  368.    -------------------------------------------------------
  369.    Intel386                    Intel
  370.    Pro AudioSpectrum 16        Media Vision, Inc.
  371.    Sound Blaster               Creative Technology, Ltd.
  372.    Windows                     Microsoft Corporation
  373.    -------------------------------------------------------
  374.  
  375. IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING
  376. WITHOUT LIMITATION, WARRANTIES OF FITNESS AND MERCHANTABILITY WITH
  377. RESPECT TO THE INFORMATION IN THIS DOCUMENT.  BY FURNISHING THIS
  378. DOCUMENT, IBM GRANTS NO LICENSES TO ANY RELATED PATENTS OR COPYRIGHTS.
  379.  
  380. Copyright IBM Corporation, 1996, all rights reserved.
  381.  
  382. __________________________________________________________________
  383.  
  384. END-OF-README-FILE
  385. __________________________________________________________________
  386.