X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=docs%2FINSTALL;h=30dec53432372e8a9e75f1918395421b43cc0285;hb=ff9f0eb35d80c251e9a54162eae18f44349ae59d;hp=4140359dadd6ff12d8aeac29c08d088c8f947466;hpb=d69d98bb1e0435e6d0a6358677725bd663f598c0;p=platform%2Fupstream%2Fcurl.git diff --git a/docs/INSTALL b/docs/INSTALL index 4140359..30dec53 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -20,9 +20,10 @@ 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 +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 @@ -115,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. @@ -148,8 +137,8 @@ UNIX 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. @@ -159,6 +148,7 @@ UNIX SPECIAL CASES ------------- + Some versions of uClibc require configuring with CPPFLAGS=-D_GNU_SOURCE=1 to get correct large file support. @@ -167,7 +157,6 @@ UNIX ./configure CC=owcc AR="$WATCOM/binl/wlib" AR_FLAGS=-q \ RANLIB=/bin/true STRIP="$WATCOM/binl/wstrip" CFLAGS=-Wextra - Win32 ===== @@ -199,7 +188,6 @@ Win32 If you get linkage errors read section 5.7 of the FAQ document. - MingW32 ------- @@ -221,7 +209,7 @@ Win32 environment variables, for example: set ZLIB_PATH=c:\zlib-1.2.8 - set OPENSSL_PATH=c:\openssl-0.9.8y + 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 @@ -246,7 +234,6 @@ Win32 - optional recent Novell CLDAP SDK available from: http://developer.novell.com/ndk/cldap.htm - Cygwin ------ @@ -264,8 +251,10 @@ Win32 MSVC 6 caveats -------------- - If you use MSVC 6 it is required that you use the February 2003 edition PSDK: - http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm + 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 @@ -273,8 +262,6 @@ Win32 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. - When someone uses MSVC 6 without PSDK he is using a compiler back from 1998. - 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. @@ -284,13 +271,6 @@ Win32 header files and libraries with bugs and security issues which have already been addressed and fixed long time ago. - In order to make use of the updated system headers and fixed libraries - for MSVC 6, it is required that 'Platform SDK', PSDK from now onwards, - is installed. The specific PSDK that must be installed for MSVC 6 is the - February 2003 edition, which is the latest one supporting the MSVC 6 compiler, - this PSDK is also known as 'Windows Server 2003 PSDK' and can be downloaded - from http://www.microsoft.com/msdownload/platformsdk/sdkupdate/psdk-full.htm - 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 @@ -337,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.8y + 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 @@ -352,39 +332,18 @@ Win32 at runtime. Run 'nmake vc-ssl-zlib' to build with both ssl and zlib support. - MSVC 6 IDE - ---------- - - A minimal VC++ 6.0 reference workspace (vc6curl.dsw) is available with the - source distribution archive to allow proper building of the two included - projects, the libcurl library and the curl tool. - - 1) Open the vs/vc6/vc6curl.dsw workspace with MSVC6's IDE. - 2) Select 'Build' from top menu. - 3) Select 'Batch Build' from dropdown menu. - 4) Make sure that the eight project configurations are 'checked'. - 5) Click on the 'Build' button. - 6) Once the eight project configurations are built you are done. - - Dynamic and static libcurl libraries are built in debug and release flavours, - and can be located each one in its own subdirectory, dll-debug, dll-release, - lib-debug and lib-release, all of them below the 'vs/vc6/lib' subdirectory. + MSVC IDE + -------- - In the same way four curl executables are created, each using its respective - library. The resulting curl executables are located in its own subdirectory, - dll-debug, dll-release, lib-debug and lib-release, below 'vs/vc6/src' subdir. + 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. - These reference VC++ 6.0 configurations are generated using the dynamic CRT. - - Intentionally, these reference VC++ 6.0 projects and configurations don't use - third party libraries, such as OpenSSL or Zlib, to allow proper compilation - and configuration for all new users without further requirements. - - If you need something more 'involved' you might adjust them for your own use, - or explore the world of makefiles described above 'MSVC from command line'. + For more information about these projects and building via Visual Studio + please see the README file located in the projects folder. Borland C++ compiler - --------------------- + -------------------- Ensure that your build environment is properly set up to use the compiler and associated tools. PATH environment variable must include the path to @@ -429,7 +388,6 @@ Win32 is required, as well as the OpenSSL libeay32.lib and ssleay32.lib libraries. - OTHER MSVC IDEs --------------- @@ -440,7 +398,6 @@ Win32 Make the sources in the src/ drawer be a "win32 console application" project. Name it curl. - Disabling Specific Protocols in Win32 builds -------------------------------------------- @@ -459,16 +416,21 @@ Win32 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 - possibilities: + 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 - - Add defines to Project/Settings/C/C++/General/Preprocessor Definitions - in the vc6libcurl.dsw/vc6libcurl.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. Using BSD-style lwIP instead of Winsock TCP/IP stack in Win32 builds -------------------------------------------------------------------- @@ -480,8 +442,12 @@ Win32 - Modify lib/config-win32.h and src/config-win32.h - Modify lib/Makefile.vc6 - - Add definition to Project/Settings/C/C++/General/Preprocessor Definitions - in the vc6libcurl.dsw/vc6libcurl.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 @@ -505,9 +471,9 @@ 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 @@ -537,9 +503,9 @@ Apple iOS and Mac OS X ./configure --with-darwinssl make - IBM OS/2 ======== + Building under OS/2 is not much different from building under unix. You need: @@ -567,9 +533,9 @@ 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 @@ -614,6 +580,7 @@ VMS the name can be fetched from external or internal message libraries Error code - the err codes assigned by the application Sev. - severity: Even = error, off = non error + 0 = Warning 1 = Success 2 = Error @@ -635,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 @@ -651,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 \ @@ -665,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' ... @@ -687,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: @@ -731,9 +701,9 @@ NetWare the status of these builds can be viewed at the autobuild table: 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: @@ -801,9 +771,9 @@ eCos 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). Ensure that GNU gawk and bash are both installed and available in the PATH. @@ -833,9 +803,9 @@ Minix 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: @@ -846,9 +816,9 @@ Symbian OS 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. @@ -872,13 +842,15 @@ 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 @@ -900,7 +872,8 @@ Android found in your automake folder: find /usr -name config.sub - Wrapper for pkg-config + 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: @@ -914,9 +887,9 @@ Android 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) @@ -962,9 +935,9 @@ 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 @@ -993,6 +966,7 @@ REDUCING SIZE --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) @@ -1000,6 +974,7 @@ REDUCING SIZE 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" @@ -1011,9 +986,9 @@ REDUCING SIZE .comment section). Using these techniques it is possible to create a basic HTTP-only shared - libcurl library for i386 Linux platforms that is only 106 KiB in size, and - an FTP-only library that is 108 KiB in size (as of libcurl version 7.27.0, - using gcc 4.6.3). + 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 than dynamically linking. @@ -1025,13 +1000,12 @@ REDUCING SIZE command line. Following is a list of appropriate key words: --disable-cookies !cookies - --disable-crypto-auth !HTTP\ Digest\ auth !HTTP\ proxy\ Digest\ auth --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!