home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ACDI.ZIP / ACDI / ACDI.DOC
Text File  |  1992-03-02  |  14KB  |  327 lines
  1.  
  2.  
  3.    IBM Extended Services for OS/2
  4.    (c) Copyright International Business Machines Corp., 1988, 1991
  5.  
  6.  
  7.  
  8.    ACDI SAMPLE PROGRAMS
  9.  
  10.    The ACDI sample programs are examples of application programs written
  11.    using the ACDI interface verbs. The function of the sample programs is
  12.    to echo, line by line, a screen image from one personal computer to a
  13.    second personal computer. To support the function, there are two
  14.    sample programs:  one for the transmit side and one for the
  15.    receive side. Characters typed on the transmit side are echoed on the
  16.    receive side, one line at a time.
  17.  
  18.    The sample programs are designed to work in the OS/2 protect mode, with
  19.    Extended Services Communications Manager.  Sample program source code
  20.    and the supporting files are provided for C and Macro Assembler
  21.    languages.
  22.  
  23.    RESTRICTIONS
  24.  
  25.    Only alphanumeric keys are supported. The backspace, cursor movement, and
  26.    other keys are not supported by the sample programs.
  27.  
  28.    PREREQUISITE INFORMATION
  29.  
  30.    To run the sample programs, a user must be familiar with the following:
  31.  
  32.    1.  OS/2 installation and command prompt
  33.    2.  Installation of the Toolkit
  34.    3.  Extended Services Communications Manager installation
  35.    4.  Compiler of the language in which you are interested.
  36.  
  37.    HARDWARE REQUIREMENTS
  38.  
  39.    The two PS/2 or AT systems are to be connected to each other through a
  40.    null modem on an RS232 cable to ports COM1 for a non-switched connection.
  41.    If your connection or ports are different from this, then you must
  42.    select the appropriate parameters on the Select Modem/Interface Device
  43.    and Select Line Interface panels during Communications Manager
  44.    configuration.
  45.  
  46.    INSTALLATION
  47.  
  48.    To build the ACDI sample programs, the following programs must
  49.    be installed on the build machine:
  50.  
  51.    1. OS/2 Standard Edition Version 1.30.1 or
  52.       OS/2 Standard Edition Version 2.0
  53.    2. IBM Extended Services for OS/2 with Communications Manager
  54.       and with the Communications Manager API data structures
  55.    3. OS/2 Standard Edition Version 1.3 Programming Tools and Information
  56.       (Toolkit)
  57.    4. Microsoft C Version 6.0 or IBM Macro Assembler/2 Version 1.0
  58.  
  59.    INSTALLING IBM EXTENDED SERVICES FOR OS/2
  60.  
  61.    When installing Extended Services, make sure that you install
  62.    the Communications Manager with ACDI.  You can explictly install
  63.    ACDI by selecting it from the "Install Additional Features" panel.
  64.    Or, if you install the ASCII Terminal Emulator, then ACDI will
  65.    automatically be installed.
  66.  
  67.    To build the ACDI sample programs, the Communcations Manager API
  68.    data structures must be installed on the build machine.  The API
  69.    data structores are high level language include files.  To install
  70.    the API data structures select them from the "Install Additonal
  71.    Features" panel.
  72.  
  73.    CREATING ACDI SAMPLE PROGRAM CONFIGURATION FILES
  74.  
  75.    Create a configuration file for the ACDI sample program using the
  76.    configuration functions in Communications Manager.
  77.  
  78.    The following instructions will configure two workstations on which
  79.    the OS/2 program has been installed to run the ACDI sample programs.
  80.    The instructions guide you through the configuration process, panel
  81.    by panel, until complete.
  82.  
  83.    On the workstation that will run the receive side of the sample
  84.    program, copy the system-supplied configuration file named ACSCFGUS.CFG
  85.    to ACDISAMP.CFG in the C:\CMLIB directory.
  86.  
  87.    Start Communications Manager for the receive side using ACDISAMP
  88.    as the startup configuration file.
  89.  
  90.    Beginning at the Communications Manager Main Menu, complete the
  91.    following instructions.
  92.  
  93.    Press the Switch to Action Bar (F10) key.
  94.    Select "Advanced" from the action bar.
  95.    Select "Configuration" from the Advanced pull-down.
  96.    Select Enter.
  97.  
  98.    Specify the configuration file name.
  99.    Enter ACDISAMP in the Name field if not already there.
  100.    Select Enter.
  101.  
  102.    Specify Configuration Usage.
  103.    Select "Select this option if you intend to use this configuration
  104.    on this workstation."
  105.  
  106.    The Communications Configuration Menu is displayed.
  107.    Select "Asynchronous feature profiles" from the Communications
  108.    Configuration Menu.
  109.  
  110.    Select "Asynchronous communication port profiles" from the Asynchronous
  111.    Feature Configuration menu.
  112.  
  113.    Select "Create" from the Profile Operations panel.
  114.  
  115.    The Select Asynchronous Communications Port Profile panel is displayed.
  116.    Select "COM1" from the Select Asynchronous Communication Port panel.
  117.    Select Enter.
  118.  
  119.    The Specify Telephone Network ID panel is displayed.
  120.    Specify the telephone network ID "011"
  121.    Select Enter.
  122.  
  123.    The Select Interface Device panel is displayed.
  124.    Specify "Device" to be "Other modem or device" (be sure to use
  125.    the Spacebar).
  126.    Select Enter.
  127.  
  128.    The Select Line Interface panel is displayed.
  129.    Select "Non-switched" from the Select Line Interface panel.
  130.    Select Enter.
  131.  
  132.    Select Esc=Cancel on the Asynchronous Feature Configuration panel.
  133.  
  134.    Press the F10 key on the Communication Configuration Menu panel.
  135.    Select "Verify" from the action bar.
  136.    Select "Run verify" from the Verify pull-down.
  137.  
  138.    When the verification is successfully completed press Enter to
  139.    remove the panel.
  140.  
  141.    Press the F10 key.
  142.    Select "Exit" from the action bar.
  143.    Select "Exit communication configuration" from the Exit pull-down.
  144.  
  145.    Exit Communications Manager.
  146.  
  147.    The receive and transmit configuration files are the same.  If both
  148.    workstations are running under IBM Extended Services and the port
  149.    configurations are identical, you can copy ACDISAMP.CFG to the other
  150.    workstation instead of going through the configuration steps again.
  151.  
  152.  
  153.    INSTALLING THE COMPILER
  154.  
  155.    Install the compiler for the language in which you are interested.
  156.    Use the installation procedure for the compiler.   Refer to the
  157.    following section on supported languages for additional information.
  158.  
  159.    Note:  The instructions that you are to type at the OS/2 command prompt
  160.           show the command line with the path for information only.  For
  161.           example, [C:] is displayed, but you should not type
  162.           it at the OS/2 command prompt.  Also, you should not type the
  163.           instruction [press Enter].
  164.  
  165.    SUPPORTED LANGUAGES
  166.  
  167.    1.  C LANGUAGE SETUP
  168.  
  169.        a.  INSTALLING THE C COMPILER
  170.  
  171.            Install the Microsoft C Compiler Version 6.0 using the
  172.            installation procedure for the compiler. The SETUP program is
  173.            used to install the compiler.  Insert the Setup diskette
  174.            in drive A, make drive A the current drive and type the
  175.            following at the OS/2 command prompt:
  176.  
  177.              [A:\]setup  [press Enter]
  178.  
  179.            Follow the directions provided by the menus.  Select the
  180.            default directories and subdirectories, and be certain the
  181.            large model compiler is selected. The compiler is installed
  182.            at this point.
  183.  
  184.        b.  SETTING UP ENVIRONMENT VARIABLES
  185.  
  186.            During the compiler installation, a file called NEW-VARS.CMD
  187.            is placed in the C:\C600\BIN directory.  This file contains
  188.            commands to setup environment variables used by the Mirosoft
  189.            C compiler.  These commands can be copied to the CONFIG.SYS
  190.            file and the computer rebooted or you can just simply use
  191.            NEW-VARS.CMD file directly.  In any case, the path to the
  192.            C:\CMLIB directory needs to be added to the INCLUDE and LIB
  193.            environment variables.  This allows the compiler to find the
  194.            ACDI_C.H and the ACS.LIB files that are in the C:\CMLIB
  195.            directory.  Likewise, the path to the toolkit include directory
  196.            should be included on the INCLUDE environment variable.  The
  197.            path to the toolkit library directory should be included on
  198.            the LIB environment variable.  The INCLUDE and LIB enviroment
  199.            commands should look something like this:
  200.  
  201.            SET INCLUDE=C:\C600\INCLUDE;C:\TOOLKT13\C\INCLUDE;C:\CMLIB;
  202.            SET LIB=C:\C600\LIB;C:\OS2;C:\TOOLKT13\LIB:C:\CMLIB;
  203.  
  204.            You should also make sure that the PATH environment variable
  205.            includes the paths to the C compiler and toolkit binary files.
  206.            The PATH should have as a minimum:
  207.  
  208.            SET PATH=C:\C600\BINB;C:\C600\BINP;C:\CMLIB;C:\TOOLKT13\BIN;
  209.  
  210.            The PATH command will most likely contain many additional paths.
  211.  
  212.        c.  BUILDING THE SAMPLE PROGRAMS
  213.  
  214.            Create a directory on the build machine called SAMPBLD.  Copy
  215.            all the files from the A:\ACDI\ACDI_C directory to the SAMPBLD
  216.            directory.  To build the receive sample program type at an OS/2
  217.            command prompt:
  218.  
  219.            [C:\SAMPBLD\]nmake acdicrcv [press Enter]
  220.  
  221.            This will cause the ACDICRCV.C program to the compiled, linked
  222.            and messages bound.  The final result is ACDICRCV.EXE.
  223.  
  224.            To build the transmit sample program type at an OS/2 command
  225.            prompt:
  226.  
  227.            [C:\SAMPBLD\]nmake acdicxmt [press Enter]
  228.  
  229.            This builds the transmit sample program: ACDICXMT.EXE
  230.  
  231.    2.  MACRO ASSEMBLER LANGUAGE SETUP
  232.  
  233.        a.  INSTALLING MACRO ASSEMBLER
  234.  
  235.            Install the IBM Macro Assembler/2 Version 1.0 using the
  236.            installation procedure for the assembler. The INSTAID program
  237.            is used to install the assembler.  Insert the master diskette
  238.            in drive A, and type the following at the OS/2 command prompt:
  239.  
  240.              [C:\]instaid [press Enter]
  241.  
  242.            Follow the directions provided by the menus. Select the
  243.            default directories and subdirectories.  The assembler is
  244.            installed at this point.
  245.  
  246.            During installation of the assembler, the \MASM\BIN
  247.            directory is created.
  248.  
  249.        b.  SETTING UP ENVIRONMENT VARIABLES
  250.  
  251.            The CONFIG.SYS file contains commands which initialize the
  252.            PATH, INCLUDE and LIB environment variables.  The path to
  253.            the C:\CMLIB directory needs to be added to the INCLUDE and
  254.            LIB environment variables.  This allows the compiler to
  255.            find the ACDI_A.INC and the ACS.LIB files that are in the
  256.            C:\CMLIB directory.  Likewise, the path to the toolkit
  257.            include directory should be included on the INCLUDE
  258.            environment variable.  The path to the toolkit library
  259.            directory should be included on the LIB environment
  260.            variable.  The INCLUDE and LIB enviroment commands should
  261.            look something like this:
  262.  
  263.            SET INCLUDE=C:\TOOLKT13\MASM\INCLUDE;C:\CMLIB;
  264.            SET LIB=C:\TOOLKT13\LIB:C:\CMLIB;
  265.  
  266.            You should also make sure that the PATH environment
  267.            variable includes the paths to the assembler and toolkit
  268.            binary files.  The PATH should have as a minimum:
  269.  
  270.            SET PATH=C:\MASM\BIN;C:\CMLIB;C:\TOOLKT13\BIN;
  271.  
  272.            The PATH command will most likely contain many additional paths.
  273.  
  274.        c.  ASSEMBLING AND LINKING THE MACRO ASSEMBLER SAMPLE PROGRAMS
  275.  
  276.            Create a directory on the build machine called SAMPBLD.
  277.            Copy all the files from the A:\ACDI\ACDI_M directory to the
  278.            SAMPBLD directory.  To build the receive sample program type
  279.            at an OS/2 command prompt:
  280.  
  281.            [C:\SAMPBLD\]make acdimrcv [press Enter]
  282.  
  283.            This will cause the ACDIMRCV.C program to the assembled,
  284.            linked and messages bound.  The final result is
  285.            ACDIMRCV.EXE.
  286.  
  287.            To build the transmit sample program type at an OS/2 command
  288.            prompt:
  289.  
  290.            [C:\SAMPBLD\]make acdimxmt [press Enter]
  291.  
  292.            This builds the transmit sample program: ACDIMXMT.EXE
  293.  
  294.    RUNNING THE SAMPLE PROGRAMS
  295.  
  296.    Create a new directory named SAMPLE on the transmit side workstation.
  297.    Copy the transmit sample program (ACDICXMT.EXE or ACDIMXMT.EXE) to the
  298.    SAMPLE directory.
  299.  
  300.    Create a new directory named SAMPLE on the receive side workstation.
  301.    Copy the receive sample program (ACDICRCV.EXE or ACDIMRCV.EXE) to the
  302.    SAMPLE directory.
  303.  
  304.    Start Communications Manager on both workstations, the transmit side and
  305.    the receive side, with the configuration file ACDISAMP.   ACDI has
  306.    already been loaded on both workstations (ACDI is the default).
  307.  
  308.    Select "OS/2 command prompt" from the Program Selector panel on
  309.    each workstation.  Change the current directory to SAMPLE.  If
  310.    there is a blue help line at the top of the screen, type "help off"
  311.    to remove help.  Start your receive program (ACDICRCV.EXE or
  312.    ACDIMRCV.EXE) on the receive workstation.  Then start your transmit
  313.    program (ACDICXMT.EXE or ACDIMXMT.EXE) on the other workstation.
  314.  
  315.    You will see a blank screen displayed.  Start typing at the transmit
  316.    side.  The information you type is echoed at the receive side, line by
  317.    line.  To end the connection, press the Interrupt (Ctrl+C) key.
  318.  
  319.    NOTE: If the High Speed DMA Asynchronous Device Driver is installed
  320.          on the receive workstation, the receive sample program (ACDICRCV.EXE
  321.          or ACDIMRCV.EXE) will terminate with an apparent error.  This
  322.          behavior is inherent to the design of the High Speed DMA Asynchronous
  323.          Device Driver and does not indicate an error with the workstation or
  324.          the sample program, and the state of the workstation after termination
  325.          is identical to the termination state of a workstation not using the
  326.          High Speed Asynchronous Device Driver.
  327.