For information about licensing, please see the LICENSE file in this
directory, or http://www.vovida.org/license.html .

Content:
========

README: 	this read me file.
LICENSE: 	license file.
src: 		directory for source codes of the JTAPI 1.2 implementation 
		and the Vocalpad application.
lib: 		directory for the jar file of the Vocalpad application 
		including the JTAPI implementation.
 

Compile:
========

Until we have a make file, users will have to compile the Java application, the Vocalpad. Here is a sample command line for compilation:

    $javac -d /vocal/proxies/fs/jtapi/client/classes *.java -sourcepath 
	    /vocal/proxies/fs/jtapi/client/src/

    where the path after "-d" is the destination of the class files and the 
    path after "-sourcepath" is where the source tree starts. 
    Users will have to do this for very subdirectories that has java source 
    codes.

Alternatively, Vovida do distribute the jar file for the Vocalpad application, it should be in the "lib" of the Jtapi cleint directory, usually "/vocal/proxies/fs/jtapi/client". With this jar file and Sun's JTAPI jar file, which should be downloaded from Sun's site, users should be able to use the Vocalpad application without any compilation. Oh, I forgot, the JRE is needed also.
 
Usage:
======

1) Class Path:
    1. Set call path to point to where your java classes files are.
	E.g.
	    setenv CLASSPATH "/vocal/proxies/fs/jtapi/client/classes" 
	    where the directory structure "com/vovida/vocalpad" begins

    1.1 Alternatively, set call path to point to where the JTAPI client jar 
	file is if you are going to use the jar file rather than the classes.
	E.g.
	    setenv CLASSPATH 
		    "/vocal/proxies/fs/jtapi/client/lib/JtapiClient.jar".

    2. Set call path to include the path to Sun's JTAPI jar file.
	E.g. setenv CLASSPATH 
		    "/vocal/proxies/fs/jtapi/client/lib/jtapi.jar:$CLASSPATH"

    NOTE: 
	1. Due to copyright reason, Vovida does not redistribute the jtapi.jar
	    file in its distribution. Users need to download it from Sun's 
	    JTAPI site and put it where the class path points.


Command Line:
=============

$java com.vovida.vocalpad.Japp Jtapi_server_host Jtapi_server_port vocalpad_port

where
    "com.vovida.vocalpad.Japp"	: is the Java executable
    "Jtapi_server_host"		: is the host where Jtapi server is running
    "Jtapi_server_port"		: is the port Jtapi server is listening on
    "vocalpad_port"		: is the port Vocalpad listening on for messages
				    from Jtapi server

    example:
	$java com.vovida.vocalpad.Japp ada 8888 9999

    NOTE: the Jtapi_server_port is not arbitrary, it should be same as the one
	    configured with provisioning client.
======================================================================

Copyright 2000-2003, Cisco Systems, Inc.
THE INFORMATION HEREIN IS PROVIDED ON AN "AS IS" BASIS, WITHOUT ANY
WARRANTIES OR REPRESENTATIONS, EXPRESS, IMPLIED OR STATUTORY, INCLUDING
WITHOUT LIMITATION, WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE.

$Id: README,v 1.5.2.1 2003/03/28 05:25:54 bko Exp $
