README.md 2.15 KB
Newer Older
François Grisez's avatar
François Grisez committed
1 2
Belle-sip
=========
3

François Grisez's avatar
François Grisez committed
4 5
Overview
--------
6 7 8 9 10 11 12 13 14

Belle-sip is a SIP (RFC3261) implementation written in C, with an object oriented API.
Please check "NEWS" file for an overview of current features.
Copyright 2012-2014, Belledonne Communications SARL <contact@belledonne-communications.com>, all rights reserved.

Belle-sip is distributed to everyone under the GNU GPLv2 (see COPYING file for details).
Incorporating belle-sip within a closed source project is not possible under the GPL.
Commercial licensing can be purchased for that purpose from [Belledonne Communications](http://www.belledonne-communications.com).

François Grisez's avatar
François Grisez committed
15 16
Dependencies
------------
17

François Grisez's avatar
François Grisez committed
18
### Build-time dependencies
19

François Grisez's avatar
François Grisez committed
20
These are required to generate a C sourcefile from SIP grammar using [antlr3](http://www.antlr3.org/) generator:
21

François Grisez's avatar
François Grisez committed
22 23
* [Java SE](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or OpenJDK
* [antlr 3.4](https://github.com/antlr/website-antlr3/blob/gh-pages/download/antlr-3.4-complete.jar)
24 25


François Grisez's avatar
François Grisez committed
26
### Runtime dependencies
27

François Grisez's avatar
François Grisez committed
28 29
- *libantlr3c* version 3.2 or 3.4
- *bctoolbox* (git://git.linphone.org/bctoolbox.git or <http://www.linphone.org/releases/sources/bctoolbox/>)
30 31


François Grisez's avatar
François Grisez committed
32
### Under Debian/Ubuntu
33

François Grisez's avatar
François Grisez committed
34
		apt-get install libantlr3c-dev antlr3
35 36


François Grisez's avatar
François Grisez committed
37
### Under MacOS X using HomeBrew
38

François Grisez's avatar
François Grisez committed
39
		brew install libantlr3.4c homebrew/versions/antlr3
40 41


François Grisez's avatar
François Grisez committed
42 43
Building bctoolbox with CMake
-----------------------------
44

François Grisez's avatar
François Grisez committed
45 46 47 48
		cmake . -DCMAKE_INSTALL_PREFIX=<prefix> -DCMAKE_PREFIX_PATH=<search_prefix>
	
		make
		make install
49 50


François Grisez's avatar
François Grisez committed
51 52
Build options
-------------
53

François Grisez's avatar
François Grisez committed
54 55 56 57 58 59
* `CMAKE_INSTALL_PREFIX=<string>` : install prefix.
* `CMAKE_PREFIX_PATH=<string>`    : column-separated list of prefixes where to find dependencies.
* `ENABLE_TESTS=NO`               : disable non-regression tests.
* `ENABLE_STRICT=NO`              : build without strict build options like `-Wall -Werror`
* `ENABLE_SHARED=NO`              : do not build the shared library
* `ENABLE_STATIC=NO`              : do not build the static library
60 61


François Grisez's avatar
François Grisez committed
62 63
Note for packagers
------------------
64

François Grisez's avatar
François Grisez committed
65 66 67
Our CMake scripts may automatically add some paths into research paths of generated binaries.
To ensure that the installed binaries are striped of any rpath, use `-DCMAKE_SKIP_INSTALL_RPATH=ON`
while you invoke cmake.