README.md
1BcToolbox
2=========
3
4Utilities library used by Belledonne Communications softwares like belle-sip, mediastreamer2 and linphone.
5
6
7Depends
8-------
9
10- **mbedtls[1]**: implementation of TLS interface of BcToolbox. For backward
11 compatibility, support of polarssl is also provided.
12- **bcunit[2]** for unitary test tools. (optional)
13
14
15To compile
16----------
17
18 cmake . -DCMAKE_INSTALL_PREFIX=<install prefix> -DCMAKE_PREFIX_PATH=<search prefix>
19
20 make
21 make install
22
23
24To make an rpm package
25----------------------
26
27 cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCPACK_GENERATOR="RPM"
28
29 make package
30
31
32Options
33-------
34
35- `CMAKE_INSTALL_PREFIX=<string>`: install prefix.
36- `CMAKE_PREFIX_PATH=<string>`: search path prefix for dependencies e.g. mbedtls.
37- `ENABLE_MBEDTLS=NO`: do not look for mbedtls. Then, polarssl will be selected.
38- `ENABLE_POLARSSL=NO`: do not look for polarssl. That ensure to use mbedtls.
39- `ENABLE_SHARED=NO`: do not build the shared libraries.
40- `ENABLE_STATIC=NO`: do not build the static libraries.
41- `ENABLE_STRICT=NO`: do not build with strict compilator flags e.g. `-Wall -Werror`.
42- `ENABLE_TESTS=NO`: do not build testing binaries.
43- `ENABLE_TESTS_COMPONENT=NO`: do not build libbctoolbox-tester.
44
45
46Notes
47-----
48
49For backward compatibility with distributions not having the required 2.8.12 cmake version, an automake/autoconf build system is also available.
50It is maintained as a best effort and then should be used only in last resort.
51
52
53Note for packagers
54------------------
55
56Our CMake scripts may automatically add some paths into research paths of generated binaries.
57To ensure that the installed binaries are striped of any rpath, use `-DCMAKE_SKIP_INSTALL_RPATH=ON`
58while you invoke cmake.
59
60--------------------
61
62- [1] <https://github.com/ARMmbed/mbedtls.git>
63- [2] git://git.linphone.org/bctoolbox.git or <http://www.linphone.org/releases/sources/bctoolbox/>
64
65