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

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

Pekka Pessi's avatar
Pekka Pessi committed
8 9 10 11 12 13
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
Pekka Pessi's avatar
Pekka Pessi committed
14
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


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

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

23
sh> sh autogen.sh (if building from darcs)
Pekka Pessi's avatar
Pekka Pessi committed
24 25 26 27
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.

31 32 33 34 35
See the "options-client-example" (available using darcs at
http://sofia-sip.org/repos/options-client-example/ or with CVS as
a 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.
Pekka Pessi's avatar
Pekka Pessi committed
36 37 38 39

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

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

43
The Sofia-SIP su submodule also provides some small utilities:
44

Pekka Pessi's avatar
Pekka Pessi committed
45
- addrinfo (libsofia-sip-ua/su), resolve host names
46
- localinfo (libsofia-sip-ua/su), prints information about
Pekka Pessi's avatar
Pekka Pessi committed
47
  local network interfaces
48

Pekka Pessi's avatar
Pekka Pessi committed
49 50 51 52
References
----------

Project website:
53 54
- http://sofia-sip.sourceforge.net
- http://www.sourceforge.net/projects/sofia-sip
Pekka Pessi's avatar
Pekka Pessi committed
55 56

Mailing list:
57
- http://sourceforge.net/mail/?group_id=143636
Pekka Pessi's avatar
Pekka Pessi committed
58

59 60
Version control repositories:
- see the project website (link above)
Pekka Pessi's avatar
Pekka Pessi committed
61 62 63 64 65

Licensing
---------

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