summaryrefslogtreecommitdiff
path: root/README
blob: 4cafc2bdc5e5e2df053e977125c0d0800677d795 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
= About =

Libkolabxml is the reference implementation of the Kolab XML Format as
defined in http://wiki.kolab.org/User:Mollekopf/Drafts/KEP:17.

It provides serialization/deserialization from/to in-memory
representations for all Kolab Objects, including input validation.

= Bindings =

Based on SWIG (www.swig.org) various language-bindings are provided.

= Usage =

For more information about the usage please see src/kolabformat.h

= Building =

Build with:

$ mkdir build
$ cd build
$ cmake ..
$ make

== CMake options ==

Options can either be supplied on the commandline or edited in the
cmake cache.

Library installation path:

    LIB_INSTALL_DIR=/usr/lib

Note that LIB_SUFFIX is honored since version 1.0.2

Set the installation prefix:

    CMAKE_INSTALL_PREFIX=/usr

Installation location for header files:

    INCLUDE_INSTALL_DIR=/usr/include

Building of bindings can be controlled using cmake configuration
options:

    PYTHON_BINDINGS
    PHP_BINDINGS
    JAVA_BINDINGS
    CSHARP_BINDINGS

The path to install the bindings:

    PYTHON_INSTALL_DIR
    PHP_INSTALL_DIR
    JAVA_INSTALL_DIR
    CSHARP_INSTALL_DIR

=== Example ===

Find libraries in lib64, install to /usr/lib64, build python and
phpbindings:

$ cmake -DCMAKE_INSTALL_PREFIX=/usr -DLIB_INSTALL_DIR=/usr/lib64 \
    -DPYTHON_BINDINGS=TRUE \
    -DPYTHON_INSTALL_DIR=/usr/lib64/python$x.$y/site-packages/ \
    -DPHP_BINDINGS=TRUE ..

== Requirements ==

Minimum requirements are:

    - cmake 2.6
    - boost >= 1.41
    - xerces-c >= 3.0
    - cxx >= 3.0 (http://www.codesynthesis.com/products/xsd/)
    - libcurl

For further features:

    - SWIG >= 2.0

For building test (controlled by -DBUILD_TESTS=TRUE):

    - Qt >= 4.7


For further information see src/DEVELOPMENT.