Base code merged to SPIN 2.4
[platform/upstream/curl.git] / docs / INSTALL
index 0e83f19..30dec53 100644 (file)
@@ -14,9 +14,16 @@ Installing Binary Packages
    binary package. This document describes how to compile, build and install
    curl and libcurl from source code.
 
-UNIX
+Building from git
+=================
+
+   If you get your code off a git repository, see the GIT-INFO file in the
+   root directory for specific instructions on how to proceed.
+
+Unix
 ====
-   A normal unix installation is made in three or four steps (after you've
+
+   A normal Unix installation is made in three or four steps (after you've
    unpacked the source archive):
 
         ./configure
@@ -26,8 +33,8 @@ UNIX
 
    You probably need to be root when doing the last command.
 
-   If you have checked out the sources from the CVS repository, read the
-   CVS-INFO on how to proceed.
+   If you have checked out the sources from the git repository, read the
+   GIT-INFO on how to proceed.
 
    Get a full listing of all available configure options by invoking it like:
 
@@ -53,8 +60,12 @@ UNIX
 
         ./configure --with-ssl
 
-   If you have OpenSSL installed somewhere else (for example, /opt/OpenSSL,)
-   you can run configure like this:
+   If you have OpenSSL installed somewhere else (for example, /opt/OpenSSL)
+   and you have pkg-config installed, set the pkg-config path first, like this:
+
+        env PKG_CONFIG_PATH=/opt/OpenSSL/lib/pkgconfig ./configure --with-ssl
+
+   Without pkg-config installed, use this:
 
         ./configure --with-ssl=/opt/OpenSSL
 
@@ -70,22 +81,23 @@ UNIX
 
      (with the Bourne shell and its clones):
 
-       CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
+        CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
            ./configure
 
      (with csh, tcsh and their clones):
 
-       env CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
-       ./configure
+        env CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
+           ./configure
 
    If you have shared SSL libs installed in a directory where your run-time
    linker doesn't find them (which usually causes configure failures), you can
    provide the -R option to ld on some operating systems to set a hard-coded
    path to the run-time linker:
 
-        LDFLAGS=-R/usr/local/ssl/lib ./configure --with-ssl
+        env LDFLAGS=-R/usr/local/ssl/lib ./configure --with-ssl
 
    MORE OPTIONS
+   ------------
 
      To force configure to use the standard cc compiler if both cc and gcc are
      present, run configure like
@@ -104,18 +116,6 @@ UNIX
 
        ./configure --disable-thread
 
-     To build curl with kerberos4 support enabled, curl requires the krb4 libs
-     and headers installed. You can then use a set of options to tell
-     configure where those are:
-
-          --with-krb4-includes[=DIR]   Specify location of kerberos4 headers
-          --with-krb4-libs[=DIR]       Specify location of kerberos4 libs
-          --with-krb4[=DIR]            where to look for Kerberos4
-
-     In most cases, /usr/athena is the install prefix and then it works with
-
-       ./configure --with-krb4=/usr/athena
-
      If you're a curl developer and use gcc, you might want to enable more
      debug options with the --enable-debug option.
 
@@ -124,22 +124,38 @@ UNIX
      default. But if you want to alter it, you can select how to deal with
      each individual library.
 
-     To build with GnuTLS support instead of OpenSSL for SSL/TLS, note that
-     you need to use both --without-ssl and --with-gnutls.
+     To build with GnuTLS for SSL/TLS, use both --without-ssl and
+     --with-gnutls.
+
+     To build with Cyassl for SSL/TLS, use both --without-ssl and
+     --with-cyassl.
+
+     To build with NSS for SSL/TLS, use both --without-ssl and --with-nss.
 
-     To build with yassl support instead of OpenSSL or GunTLS, you must build
-     yassl with its OpenSSL emulation enabled and point to that directory root
-     with configure --with-ssl.
+     To build with PolarSSL for SSL/TLS, use both --without-ssl and
+     --with-polarssl.
 
-     To build with NSS support instead of OpenSSL for SSL/TLS, note that
-     you need to use both --without-ssl and --with-nss.
+     To build with axTLS for SSL/TLS, use both --without-ssl and --with-axtls.
 
-     To get GSSAPI support, build with --with-gssapi and have the MIT or
-     Heimdal Kerberos 5 packages installed.
+     To build with GSS-API support, use --with-gssapi and have the MIT Kerberos
+     or Heimdal packages installed.
 
      To get support for SCP and SFTP, build with --with-libssh2 and have
      libssh2 0.16 or later installed.
-     
+
+     To get Metalink support, build with --with-libmetalink and have the
+     libmetalink packages installed.
+
+   SPECIAL CASES
+   -------------
+
+   Some versions of uClibc require configuring with CPPFLAGS=-D_GNU_SOURCE=1
+   to get correct large file support.
+
+   The Open Watcom C compiler on Linux requires configuring with the variables:
+
+       ./configure CC=owcc AR="$WATCOM/binl/wlib" AR_FLAGS=-q \
+           RANLIB=/bin/true STRIP="$WATCOM/binl/wstrip" CFLAGS=-Wextra
 
 Win32
 =====
@@ -162,43 +178,68 @@ Win32
    KB140584 - How to link with the correct C Run-Time (CRT) library
               http://support.microsoft.com/kb/140584/en-us
 
+   KB190799 - Potential Errors Passing CRT Objects Across DLL Boundaries
+              http://msdn.microsoft.com/en-us/library/ms235460
+
    If your app is misbehaving in some strange way, or it is suffering
    from memory corruption, before asking for further help, please try
    first to rebuild every single library your app uses as well as your
    app using the debug multithreaded dynamic C runtime.
 
+   If you get linkage errors read section 5.7 of the FAQ document.
+
    MingW32
    -------
 
-   MinGW32 does not provide a batch script to set environment variables
-   automatically. Make sure that MinGW32's bin dir is in PATH and then
-   run 'mingw32-make mingw32' in the root dir. There are other make
-   targets available to build libcurl with more features, use:
+   Make sure that MinGW32's bin dir is in the search path, for example:
+
+     set PATH=c:\mingw32\bin;%PATH%
+
+   then run 'mingw32-make mingw32' in the root dir. There are other
+   make targets available to build libcurl with more features, use:
    'mingw32-make mingw32-zlib' to build with Zlib support;
    'mingw32-make mingw32-ssl-zlib' to build with SSL and Zlib enabled;
    'mingw32-make mingw32-ssh2-ssl-zlib' to build with SSH2, SSL, Zlib;
    'mingw32-make mingw32-ssh2-ssl-sspi-zlib' to build with SSH2, SSL, Zlib
-   and SSPI.
+   and SSPI support.
 
    If you have any problems linking libraries or finding header files, be sure
    to verify that the provided "Makefile.m32" files use the proper paths, and
-   adjust as necessary. It is also possible to override these paths with 
+   adjust as necessary. It is also possible to override these paths with
    environment variables, for example:
 
-     set ZLIB_PATH=c:\zlib-1.2.3
-     set OPENSSL_PATH=c:\openssl-0.9.8e
-     set LIBSSH2_PATH=c:\libssh2-0.16
+     set ZLIB_PATH=c:\zlib-1.2.8
+     set OPENSSL_PATH=c:\openssl-0.9.8zc
+     set LIBSSH2_PATH=c:\libssh2-1.4.3
 
    ATTENTION: if you want to build with libssh2 support you have to use latest
-   sources fetched from CVS - the current 0.15 release will NOT work!
+   version 0.17 - previous versions will NOT work with 7.17.0 and later!
    Use 'mingw32-make mingw32-ssh2-ssl-zlib' to build with SSH2 and SSL enabled.
 
+   It is now also possible to build with other LDAP SDKs than MS LDAP;
+   currently it is possible to build with native Win32 OpenLDAP, or with the
+   Novell CLDAP SDK. If you want to use these you need to set these vars:
+
+     set LDAP_SDK=c:\openldap
+     set USE_LDAP_OPENLDAP=1
+
+   or for using the Novell SDK:
+
+     set USE_LDAP_NOVELL=1
+
+   If you want to enable LDAPS support then set LDAPS=1.
+
+   - optional MingW32-built OpenLDAP SDK available from:
+     http://www.gknw.net/mirror/openldap/
+   - optional recent Novell CLDAP SDK available from:
+     http://developer.novell.com/ndk/cldap.htm
+
    Cygwin
    ------
 
    Almost identical to the unix installation. Run the configure script in the
    curl root with 'sh configure'. Make sure you have the sh executable in
-   /bin/ or you'll see the configure fail towards the end.
+   /bin/ or you'll see the configure fail toward the end.
 
    Run 'make'
 
@@ -207,6 +248,46 @@ Win32
 
    See the separate INSTALL.devcpp file for details.
 
+   MSVC 6 caveats
+   --------------
+
+   If you use MSVC 6 it is required that you use the February 2003 edition of
+   the 'Platform SDK' which can be downloaded from:
+
+   http://www.microsoft.com/en-us/download/details.aspx?id=12261
+
+   Building any software with MSVC 6 without having PSDK installed is just
+   asking for trouble down the road once you have released it, you might notice
+   the problems in the first corner or ten miles ahead, depending mostly on your
+   choice of static vs dynamic runtime and third party libraries. Anyone using
+   software built in such way will at some point regret having done so.
+
+   If the compiler has been updated with the installation of a service pack as
+   those mentioned in http://support.microsoft.com/kb/194022 the compiler can be
+   safely used to read source code, translate and make it object code.
+
+   But, even with the service packs mentioned above installed, the resulting
+   software generated in such an environment will be using outdated system
+   header files and libraries with bugs and security issues which have already
+   been addressed and fixed long time ago.
+
+   So, building curl and libcurl with MSVC 6 without PSDK is absolutely
+   discouraged for the benefit of anyone using software built in such
+   environment. And it will not be supported in any way, as we could just
+   be hunting bugs which have already been fixed way back in 2003.
+
+   When building with MSVC 6 we attempt to detect if PSDK is not being used,
+   and if this is the case the build process will fail hard with an error
+   message stating that the February 2003 PSDK is required. This is done to
+   protect the unsuspecting and avoid PEBKAC issues.
+
+   Additionally it might happen that a die hard MSVC hacker still wants to
+   build curl and libcurl with MSVC 6 without PSDK installed, even knowing
+   that this is a highly discouraged and unsupported build environment. In
+   this case the brave of heart will be able to build in such an environment
+   with the requisite of defining preprocessor symbol ALLOW_MSVC6_WITHOUT_PSDK
+   in lib/config-win32.h and knowing that LDAP and IPv6 support will be missing.
+
    MSVC from command line
    ----------------------
 
@@ -222,7 +303,7 @@ Win32
    documentation on how to compile zlib. Define the ZLIB_PATH environment
    variable to the location of zlib.h and zlib.lib, for example:
 
-     set ZLIB_PATH=c:\zlib-1.2.3
+     set ZLIB_PATH=c:\zlib-1.2.8
 
    Then run 'nmake vc-zlib' in curl's root directory.
 
@@ -236,7 +317,7 @@ Win32
    Before running nmake define the OPENSSL_PATH environment variable with
    the root/base directory of OpenSSL, for example:
 
-     set OPENSSL_PATH=c:\openssl-0.9.8d
+     set OPENSSL_PATH=c:\openssl-0.9.8zc
 
    Then run 'nmake vc-ssl' or 'nmake vc-ssl-dll' in curl's root
    directory.  'nmake vc-ssl' will create a libcurl static and dynamic
@@ -251,37 +332,64 @@ Win32
    at runtime.
    Run 'nmake vc-ssl-zlib' to build with both ssl and zlib support.
 
+   MSVC IDE
+   --------
+
+   A fairly comprehensive set of Visual Studio project files are available for
+   v6.0 through v12.0 and are located in the projects folder to allow proper
+   building of both the libcurl library as well as the curl tool.
+
+   For more information about these projects and building via Visual Studio
+   please see the README file located in the projects folder.
+
    Borland C++ compiler
-   ---------------------
+   --------------------
 
-   compile openssl
+   Ensure that your build environment is properly set up to use the compiler
+   and associated tools. PATH environment variable must include the path to
+   bin subdirectory of your compiler installation, eg: c:\Borland\BCC55\bin
 
-   Make sure you include the paths to curl/include and openssl/inc32 in
-   your bcc32.cnf file
+   It is advisable to set environment variable BCCDIR to the base path of
+   the compiler installation.
 
-   eg : -I"c:\Bcc55\include;c:\path_curl\include;c:\path_openssl\inc32"
+     set BCCDIR=c:\Borland\BCC55
 
-   Check to make sure that all of the sources listed in lib/Makefile.b32
-   are present in the /path_to_curl/lib directory. (Check the src
-   directory for missing ones.)
+   In order to build a plain vanilla version of curl and libcurl run the
+   following command from curl's root directory:
 
-   Make sure the environment variable "BCCDIR" is set to the install
-   location for the compiler eg : c:\Borland\BCC55
+     make borland
 
-   command line:
-   make -f /path_to_curl/lib/Makefile-ssl.b32
+   To build curl and libcurl with zlib and OpenSSL support set environment
+   variables ZLIB_PATH and OPENSSL_PATH to the base subdirectories of the
+   already built zlib and OpenSSL libraries and from curl's root directory
+   run command:
 
-   compile simplessl.c with appropriate links
+     make borland-ssl-zlib
 
-   c:\curl\docs\examples\> bcc32 -L c:\path_to_curl\lib\libcurl.lib
-                                 -L c:\borland\bcc55\lib\psdk\ws2_32.lib
-                                 -L c:\openssl\out32\libeay32.lib
-                                 -L c:\openssl\out32\ssleay32.lib
-                                 simplessl.c
+   libcurl library will be built in 'lib' subdirectory while curl tool
+   is built in 'src' subdirectory. In order to use libcurl library it is
+   advisable to modify compiler's configuration file bcc32.cfg located
+   in c:\Borland\BCC55\bin to reflect the location of libraries include
+   paths for example the '-I' line could result in something like:
 
+     -I"c:\Borland\BCC55\include;c:\curl\include;c:\openssl\inc32"
 
-   MSVC IDE
-   --------
+   bcc3.cfg '-L' line could also be modified to reflect the location of
+   of libcurl library resulting for example:
+
+     -L"c:\Borland\BCC55\lib;c:\curl\lib;c:\openssl\out32"
+
+   In order to build sample program 'simple.c' from the docs\examples
+   subdirectory run following command from mentioned subdirectory:
+
+     bcc32 simple.c libcurl.lib cw32mt.lib
+
+   In order to build sample program simplessl.c an SSL enabled libcurl
+   is required, as well as the OpenSSL libeay32.lib and ssleay32.lib
+   libraries.
+
+   OTHER MSVC IDEs
+   ---------------
 
    If you use VC++, Borland or similar compilers. Include all lib source
    files in a static lib "project" (all .c and .h files that is).
@@ -290,10 +398,6 @@ Win32
    Make the sources in the src/ drawer be a "win32 console application"
    project. Name it curl.
 
-   For VC++ 6, there's an included Makefile.vc6 that should be possible
-   to use out-of-the-box.
-
-
    Disabling Specific Protocols in Win32 builds
    --------------------------------------------
 
@@ -311,15 +415,54 @@ Win32
    CURL_DISABLE_DICT     disables DICT
    CURL_DISABLE_FILE     disables FILE
    CURL_DISABLE_TFTP     disables TFTP
+   CURL_DISABLE_HTTP     disables HTTP
+   CURL_DISABLE_IMAP     disables IMAP
+   CURL_DISABLE_POP3     disables POP3
+   CURL_DISABLE_SMTP     disables SMTP
+
+   If you want to set any of these defines you have the following options:
+
+   - Modify lib/config-win32.h
+   - Modify lib/curl_setup.h
+   - Modify lib/Makefile.vc6
+   - Modify the "Preprocessor Definitions" in the libcurl project
+
+   Note: The pre-processor settings can be found using the Visual Studio IDE
+   under "Project -> Settings -> C/C++ -> General" in VC6 and "Project ->
+   Properties -> Configuration Properties -> C/C++ -> Preprocessor" in later
+   versions.
 
-   If you want to set any of these defines you have the following
-   possibilities:
+   Using BSD-style lwIP instead of Winsock TCP/IP stack in Win32 builds
+   --------------------------------------------------------------------
 
-   - Modify lib/setup.h
+   In order to compile libcurl and curl using BSD-style lwIP TCP/IP stack
+   it is necessary to make definition of preprocessor symbol USE_LWIPSOCK
+   visible to libcurl and curl compilation processes. To set this definition
+   you have the following alternatives:
+
+   - Modify lib/config-win32.h and src/config-win32.h
    - Modify lib/Makefile.vc6
-   - Add defines to Project/Settings/C/C++/General/Preprocessor Definitions
-     in the curllib.dsw/curllib.dsp Visual C++ 6 IDE project.
+   - Modify the "Preprocessor Definitions" in the libcurl project
+
+   Note: The pre-processor settings can be found using the Visual Studio IDE
+   under "Project -> Settings -> C/C++ -> General" in VC6 and "Project ->
+   Properties -> Configuration Properties -> C/C++ -> Preprocessor" in later
+   versions.
+
+   Once that libcurl has been built with BSD-style lwIP TCP/IP stack support,
+   in order to use it with your program it is mandatory that your program
+   includes lwIP header file <lwip/opt.h> (or another lwIP header that includes
+   this) before including any libcurl header. Your program does not need the
+   USE_LWIPSOCK preprocessor definition which is for libcurl internals only.
+
+   Compilation has been verified with lwIP 1.4.0 and contrib-1.4.0 from:
+
+   http://download.savannah.gnu.org/releases/lwip/lwip-1.4.0.zip
+   http://download.savannah.gnu.org/releases/lwip/contrib-1.4.0.zip
 
+   This BSD-style lwIP TCP/IP stack support must be considered experimental
+   given that it has been verified that lwIP 1.4.0 still needs some polish,
+   and libcurl might yet need some additional adjustment, caveat emptor.
 
    Important static libcurl usage note
    -----------------------------------
@@ -328,9 +471,41 @@ Win32
    add '-DCURL_STATICLIB' to your CFLAGS.  Otherwise the linker will look for
    dynamic import symbols.
 
+Apple iOS and Mac OS X
+======================
+
+   On recent Apple operating systems, curl can be built to use Apple's
+   SSL/TLS implementation, Secure Transport, instead of OpenSSL. To build with
+   Secure Transport for SSL/TLS, use the configure option --with-darwinssl. (It
+   is not necessary to use the option --without-ssl.) This feature requires iOS
+   5.0 or later, or OS X 10.5 ("Leopard") or later.
+
+   When Secure Transport is in use, the curl options --cacert and --capath and
+   their libcurl equivalents, will be ignored, because Secure Transport uses
+   the certificates stored in the Keychain to evaluate whether or not to trust
+   the server. This, of course, includes the root certificates that ship with
+   the OS. The --cert and --engine options, and their libcurl equivalents, are
+   currently unimplemented in curl with Secure Transport.
+
+   For OS X users: In OS X 10.8 ("Mountain Lion"), Apple made a major
+   overhaul to the Secure Transport API that, among other things, added
+   support for the newer TLS 1.1 and 1.2 protocols. To get curl to support
+   TLS 1.1 and 1.2, you must build curl on Mountain Lion or later, or by
+   using the equivalent SDK. If you set the MACOSX_DEPLOYMENT_TARGET
+   environmental variable to an earlier version of OS X prior to building curl,
+   then curl will use the new Secure Transport API on Mountain Lion and later,
+   and fall back on the older API when the same curl binary is executed on
+   older cats. For example, running these commands in curl's directory in the
+   shell will build the code such that it will run on cats as old as OS X 10.6
+   ("Snow Leopard") (using bash):
+
+      export MACOSX_DEPLOYMENT_TARGET="10.6"
+      ./configure --with-darwinssl
+      make
 
 IBM OS/2
 ========
+
    Building under OS/2 is not much different from building under unix.
    You need:
 
@@ -358,15 +533,15 @@ IBM OS/2
    If you're getting huge binaries, probably your makefiles have the -g in
    CFLAGS.
 
-
 VMS
 ===
+
    (The VMS section is in whole contributed by the friendly Nico Baggus)
 
    Curl seems to work with FTP & HTTP other protocols are not tested.  (the
    perl http/ftp testing server supplied as testing too cannot work on VMS
    because vms has no concept of fork(). [ I tried to give it a whack, but
-   thats of no use.
+   that's of no use.
 
    SSL stuff has not been ported.
 
@@ -403,8 +578,9 @@ VMS
 
    Facility - basically the program ID. A code assigned to the program
    the name can be fetched from external or internal message libraries
-   Errorcode - the errodes assigned by the application
+   Error code - the err codes assigned by the application
    Sev. - severity: Even = error, off = non error
+
       0 = Warning
       1 = Success
       2 = Error
@@ -413,7 +589,7 @@ VMS
       <5-7> reserved.
 
    This all presents itself with:
-   %<FACILITY>-<SeV>-<Errorname>, <Error message>
+   %<FACILITY>-<Sev>-<Errorname>, <Error message>
 
    See also the src/curlmsg.msg file, it has the source for the messages In
    src/main.c a section is devoted to message status values, the globalvalues
@@ -426,12 +602,13 @@ VMS
       Compaq C V6.2-003 on OpenVMS Alpha V7.1-1H2
 
    So far for porting notes as of:
+
    13-jul-2001
    N. Baggus
 
-
 QNX
 ===
+
    (This section was graciously brought to us by David Bentham)
 
    As QNX is targeted for resource constrained environments, the QNX headers
@@ -442,11 +619,12 @@ QNX
 
    A good all-round solution to this is to override the default when building
    libcurl, by overriding CFLAGS during configure, example
-   #  configure CFLAGS='-DFD_SETSIZE=64 -g -O2'
 
+   #  configure CFLAGS='-DFD_SETSIZE=64 -g -O2'
 
 RISC OS
 =======
+
    The library can be cross-compiled using gccsdk as follows:
 
         CC=riscos-gcc AR=riscos-ar RANLIB='riscos-ar -s' ./configure \
@@ -456,9 +634,9 @@ RISC OS
    where riscos-gcc and riscos-ar are links to the gccsdk tools.
    You can then link your program with curl/lib/.libs/libcurl.a
 
-
 AmigaOS
 =======
+
    (This section was graciously brought to us by Diego Casorran)
 
    To build cURL/libcurl on AmigaOS just type 'make amiga' ...
@@ -478,10 +656,11 @@ AmigaOS
    To enable SSL support, you need a OpenSSL native version (without ixemul),
    you can find a precompiled package at http://amiga.sourceforge.net/OpenSSL/
 
-
 NetWare
 =======
+
    To compile curl.nlm / libcurl.nlm you need:
+
    - either any gcc / nlmconv, or CodeWarrior 7 PDK 4 or later.
    - gnu make and awk running on the platform you compile on;
      native Win32 versions can be downloaded from:
@@ -490,36 +669,41 @@ NetWare
      http://developer.novell.com/ndk/libc.htm
    - or recent Novell CLib SDK available from:
      http://developer.novell.com/ndk/clib.htm
+   - optional recent Novell CLDAP SDK available from:
+     http://developer.novell.com/ndk/cldap.htm
    - optional zlib sources (static or dynamic linking with zlib.imp);
      sources with NetWare Makefile can be obtained from:
      http://www.gknw.net/mirror/zlib/
    - optional OpenSSL sources (version 0.9.8 or later build with BSD sockets);
      you can find precompiled packages at:
      http://www.gknw.net/development/ossl/netware/
-     for CLIB-based builds OpenSSL needs to be extended to build with BSD
-     sockets (currently only a winsock-based CLIB build is supported); 
-   - optional SSH2 sources (version 0.15 or later);
+     for CLIB-based builds OpenSSL 0.9.8h or later is required  - earlier versions
+     don't support building with CLIB BSD sockets.
+   - optional SSH2 sources (version 0.17 or later);
 
    Set a search path to your compiler, linker and tools; on Linux make
    sure that the var OSTYPE contains the string 'linux'; set the var
    NDKBASE to point to the base of your Novell NDK; and then type
-   'make netware' from the top source directory; other tagets available
+   'make netware' from the top source directory; other targets available
    are 'netware-ssl', 'netware-ssl-zlib', 'netware-zlib' and 'netware-ares';
    if you need other combinations you can control the build with the
    environment variables WITH_SSL, WITH_ZLIB, WITH_ARES, WITH_SSH2, and
    ENABLE_IPV6; you can set LINK_STATIC=1 to link curl.nlm statically.
-   I found on some Linux systems (RH9) that OS detection didnt work although
+   By default LDAP support is enabled, however currently you will need a patch
+   in order to use the CLDAP NDK with BSD sockets (Novell Bug 300237):
+   http://www.gknw.net/test/curl/cldap_ndk/ldap_ndk.diff
+   I found on some Linux systems (RH9) that OS detection didn't work although
    a 'set | grep OSTYPE' shows the var present and set; I simply overwrote it
    with 'OSTYPE=linux-rh9-gnu' and the detection in the Makefile worked...
    Any help in testing appreciated!
-   Builds automatically created 8 times a day from current CVS are here:
+   Builds automatically created 8 times a day from current git are here:
    http://www.gknw.net/mirror/curl/autobuilds/
    the status of these builds can be viewed at the autobuild table:
-   http://curl.haxx.se/auto/
-
+   http://curl.haxx.se/dev/builds.html
 
 eCos
 ====
+
    curl does not use the eCos build system, so you must first build eCos
    separately, then link curl to the resulting eCos library.  Here's a sample
    configure line to do so on an x86 Linux box targeting x86:
@@ -552,12 +736,12 @@ eCos
    of running curl in this way is the contents of the configuration file
    printed to the console.
 
---- src/main.c 19 Jul 2006 19:09:56 -0000      1.363
-+++ src/main.c 24 Jul 2006 21:37:23 -0000
+--- src/main.c  19 Jul 2006 19:09:56 -0000    1.363
++++ src/main.c  24 Jul 2006 21:37:23 -0000
 @@ -4286,11 +4286,31 @@
  }
+
+
 +#ifdef __ECOS
 +#include <cyg/fileio/fileio.h>
 +MTAB_ENTRY( testfs_mte1,
@@ -566,7 +750,7 @@ eCos
 +                   "",
 +                   0);
 +#endif
+
  int main(int argc, char *argv[])
  {
    int res;
@@ -584,45 +768,132 @@ eCos
 +  }
 +#endif
    memset(&config, 0, sizeof(struct Configurable));
-   config.errors = stderr; /* default errors to stderr */
 
+   config.errors = stderr; /* default errors to stderr */
 
 Minix
 =====
+
    curl can be compiled on Minix 3 using gcc or ACK (starting with
-   ver. 3.1.3).  The gcc and bash packages must be installed first.
-   The default heap size allocated to bash is inadequate for running
-   configure and will result in out of memory errors.  Increase it with
-   the command:
+   ver. 3.1.3).  Ensure that GNU gawk and bash are both installed and
+   available in the PATH.
 
-     chmem =2048000 /usr/local/bin/bash
+   ACK
+   ---
+   Increase the heap sizes of the compiler with the command:
 
-   Make sure gcc and bash are in the PATH with the command:
-   
-     export PATH=/usr/gnu/bin:$PATH
-   
-   then configure curl with a command like this:
+     binsizes xxl
 
-     ./configure CC=gcc GREP=grep AR=/usr/gnu/bin/gar --disable-ldap
+   then configure and compile curl with:
 
-   Then simply run 'make'.
+     ./configure CC=cc LD=cc AR=/usr/bin/aal GREP=grep \
+      CPPFLAGS='-D_POSIX_SOURCE=1 -I/usr/local/include'
+     make
+     chmem =256000 src/curl
 
-   To compile with the ACK C compiler:
+   GCC
+   ---
+   Make sure gcc is in your PATH with the command:
 
-     chmem =1024000 /usr/lib/em_cemcom.ansi
-     chmem =512000 /usr/lib/i386/as
-     ./configure CC=cc LD=cc GREP=grep CPPFLAGS=-D_POSIX_SOURCE=1 \
-                 --disable-ldap
+     export PATH=/usr/gnu/bin:$PATH
+
+   then configure and compile curl with:
+
+     ./configure CC=gcc AR=/usr/gnu/bin/gar GREP=grep
      make
+     chmem =256000 src/curl
+
+Symbian OS
+==========
 
+   The Symbian OS port uses the Symbian build system to compile.  From the
+   packages/Symbian/group/ directory, run:
+
+      bldmake bldfiles
+      abld build
+
+   to compile and install curl and libcurl using SBSv1. If your Symbian
+   SDK doesn't include support for P.I.P.S., you will need to contact
+   your SDK vendor to obtain that first.
+
+VxWorks
+========
+
+   Build for VxWorks is performed using cross compilation.
+   That means you build on Windows machine using VxWorks tools and
+   run the built image on the VxWorks device.
+
+   To build libcurl for VxWorks you need:
+
+      - CYGWIN (free, http://cygwin.com/)
+      - Wind River Workbench (commercial)
+
+   If you have CYGWIN and Workbench installed on you machine
+   follow after next steps:
+
+    1. Open the Command Prompt window and change directory ('cd')
+       to the libcurl 'lib' folder.
+    2. Add CYGWIN 'bin' folder to the PATH environment variable.
+       For example, type 'set PATH=C:/embedded/cygwin/bin;%PATH%'.
+    3. Adjust environment variables defined in 'Environment' section
+       of the Makefile.vxworks file to point to your software folders.
+    4. Build the libcurl by typing 'make -f ./Makefile.vxworks'
+
+   As a result the libcurl.a library should be created in the 'lib' folder.
+   To clean the build results type 'make -f ./Makefile.vxworks clean'.
+
+Android
+=======
+
+   Method using the static makefile:
+
+      - see the build notes in the packages/Android/Android.mk file.
+
+   Method using a configure cross-compile (tested with Android NDK r7c, r8):
+
+      - prepare the toolchain of the Android NDK for standalone use; this can
+        be done by invoking the script:
+        ./build/tools/make-standalone-toolchain.sh
+        which creates a usual cross-compile toolchain. Lets assume that you put
+        this toolchain below /opt then invoke configure with something like:
+        export PATH=/opt/arm-linux-androideabi-4.4.3/bin:$PATH
+        ./configure --host=arm-linux-androideabi [more configure options]
+        make
+      - if you want to compile directly from our GIT repo you might run into
+        this issue with older automake stuff:
+        checking host system type...
+        Invalid configuration `arm-linux-androideabi':
+        system `androideabi' not recognized
+        configure: error: /bin/sh ./config.sub arm-linux-androideabi failed
+        this issue can be fixed with using more recent versions of config.sub
+        and config.guess which can be obtained here:
+        http://git.savannah.gnu.org/gitweb/?p=config.git;a=tree
+        you need to replace your system-own versions which usually can be
+        found in your automake folder:
+        find /usr -name config.sub
+
+   Wrapper for pkg-config:
+
+      - In order to make proper use of pkg-config so that configure is able to
+        find all dependencies you should create a wrapper script for pkg-config;
+        file /opt/arm-linux-androideabi-4.4.3/bin/arm-linux-androideabi-pkg-config:
+
+        #!/bin/sh
+        SYSROOT=$(dirname ${0%/*})/sysroot
+        export PKG_CONFIG_DIR=
+        export PKG_CONFIG_LIBDIR=${SYSROOT}/usr/local/lib/pkgconfig:${SYSROOT}/usr/share/pkgconfig
+        export PKG_CONFIG_SYSROOT_DIR=${SYSROOT}
+        exec pkg-config "$@"
+
+        also create a copy or symlink with name arm-unknown-linux-androideabi-pkg-config.
 
 CROSS COMPILE
 =============
+
    (This section was graciously brought to us by Jim Duey, with additions by
    Dan Fandrich)
 
-   Download and unpack the cURL package.  Version should be 7.9.1 or later.
+   Download and unpack the cURL package.
 
    'cd' to the new directory. (e.g. cd curl-7.12.3)
 
@@ -646,10 +917,10 @@ CROSS COMPILE
    export NM=ppc_405-nm
 
    ./configure --target=powerpc-hardhat-linux \
-       --host=powerpc-hardhat-linux \
-       --build=i586-pc-linux-gnu \
-       --prefix=/opt/hardhat/devkit/ppc/405/target/usr/local \
-       --exec-prefix=/usr/local
+        --host=powerpc-hardhat-linux \
+        --build=i586-pc-linux-gnu \
+        --prefix=/opt/hardhat/devkit/ppc/405/target/usr/local \
+        --exec-prefix=/usr/local
 
    (end script)
 
@@ -664,18 +935,21 @@ CROSS COMPILE
 
        ./configure --host=ARCH-OS
 
-
 REDUCING SIZE
 =============
+
    There are a number of configure options that can be used to reduce the
    size of libcurl for embedded applications where binary size is an
    important factor.  First, be sure to set the CFLAGS variable when
    configuring with any relevant compiler optimization flags to reduce the
-   size of the binary.  For gcc, this would mean at minimum the -Os option
-   and probably the -march=X option as well, e.g.:
+   size of the binary.  For gcc, this would mean at minimum the -Os option,
+   and potentially the -march=X and -mdynamic-no-pic options as well, e.g.
 
       ./configure CFLAGS='-Os' ...
 
+   Note that newer compilers often produce smaller code than older versions
+   due to improved optimization.
+
    Be sure to specify as many --disable- and --without- flags on the configure
    command-line as you can to disable all the libcurl features that you
    know your application is not going to need.  Besides specifying the
@@ -683,35 +957,55 @@ REDUCING SIZE
    will not use, here are some other flags that can reduce the size of the
    library:
 
-     --disable-ares (disables support for the ARES DNS library)
+     --disable-ares (disables support for the C-ARES DNS library)
      --disable-cookies (disables support for HTTP cookies)
      --disable-crypto-auth (disables HTTP cryptographic authentication)
      --disable-ipv6 (disables support for IPv6)
+     --disable-manual (disables support for the built-in documentation)
+     --disable-proxy (disables support for HTTP and SOCKS proxies)
      --disable-verbose (eliminates debugging strings and error code strings)
      --enable-hidden-symbols (eliminates unneeded symbols in the shared library)
      --without-libidn (disables support for the libidn DNS library)
+     --without-librtmp (disables support for RTMP)
      --without-ssl (disables support for SSL/TLS)
      --without-zlib (disables support for on-the-fly decompression)
 
-   The GNU linker has a number of options to reduce the size of the libcurl
-   dynamic libraries on some platforms even further. Specify them by giving
-   the options -Wl,-Bsymbolic and -Wl,-s on the gcc command-line.  
+   The GNU compiler and linker have a number of options that can reduce the
+   size of the libcurl dynamic libraries on some platforms even further.
+   Specify them by providing appropriate CFLAGS and LDFLAGS variables on the
+   configure command-line, e.g.
+
+     CFLAGS="-Os -ffunction-sections -fdata-sections \
+             -fno-unwind-tables -fno-asynchronous-unwind-tables" \
+     LDFLAGS="-Wl,-s -Wl,-Bsymbolic -Wl,--gc-sections"
+
    Be sure also to strip debugging symbols from your binaries after
    compiling using 'strip' (or the appropriate variant if cross-compiling).
    If space is really tight, you may be able to remove some unneeded
    sections of the shared library using the -R option to objcopy (e.g. the
    .comment section).
 
-   Using these techniques it is possible to create an HTTP-only shared
-   libcurl library for i386 Linux platforms that is less than 90 KB in
-   size (as of version 7.15.4).
+   Using these techniques it is possible to create a basic HTTP-only shared
+   libcurl library for i386 Linux platforms that is only 114 KiB in size, and
+   an FTP-only library that is 115 KiB in size (as of libcurl version 7.35.0,
+   using gcc 4.8.2).
 
    You may find that statically linking libcurl to your application will
-   result in a lower total size.
+   result in a lower total size than dynamically linking.
+
+   Note that the curl test harness can detect the use of some, but not all, of
+   the --disable statements suggested above. Use will cause tests relying on
+   those features to fail.  The test harness can be manually forced to skip
+   the relevant tests by specifying certain key words on the runtests.pl
+   command line.  Following is a list of appropriate key words:
 
+     --disable-cookies          !cookies
+     --disable-manual           !--manual
+     --disable-proxy            !HTTP\ proxy !proxytunnel !SOCKS4 !SOCKS5
 
 PORTS
 =====
+
    This is a probably incomplete list of known hardware and operating systems
    that curl has been compiled for. If you know a system curl compiles and
    runs on, that isn't listed, please let us know!
@@ -724,18 +1018,28 @@ PORTS
         - Alpha OpenBSD 3.0
         - Alpha OpenVMS V7.1-1H2
         - Alpha Tru64 v5.0 5.1
+        - AVR32 Linux
+        - ARM Android 1.5, 2.1, 2.3, 3.2, 4.x
+        - ARM INTEGRITY
+        - ARM iOS
+        - Cell Linux
+        - Cell Cell OS
         - HP-PA HP-UX 9.X 10.X 11.X
         - HP-PA Linux
         - HP3000 MPE/iX
+        - MicroBlaze uClinux
         - MIPS IRIX 6.2, 6.5
         - MIPS Linux
+        - OS/400
         - Pocket PC/Win CE 3.0
         - Power AIX 3.2.5, 4.2, 4.3.1, 4.3.2, 5.1, 5.2
         - PowerPC Darwin 1.0
+        - PowerPC INTEGRITY
         - PowerPC Linux
         - PowerPC Mac OS 9
         - PowerPC Mac OS X
-        - SuperH4 Linux 2.6.X
+        - SH4 Linux 2.6.X
+        - SH4 OS21
         - SINIX-Z v5
         - Sparc Linux
         - Sparc Solaris 2.4, 2.5, 2.5.1, 2.6, 7, 8, 9, 10
@@ -743,6 +1047,8 @@ PORTS
         - StrongARM (and other ARM) RISC OS 3.1, 4.02
         - StrongARM/ARM7/ARM9 Linux 2.4, 2.6
         - StrongARM NetBSD 1.4.1
+        - Symbian OS (P.I.P.S.) 9.x
+        - TPF
         - Ultrix 4.3a
         - UNICOS 9.0
         - i386 BeOS
@@ -751,32 +1057,49 @@ PORTS
         - i386 Esix 4.1
         - i386 FreeBSD
         - i386 HURD
+        - i386 Haiku OS
         - i386 Linux 1.3, 2.0, 2.2, 2.3, 2.4, 2.6
+        - i386 Mac OS X
         - i386 MINIX 3.1
         - i386 NetBSD
         - i386 Novell NetWare
         - i386 OS/2
         - i386 OpenBSD
+        - i386 QNX 6
         - i386 SCO unix
         - i386 Solaris 2.7
         - i386 Windows 95, 98, ME, NT, 2000, XP, 2003
-        - i386 QNX 6
         - i486 ncr-sysv4.3.03 (NCR MP-RAS)
         - ia64 Linux 2.3.99
         - m68k AmigaOS 3
         - m68k Linux
+        - m68k uClinux
         - m68k OpenBSD
         - m88k dg-dgux5.4R3.00
         - s390 Linux
+        - x86_64 Linux
         - XScale/PXA250 Linux 2.4
+        - Nios II uClinux
 
 Useful URLs
 ===========
 
-OpenSSL   http://www.openssl.org
-MingW     http://www.mingw.org
-OpenLDAP  http://www.openldap.org
-Zlib      http://www.gzip.org/zlib/
-libssh2   http://www.libssh2.org
-
-
+axTLS        http://axtls.sourceforge.net/
+c-ares       http://c-ares.haxx.se/
+GNU GSS      http://www.gnu.org/software/gss/
+GnuTLS       http://www.gnu.org/software/gnutls/
+Heimdal      http://www.pdc.kth.se/heimdal/
+libidn       http://www.gnu.org/software/libidn/
+libmetalink  https://launchpad.net/libmetalink/
+libssh2      http://www.libssh2.org/
+MIT Kerberos http://web.mit.edu/kerberos/www/dist/
+NSS          http://www.mozilla.org/projects/security/pki/nss/
+OpenLDAP     http://www.openldap.org/
+OpenSSL      http://www.openssl.org/
+PolarSSL     http://polarssl.org/
+yassl        http://www.yassl.com/
+Zlib         http://www.zlib.net/
+
+MingW        http://www.mingw.org/
+MinGW-w64    http://mingw-w64.sourceforge.net/
+OpenWatcom   http://www.openwatcom.org/