#ident	"@(#)README	1.1	06/01/05 SMI"

This README file is for the SIP API package on Sun Solaris[tm] Operating
Environment.  The SIP API package provides interfaces to write SIP
applications and also includes a SIP stack conforming to RFC 3261[1].
The package includes the SIP API library, associated header file,
documents and examples.

SYSTEM REQUIREMENTS
___________________

To use the SIP API library, your system must run Solaris Operating system.
The library has been built on a Solaris 10 system; it is recommended that
your system runs Solaris 10 Operating system.

INSTALLATION NOTES
__________________

The package is delivered a gzip'ed tar file - sip_api_solaris.tar.gz.

Follow the next instructions to use the package.

	1. Determine the architecture of your system by using uname(1)

		# uname -m

	Output  from a SPARC based system should resemble the following:

		sun4u

	Output from an Intel based system should resemble the following:

		i86pc

	2. Download sip_api_solaris.tar.gz file into [+]/download_dir.
	   ([+]/download_dir can be any directory on the system with
	   appropriate access rights).

	3. Extract the package as follows:
		$ cd /download_dir
		$ gzcat sip_api_solaris.tar.gz | tar xvf -
		$ ls sip_api_solaris
		  README    docs      examples  header    libsip

	4. Move the library for the appropriate architecture:

	   SPARC:
	   	libsip/sparc/libsip.so.1 (32-bit)
	   	libsip/sparc/sparcv9/libsip.so.1 (64-bit)

	   Intel:
   		libsip/intel/libsip.so.1 (32-bit)
   		libsip/intel/amd64/libsip.so.1 (64-bit)

	   to /usr/lib (the 64-bit goes into /usr/lib/sparcv9 on SPARC and
	   /usr/lib/amd64/ on 64-bit AMD) and create libsip.so as a symbolic
	   link (ln -s) to libsip.so.1.  You could keep this library in
	   the location of your choice, but then would have to provide the
	   location when linking in the library. You would need root access
	   to move this to /usr/lib. The examples provided explicitly specify
	   the location of the library in the Makefile. Alternatively you
	   could set the variable LD_LIBRARY_PATH appropriately, e.g.
	   if the library (libsip.so) is in /download_dir, set
	   LD_LIBRARY_PATH as:

		$ setenv LD_LIBRARY_PATH /download_dir (tcsh)
		$ export LD_LIBRARY_PATH=/download_dir (ksh)

	   Move the header file:
			header/sip.h

	   to /usr/include/protocols. You could place this header in the
	   location of your choice, but would need to include it appropriately
	   in applications. You would need root access to move this into
	   /usr/include/protocols.

PACKAGE CONTENTS
________________

	- SIP library libsip.so (for SPARC and Intel, 32-bit and 64-bit)
	- Header file sip.h
	- Design document
	- Readme files for API
	- examples


LINKING WITH libsip
___________________

	An application needs to link with libsip (-lsip) in order to use any
	of the SIP API provided.


REPORTING PROBLEMS etc.
_______________________

	Please report problems, provide comments/feedback etc. to
	sip_api_questions@sun.com

REFERENCES
__________

[1] SIP: Session Initiation Protocol
	http://www.ietf.com/rfc/rfc3261.txt

			-------- o ---------