INI SipPhone

Version 1.00 (May 2002)

Copyright (C) 2002, Athanasios P Kosmidis. All rights reserved.

License to copy and use this software which is derived from the "Wavelink  
system created by N.Gupta, V.Keswani, H.Mak, R.Narjala and A.Pavuluri, 
is granted provided that it is identified as the "INI SipPhone"
in all material mentioning or referencing this software
or this function.

License is also granted to make and use derivative works provided
that such works are identified as "derived from the INI SipPhone"
in all material mentioning or referencing the derived work.

The creators of this software make no representations concerning either
the merchantability of this software or the suitability of this
software for any particular purpose. It is provided "as is"
without express or implied warranty of any kind.

These notices must be retained in any copies of any part of this
documentation and/or software.

-------------------------------------------------------------------------------

Compilation:

	This software requires several parts:

		* RTP stack, by Vovida (0.1.22+, http://www.vovida.org)
		* Qtopia, by Trolltech (1.5+, http://www.trolltech.com)

	The necessary RTP libraries can be found on the webpage (for both
	building for the x86 and the Zaurus).
	
	The following need to be run in order to compile and
	run the software:

		source dev-x86.sh  (for x86 compilation)
		source dev-arm.sh  (for compilation on an x86 for the Zaurus)

	Please make sure your system is configured appropriately and the
	above files have the correct paths.

	Note that if compiling for x86, the debugging symbols are included
	for debugging convenience; you can remove them from Makefile.pre, or
	by calling

		strip sip/sipPhone

	after compilation.
		


HOW TO USE:

(1) Configuration files:  

	The main requirement is that the primary configuration file, sip.cfg,
	has the following format:

		RegistrarServer			<registrarhost>
		RedirectServer			<redirecthost>
		UserAgentPort			<UAPortnumber>
		RegistrarServerPort		<RegistrarPortnumber>
		RedirectServerPort		<RedirectPortnumber>
		DefaultUsername			<defaultUsername>
		Authentication			<on|off>
		RegistrationDuration		<durationInSeconds>
		LoginTicketLifetime		<lifetimeInSeconds>
		RequireLoginAfterSuspend	<on|off>
		PDAAddressBookFile		<filename>
		SIPAddressBookFile		<filename>

	The following configuration files should be there but are not
	necessary:
		
		app_config.cfg
		content_encoding.cfg
		content_type.cfg
		
	All the above files should be in the <sip> directory.

(2) Notes:

	* 	The software relies upon the shell being able to provide the
		current IP address. Make sure that typing

			hostname

		returns the correct address. Otherwise type

			hostname <IP address>

	*	The software also relies on the existence of the 
		killall command. In case your system lacks it, please
		modify the AppManager accordingly.

	*  	On startup, the software looks for network connectivity.
		If it is absent, it does not start.

	* 	When used on an x86 machine with the Virtual Framebuffer,
		(qvfb) the program sometimes fails because of GUI-related
		issues. These issues are not present when used on the Zaurus.	

	* 	Define or undefine DEBUGGINGOUTPUT depending on your 
		preferences. By default, it is defined for x86 compilation
		and undefined for compilation targeting the Zaurus.

	* 	Similarly, define NDEBUG for assertions.
	
	* 	The audio part of the application supports both the single
		audio device hardware and the double audio device ones.
		Currently, only if building for the Zaurus (i.e. dev-arm.sh 
		has been run) does the DOUBLE device version get compiled.
		Otherwise, the SINGLE one is used. See rtp/Makefile for more
		details.

The author can be reached at thanoskosmidis@yahoo.com.