contrib/apr-util/README

   1 Apache Portable Runtime Utility Library README
   2 ----------------------------------------------
   3
   4    The Apache Portable Runtime Utility Library provides a predictable
   5    and consistent interface to underlying client library interfaces.
   6    This API assures predictable if not identical behavior regardless
   7    of which libraries are available on a given platform.
   8
   9    APR and its companion libraries are implemented entirely in C
  10    and provide a common programming interface across a wide variety
  11    of operating system platforms without sacrificing performance.
  12    Currently supported platforms include:
  13
  14      UNIX variants
  15      Windows
  16      Netware
  17      Mac OS X
  18      OS/2
  19
  20    To give a brief overview, the primary core
  21    subsystems of APR-util 1.3 include the following:
  22
  23      Hashing and UUID services
  24      Multiple SQL DBD client interfaces
  25      Multiple flat-database DBM client interfaces
  26      Typesafe function Hooks abstraction
  27      LDAP SSL connections for a variety of LDAP toolkits
  28      MemCache interface
  29      Date parsing rourtines
  30      Resource Lists
  31      Thread Pools
  32      Queues
  33      Relocatable Memory Management functions
  34      String filename-style pattern matching
  35      URI Parsing
  36      Charset translation (iconv based)
  37      XML parsing (expat based)
  38
  39    For a more complete list, please refer to the following URLs:
  40
  41      http://apr.apache.org/docs/apr-util/modules.html
  42
  43    Users of APR 0.9 should be aware that migrating to the APR 1.x
  44    programming interfaces may require some adjustments; APR 1.x is
  45    neither source nor binary compatible with earlier APR 0.9 releases.
  46    Users of APR 1.x can expect consistent interfaces and binary backwards
  47    compatibility throughout the entire APR 1.x release cycle, as defined
  48    in our versioning rules:
  49
  50      http://apr.apache.org/versioning.html
  51
  52    APR is already used extensively by the Apache HTTP Server
  53    version 2 and the Subversion revision control system, to
  54    name but a few.  We list all known projects using APR at
  55    http://apr.apache.org/projects.html -- so please let us know
  56    if you find our libraries useful in your own projects!
  57
  58
  59 Database Providers
  60 ------------------
  61 As of apr-util version 1.2.11, MySQL DBD driver is shipped as part of the
  62 distribution.  However, to avoid licensing incompatibilities, it is not
  63 built by default.  To enable MySQL support, use the --with-mysql option,
  64 but be aware that the MySQL license may introduce licensing implications
  65 for your compiled code.  Similarly, the bindings for propritary drivers
  66 such as Oracle (--with-oracle option) must also be explicitly enabled.
  67
  68 On windows, selection of supported drivers is via the environment values
  69 DBD_LIST (for freetds, mysql, oracle, pgsql, sqlite2 and/or sqlite3)
  70 and DBM_LIST (db and/or gdbm).  DBD odbc and DBM sdbm are unconditionally
  71 compiled and installed, do not include these in the list.
  72
  73 Whenever distributing apr-util in combination with database client
  74 drivers, always review the license requirements of all components.
  75
  76
  77 Cryptographic Software Notice
  78 -----------------------------
  79 This distribution includes cryptographic software.  The country in
  80 which you currently reside may have restrictions on the import,
  81 possession, use, and/or re-export to another country, of
  82 encryption software.  BEFORE using any encryption software, please
  83 check your country's laws, regulations and policies concerning the
  84 import, possession, or use, and re-export of encryption software, to
  85 see if this is permitted.  See http://www.wassenaar.org/ for more
  86 information.
  87
  88 The U.S. Government Department of Commerce, Bureau of Industry and
  89 Security (BIS), has classified this software as Export Commodity
  90 Control Number (ECCN) 5D002.C.1, which includes information security
  91 software using or performing cryptographic functions with asymmetric
  92 algorithms.  The form and manner of this Apache Software Foundation
  93 distribution makes it eligible for export under the License Exception
  94 ENC Technology Software Unrestricted (TSU) exception (see the BIS
  95 Export Administration Regulations, Section 740.13) for both object
  96 code and source code.
  97
  98 The following provides more details on the included cryptographic
  99 software:
 100
 101   APR-Util provides an abstract interface for symmetrical cryptographic
 102   functions that make use of a general-purpose encryption library,
 103   such as OpenSSL, NSS, or the operating system's platform-specific
 104   facilities. This interface is known as the apr_crypto interface,
 105   with implementation beneath the /crypto directory.
 106
 107   APR-Util provides an abstract interface for SSL encrypted LDAP (ldaps
 108   and STARTTLS style) connections, which can be powered by OpenLDAP,
 109   Netscape LDAP SDK, Mozilla LDAP SDK, or other platform specific ldap
 110   interfaces.
 111