README 1.79 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7
===============================================================
README / Sofia-SIP - a RFC3261 compliant SIP User-Agent library
===============================================================

Introduction
------------

Pekka Pessi's avatar
Pekka Pessi committed
8 9 10 11 12 13 14
Sofia-SIP is an open-source SIP  User-Agent library, compliant 
with the IETF RFC3261 specification. It can be used as 
a building block for SIP client software for uses such as VoIP, 
IM, and many other real-time and person-to-person communication 
services. The primary target platform for Sofia-SIP is 
GNU/Linux. Sofia-SIP is based on a SIP stack developed at 
the Nokia Research Center. Sofia-SIP is licensed under the LGPL.
Pekka Pessi's avatar
Pekka Pessi committed
15 16 17 18 19 20 21 22 23 24 25 26 27


Quick start
-----------

Sofia-SIP uses the GNU autotools, so building procedure
is the usual:

sh> ./autogen.sh (if building from CVS)
sh> ./configure
sh> make
sh> make install

28 29 30
See also 'docs/devel_platform_notes.txt' for notes on compiling
Sofia-SIP in different environments.

Pekka Pessi's avatar
Pekka Pessi committed
31 32 33 34 35 36 37
See the "options-client-example" module in Sofia-SIP CVS-tree
for an example of a small app that is utilizing Sofia-SIP,
and specifically the libsofia-sip-ua library component.

There are also multiple example clients under
the "sofia-sip/utils" directory:

38
- sip-options, query using SIP OPTIONS method
Pekka Pessi's avatar
Pekka Pessi committed
39
- sip-date, SIP date printer/parser
Pekka Pessi's avatar
Pekka Pessi committed
40

41 42 43 44 45 46
The Sofia-SIP su submodule also provides some small utils:

- addrinfo (libsofia-sip-ua/su), resolve host names 
- localinfo (libsofia-sip-ua/su), prints information about
  local network interfaces 

Pekka Pessi's avatar
Pekka Pessi committed
47 48 49 50 51

References
----------

Project website:
52
http://sofia-sip.sourceforge.net
Pekka Pessi's avatar
Pekka Pessi committed
53 54 55 56 57 58 59 60 61 62 63 64 65 66
http://www.sourceforge.net/projects/sofia-sip

Mailing list:
http://sourceforge.net/mail/?group_id=143636

CVS repository:
http://sourceforge.net/cvs/?group_id=143636


Licensing
---------

Sofia-SIP is licensed under terms of the GNU LGPL.
See the file "COPYING" for more infromation.