Add forgotten server example files
[libisds.git] / INSTALL
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     --disable-doc
17         Do not build and install documentation. This is enabled by default.
19     --enable-example
21         Build example client. You can run and study example clients in `client'
22         subdirectory.
24     --enable-test
26         Build and run library internal tests. You can run tests by
27         `make check'. You can run and study each test in `test' subdirectory.
29     --enable-online-test
31         Build and run library internal tests that require Internet access in
32         addition. --enable-test must be supplied too. You can run tests by
33         `make check'. You can run and study each test in `test/online'
34         subdirectory.
36     --enable-debug
38         Switch on debugging mode, compile in debugging code.
40     --disable-fatalwarnings
42         Switch off compile mode when compiler raises error on warning. This is
43         enabled to catch all code ambiguities by default.
45     --enable-openssl-backend
47         Use OpenSSL library instead of GPGme library for parsing
48         a cryptographic message syntax structures and use OpenSSL library
49         instead of Libgcrypt library to compute hashes. GPGme and Libgrypt
50         back-end is used by default.
52     --with-docbook-xsl-stylesheets
54         Set directory where DocBook XSLT stylesheets for producing manual
55         pages are installed.
57     --without-libcurl
59         Disable network operations by omitting cURL library. It disables
60         on-line tests too. Library will keep capability to process local
61         messages and delivery details. Library will not be able to connect to
62         ISDS server in this mode.
64     --enable-curlreauthorizationbug
66         Compile in work-around for HTTP reauthorization bug in cURL library.
67         This is disabled by default. This bug will be fixed in cURL 7.28.0
68         by cURL commit ce8311c7e49eca93c136b58efa6763853541ec97. This bug
69         affects changing ISDS password while OTP authentication method is in
70         use. 
72 Large File Support (LFS) Notice: libisds uses GPGME by default, and GPGME is
73 compiled with LFS on usually. You need to keep LFS compatibility on reverse
74 dependencies (libisds library, your application using libisds), otherwise
75 strange things can happen (e.g. file/message/document sizes can mismatch).
76 libisds switches LFS on too. Use --disable-largefile to switch it off if you
77 think it's more appropriate. However recall this tweak when building your
78 application.
80 Example clients and tests are not installed by `make install'.