installing.rst 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. .. % $Id: ldap-dn.tex,v 1.8 2008/03/26 12:10:12 stroeder Exp
  2. ***********************
  3. Building and installing
  4. ***********************
  5. Prerequisites
  6. =============
  7. The following software packages are required to be installed
  8. on the local system when building python-ldap:
  9. - Python version 2.3 or later including its development files: http://www.python.org/
  10. - OpenLDAP client libs version 2.3 or later: http://www.openldap.org/
  11. It is not possible and not supported to build with prior versions.
  12. - OpenSSL (optional): http://www.openssl.org/
  13. - cyrus-sasl (optional): http://asg.web.cmu.edu/sasl/sasl-library.html
  14. - Kerberos libs, MIT or heimdal (optional)
  15. setup.cfg
  16. =========
  17. The file setup.cfg allows to set some build and installation
  18. parameters for reflecting the local installation of required
  19. software packages. Only section [_ldap] is described here.
  20. More information about other sections can be found in the
  21. documentation of Python's DistUtils.
  22. .. data:: library_dirs
  23. Specifies in which directories to search for required libraries.
  24. .. data:: include_dirs
  25. Specifies in which directories to search for include files of required libraries.
  26. .. data:: libs
  27. A space-separated list of library names to link to (see :ref:`libs-used-label`).
  28. .. data:: extra_compile_args
  29. Compiler options.
  30. .. data:: extra_objects
  31. .. _libs-used-label:
  32. Libs used
  33. ---------
  34. .. data:: ldap
  35. .. data:: ldap_r
  36. The LDAP protocol library of OpenLDAP. ldap_r is the reentrant version
  37. and should be preferred.
  38. .. data:: lber
  39. The BER encoder/decoder library of OpenLDAP.
  40. .. data:: sasl2
  41. The Cyrus-SASL library if needed and present during build
  42. .. data:: ssl
  43. The SSL/TLS library of OpenSSL if needed and present during build
  44. .. data:: crypto
  45. The basic cryptographic library of OpenSSL if needed and present during build
  46. Example
  47. =============
  48. The following example is for a full-featured build (including SSL and SASL support)
  49. of python-ldap with OpenLDAP installed in a different prefix directory
  50. (here /opt/openldap-2.3) and SASL header files found in /usr/include/sasl.
  51. Debugging symbols are preserved with compile option -g. ::
  52. [_ldap]
  53. library_dirs = /opt/openldap-2.3/lib
  54. include_dirs = /opt/openldap-2.3/include /usr/include/sasl
  55. extra_compile_args = -g
  56. extra_objects =
  57. libs = ldap_r lber sasl2 ssl crypto