doc: Add ISDSSearch2 service
[libisds.git] / INSTALL
blobc30f632a176b437c162c7baed721b639ee9ebb91
1 See README for dependencies.
3 If you get code from VCS, you will need Autotools (automake, autoconf,
4 libtool) and gettext in addition and you must prepare build system with
5 `autoreconf --install'.
7 Then run `./configure && make && make install' to build and install library
8 into your system.
10 If you want to change installation directory use appropriate configure
11 argument (see `./configure --help' for more details).
13 Additional configure options:
15     --enable-example
17         Build example client. You can run and study example clients in `client'
18         subdirectory.
20     --enable-test
22         Build and run library internal tests. You can run tests by
23         `make check'. You can run and study each test in `test' subdirectory.
25     --enable-online-test
27         Build and run library internal tests that require Internet access in
28         addition. --enable-test must be supplied too. You can run tests by
29         `make check'. You can run and study each test in `test/online'
30         subdirectory.
32     --enable-debug
34         Switch on debugging mode, compile in debugging code.
36     --disable-fatalwarnings
38         Switch off compile mode when compiler raises error on warning. This is
39         enabled to catch all code ambiguities by default.
41     --enable-openssl-backend
43         Use OpenSSL library instead of GPGme library for parsing
44         a cryptographic message syntax structures and use OpenSSL library
45         instead of Libgcrypt library to compute hashes. GPGme and Libgrypt
46         back-end is used by default.
48     --without-libcurl
49     
50         Disable network operations by omitting cURL library. It disables
51         on-line tests too. Library will keep capability to process local
52         messages and delivery details. Library will not be able to connect to
53         ISDS server in this mode.
55     --enable-curlreauthorizationbug
57         Compile in work-around for HTTP reauthorization bug in cURL library.
58         This is disabled by default. This bug will be fixed in cURL 7.28.0
59         by cURL commit ce8311c7e49eca93c136b58efa6763853541ec97. This bug
60         affects changing ISDS password while OTP authentication method is in
61         use. 
63 Large File Support (LFS) Notice: libisds uses GPGME by default, and GPGME is
64 compiled with LFS on usually. You need to keep LFS compatibility on reverse
65 dependencies (libisds library, your application using libisds), otherwise
66 strange things can happen (e.g. file/message/document sizes can mismatch).
67 libisds switches LFS on too. Use --disable-largefile to switch it off if you
68 think it's more appropriate. However recall this tweak when building your
69 application.
71 Example clients and tests are not installed by `make install'.