5 \___|\___/|_| \_\_____|
9 Installing Binary Packages
10 ==========================
12 Lots of people download binary distributions of curl and libcurl. This
13 document does not describe how to install curl or libcurl using such a
14 binary package. This document describes how to compile, build and install
15 curl and libcurl from source code.
19 A normal unix installation is made in three or four steps (after you've
20 unpacked the source archive):
27 You probably need to be root when doing the last command.
29 If you have checked out the sources from the CVS repository, read the
30 CVS-INFO on how to proceed.
32 Get a full listing of all available configure options by invoking it like:
36 If you want to install curl in a different file hierarchy than /usr/local,
37 you need to specify that already when running configure:
39 ./configure --prefix=/path/to/curl/tree
41 If you happen to have write permission in that directory, you can do 'make
42 install' without being root. An example of this would be to make a local
43 install in your own home directory:
45 ./configure --prefix=$HOME
49 The configure script always tries to find a working SSL library unless
50 explicitly told not to. If you have OpenSSL installed in the default search
51 path for your compiler/linker, you don't need to do anything special. If
52 you have OpenSSL installed in /usr/local/ssl, you can run configure like:
54 ./configure --with-ssl
56 If you have OpenSSL installed somewhere else (for example, /opt/OpenSSL,)
57 you can run configure like this:
59 ./configure --with-ssl=/opt/OpenSSL
61 If you insist on forcing a build without SSL support, even though you may
62 have OpenSSL installed in your system, you can run configure like this:
64 ./configure --without-ssl
66 If you have OpenSSL installed, but with the libraries in one place and the
67 header files somewhere else, you have to set the LDFLAGS and CPPFLAGS
68 environment variables prior to running configure. Something like this
71 (with the Bourne shell and its clones):
73 CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
76 (with csh, tcsh and their clones):
78 env CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
81 If you have shared SSL libs installed in a directory where your run-time
82 linker doesn't find them (which usually causes configure failures), you can
83 provide the -R option to ld on some operating systems to set a hard-coded
84 path to the run-time linker:
86 LDFLAGS=-R/usr/local/ssl/lib ./configure --with-ssl
88 Another option to the previous trick, is to set LD_LIBRARY_PATH or edit the
91 If your SSL library was compiled with rsaref (this was common in the past
92 when used in the United States), you may also need to set:
94 LIBS=-lRSAglue -lrsaref
95 (as suggested by Doug Kaufman)
99 To force configure to use the standard cc compiler if both cc and gcc are
100 present, run configure like
104 env CC=cc ./configure
106 To force a static library compile, disable the shared library creation
107 by running configure like:
109 ./configure --disable-shared
111 To tell the configure script to skip searching for thread-safe functions,
114 ./configure --disable-thread
116 To build curl with kerberos4 support enabled, curl requires the krb4 libs
117 and headers installed. You can then use a set of options to tell
118 configure where those are:
120 --with-krb4-includes[=DIR] Specify location of kerberos4 headers
121 --with-krb4-libs[=DIR] Specify location of kerberos4 libs
122 --with-krb4[=DIR] where to look for Kerberos4
124 In most cases, /usr/athena is the install prefix and then it works with
126 ./configure --with-krb4=/usr/athena
128 If you're a curl developer and use gcc, you might want to enable more
129 debug options with the --enable-debug option.
131 curl can be built to use a whole range of libraries to provide various
132 useful services, and configure will try to auto-detect a decent
133 default. But if you want to alter it, you can select how to deal with
134 each individual library.
136 To build with GnuTLS support instead of OpenSSL for SSL/TLS, note that
137 you need to use both --without-ssl and --with-gnutls.
139 To build with yassl support instead of OpenSSL or GunTLS, you must build
140 yassl with its OpenSSL emulation enabled and point to that directory root
141 with configure --with-ssl.
143 To build with NSS support instead of OpenSSL for SSL/TLS, note that
144 you need to use both --without-ssl and --with-nss.
153 Run the 'mingw32.bat' file to get the proper environment variables set,
154 then run 'make mingw32' in the root dir. Use 'make mingw32-ssl' to build
157 If you have any problems linking libraries or finding header files, be sure
158 to verify that the provided "Makefile.m32" files use the proper paths, and
159 adjust as necessary. It is also possible to override these paths with
160 environment variables, for example:
162 set ZLIB_PATH=c:\zlib-1.2.3
163 set OPENSSL_PATH=c:\openssl-0.9.8d
164 set LIBSSH2_PATH=c:\libssh2-0.15
166 ATTENTION: if you want to build with libssh2 support you have to use latest
167 sources fetched from CVS - the current 0.14 release will NOT work!
168 Use 'make mingw32-ssh2-ssl' to build curl with SSH2 and SSL enabled.
173 Almost identical to the unix installation. Run the configure script in the
174 curl root with 'sh configure'. Make sure you have the sh executable in
175 /bin/ or you'll see the configure fail towards the end.
182 See the separate INSTALL.devcpp file for details.
184 MSVC from command line
185 ----------------------
187 Run the 'vcvars32.bat' file to get a proper environment. The
188 vcvars32.bat file is part of the Microsoft development environment and
189 you may find it in 'C:\Program Files\Microsoft Visual Studio\vc98\bin'
190 provided that you installed Visual C/C++ 6 in the default directory.
192 Then run 'nmake vc' in curl's root directory.
194 If you want to compile with zlib support, you will need to build
195 zlib (http://www.gzip.org/zlib/) as well. Please read the zlib
196 documentation on how to compile zlib. Define the ZLIB_PATH environment
197 variable to the location of zlib.h and zlib.lib, for example:
199 set ZLIB_PATH=c:\zlib-1.2.3
201 Then run 'nmake vc-zlib' in curl's root directory.
203 If you want to compile with SSL support you need the OpenSSL package.
204 Please read the OpenSSL documentation on how to compile and install
205 the OpenSSL libraries. The build process of OpenSSL generates the
206 libeay32.dll and ssleay32.dll files in the out32dll subdirectory in
207 the OpenSSL home directory. OpenSSL static libraries (libeay32.lib,
208 ssleay32.lib, RSAglue.lib) are created in the out32 subdirectory.
210 Before running nmake define the OPENSSL_PATH environment variable with
211 the root/base directory of OpenSSL, for example:
213 set OPENSSL_PATH=c:\openssl-0.9.8d
215 Then run 'nmake vc-ssl' or 'nmake vc-ssl-dll' in curl's root
216 directory. 'nmake vc-ssl' will create a libcurl static and dynamic
217 libraries in the lib subdirectory, as well as a statically linked
218 version of curl.exe in the src subdirectory. This statically linked
219 version is a standalone executable not requiring any DLL at
220 runtime. This make method requires that you have the static OpenSSL
221 libraries available in OpenSSL's out32 subdirectory.
222 'nmake vc-ssl-dll' creates the libcurl dynamic library and
223 links curl.exe against libcurl and OpenSSL dynamically.
224 This executable requires libcurl.dll and the OpenSSL DLLs
226 Run 'nmake vc-ssl-zlib' to build with both ssl and zlib support.
229 ---------------------
233 Make sure you include the paths to curl/include and openssl/inc32 in
236 eg : -I"c:\Bcc55\include;c:\path_curl\include;c:\path_openssl\inc32"
238 Check to make sure that all of the sources listed in lib/Makefile.b32
239 are present in the /path_to_curl/lib directory. (Check the src
240 directory for missing ones.)
242 Make sure the environment variable "BCCDIR" is set to the install
243 location for the compiler eg : c:\Borland\BCC55
246 make -f /path_to_curl/lib/Makefile-ssl.b32
248 compile simplessl.c with appropriate links
250 c:\curl\docs\examples\> bcc32 -L c:\path_to_curl\lib\libcurl.lib
251 -L c:\borland\bcc55\lib\psdk\ws2_32.lib
252 -L c:\openssl\out32\libeay32.lib
253 -L c:\openssl\out32\ssleay32.lib
260 If you use VC++, Borland or similar compilers. Include all lib source
261 files in a static lib "project" (all .c and .h files that is).
262 (you should name it libcurl or similar)
264 Make the sources in the src/ drawer be a "win32 console application"
265 project. Name it curl.
267 For VC++ 6, there's an included Makefile.vc6 that should be possible
268 to use out-of-the-box.
271 Disabling Specific Protocols in Win32 builds
272 --------------------------------------------
274 The configure utility, unfortunately, is not available for the Windows
275 environment, therefore, you cannot use the various disable-protocol
276 options of the configure utility on this platform.
278 However, you can use the following defines to disable specific
281 HTTP_ONLY disables all protocols except HTTP
282 CURL_DISABLE_FTP disables FTP
283 CURL_DISABLE_LDAP disables LDAP
284 CURL_DISABLE_TELNET disables TELNET
285 CURL_DISABLE_DICT disables DICT
286 CURL_DISABLE_FILE disables FILE
288 If you want to set any of these defines you have the following
292 - Modify lib/Makefile.vc6
293 - Add defines to Project/Settings/C/C++/General/Preprocessor Definitions
294 in the curllib.dsw/curllib.dsp Visual C++ 6 IDE project.
297 Important static libcurl usage note
298 -----------------------------------
300 When building an application that uses the static libcurl library, you must
301 add '-DCURL_STATICLIB' to your CFLAGS. Otherwise the linker will look for
302 dynamic import symbols.
307 Building under OS/2 is not much different from building under unix.
319 If you want to build with OpenSSL or OpenLDAP support, you'll need to
320 download those libraries, too. Dirk Ohme has done some work to port SSL
321 libraries under OS/2, but it looks like he doesn't care about emx. You'll
322 find his patches on: http://come.to/Dirk_Ohme
324 If during the linking you get an error about _errno being an undefined
325 symbol referenced from the text segment, you need to add -D__ST_MT_ERRNO__
328 If everything seems to work fine but there's no curl.exe, you need to add
329 -Zexe to your linker flags.
331 If you're getting huge binaries, probably your makefiles have the -g in
337 (The VMS section is in whole contributed by the friendly Nico Baggus)
339 Curl seems to work with FTP & HTTP other protocols are not tested. (the
340 perl http/ftp testing server supplied as testing too cannot work on VMS
341 because vms has no concept of fork(). [ I tried to give it a whack, but
344 SSL stuff has not been ported.
346 Telnet has about the same issues as for Win32. When the changes for Win32
347 are clear maybe they'll work for VMS too. The basic problem is that select
348 ONLY works for sockets.
350 Marked instances of fopen/[f]stat that might become a problem, especially
351 for non stream files. In this regard, the files opened for writing will be
352 created stream/lf and will thus be safe. Just keep in mind that non-binary
353 read/wring from/to files will have a records size limit of 32767 bytes
356 Stat to get the size of the files is again only safe for stream files &
357 fixed record files without implied CC.
359 -- My guess is that only allowing access to stream files is the quickest
360 way to get around the most issues. Therefore all files need to to be
361 checked to be sure they will be stream/lf before processing them. This is
362 the easiest way out, I know. The reason for this is that code that needs to
363 report the filesize will become a pain in the ass otherwise.
365 Exit status.... Well we needed something done here,
367 VMS has a structured exist status:
369 |1098|765432109876|5432109876543|210|
370 +----+------------+-------------+---+
371 |Ctrl| Facility | Error code |sev|
372 +----+------------+-------------+---+
374 With the Ctrl-bits an application can tell if part or the whole message has
375 already been printed from the program, DCL doesn't need to print it again.
377 Facility - basically the program ID. A code assigned to the program
378 the name can be fetched from external or internal message libraries
379 Errorcode - the errodes assigned by the application
380 Sev. - severity: Even = error, off = non error
388 This all presents itself with:
389 %<FACILITY>-<SeV>-<Errorname>, <Error message>
391 See also the src/curlmsg.msg file, it has the source for the messages In
392 src/main.c a section is devoted to message status values, the globalvalues
393 create symbols with certain values, referenced from a compiled message
394 file. Have all exit function use a exit status derived from a translation
395 table with the compiled message codes.
397 This was all compiled with:
399 Compaq C V6.2-003 on OpenVMS Alpha V7.1-1H2
401 So far for porting notes as of:
408 (This section was graciously brought to us by David Bentham)
410 As QNX is targeted for resource constrained environments, the QNX headers
411 set conservative limits. This includes the FD_SETSIZE macro, set by default
412 to 32. Socket descriptors returned within the CURL library may exceed this,
413 resulting in memory faults/SIGSEGV crashes when passed into select(..)
414 calls using fd_set macros.
416 A good all-round solution to this is to override the default when building
417 libcurl, by overriding CFLAGS during configure, example
418 # configure CFLAGS='-DFD_SETSIZE=64 -g -O2'
423 The library can be cross-compiled using gccsdk as follows:
425 CC=riscos-gcc AR=riscos-ar RANLIB='riscos-ar -s' ./configure \
426 --host=arm-riscos-aof --without-random --disable-shared
429 where riscos-gcc and riscos-ar are links to the gccsdk tools.
430 You can then link your program with curl/lib/.libs/libcurl.a
435 (This section was graciously brought to us by Diego Casorran)
437 To build cURL/libcurl on AmigaOS just type 'make amiga' ...
439 What you need is: (not tested with others versions)
441 GeekGadgets / gcc 2.95.3 (http://www.geekgadgets.org/)
443 AmiTCP SDK v4.3 (http://www.aminet.net/comm/tcp/AmiTCP-SDK-4.3.lha)
445 Native Developer Kit (http://www.amiga.com/3.9/download/NDK3.9.lha)
447 As no ixemul.library is required you will be able to build it for
448 WarpOS/PowerPC (not tested by me), as well a MorphOS version should be
449 possible with no problems.
451 To enable SSL support, you need a OpenSSL native version (without ixemul),
452 you can find a precompiled package at http://amiga.sourceforge.net/OpenSSL/
457 To compile curl.nlm / libcurl.nlm you need:
458 - either any gcc / nlmconv, or CodeWarrior 7 PDK 4 or later.
459 - gnu make and awk running on the platform you compile on;
460 native Win32 versions can be downloaded from:
461 http://www.gknw.net/development/prgtools/
462 - recent Novell LibC SDK available from:
463 http://developer.novell.com/ndk/libc.htm
464 - optional zlib sources (at the moment only dynamic linking with zlib.imp);
465 sources with NetWare Makefile can be obtained from:
466 http://www.gknw.net/mirror/zlib/
467 - optional OpenSSL sources (version 0.9.8 or later which builds with BSD);
469 Set a search path to your compiler, linker and tools; on Linux make
470 sure that the var OSTYPE contains the string 'linux'; and then type
471 'make netware' from the top source directory; other tagets available
472 are 'netware-ssl', 'netware-ssl-zlib', 'netware-zlib' and 'netware-ares';
473 if you need other combinations you can control the build with the
474 environment variables WITH_SSL, WITH_ZLIB, WITH_ARES and ENABLE_IPV6.
475 I found on some Linux systems (RH9) that OS detection didnt work although
476 a 'set | grep OSTYPE' shows the var present and set; I simply overwrote it
477 with 'OSTYPE=linux-rh9-gnu' and the detection in the Makefile worked...
478 Any help in testing appreciated!
479 Builds automatically created 8 times a day from current CVS are here:
480 http://www.gknw.net/mirror/curl/autobuilds/
481 the status of these builds can be viewed at the autobuild table:
482 http://curl.haxx.se/auto/
487 curl does not use the eCos build system, so you must first build eCos
488 separately, then link curl to the resulting eCos library. Here's a sample
489 configure line to do so on an x86 Linux box targeting x86:
491 GCCLIB=`gcc -print-libgcc-file-name` && \
492 CFLAGS="-D__ECOS=1 -nostdinc -I$ECOS_INSTALL/include \
493 -I`dirname $GCCLIB`/include" \
494 LDFLAGS="-nostdlib -Wl,--gc-sections -Wl,-static \
495 -L$ECOS_INSTALL/lib -Ttarget.ld -ltarget" \
496 ./configure --host=i386 --disable-shared \
497 --without-ssl --without-zlib --disable-manual --disable-ldap
499 In most cases, eCos users will be using libcurl from within a custom
500 embedded application. Using the standard 'curl' executable from
501 within eCos means facing the limitation of the standard eCos C
502 startup code which does not allow passing arguments in main(). To
503 run 'curl' from eCos and have it do something useful, you will need
504 to either modify the eCos startup code to pass in some arguments, or
505 modify the curl application itself to retrieve its arguments from
506 some location set by the bootloader or hard-code them.
508 Something like the following patch could be used to hard-code some
509 arguments. The MTAB_ENTRY line mounts a RAM disk as the root filesystem
510 (without mounting some kind of filesystem, eCos errors out all file
511 operations which curl does not take to well). The next section synthesizes
512 some command-line arguments for curl to use, in this case to direct curl
513 to read further arguments from a file. It then creates that file on the
514 RAM disk and places within it a URL to download: a file: URL that
515 just happens to point to the configuration file itself. The results
516 of running curl in this way is the contents of the configuration file
517 printed to the console.
519 --- src/main.c 19 Jul 2006 19:09:56 -0000 1.363
520 +++ src/main.c 24 Jul 2006 21:37:23 -0000
521 @@ -4286,11 +4286,31 @@
526 +#include <cyg/fileio/fileio.h>
527 +MTAB_ENTRY( testfs_mte1,
534 int main(int argc, char *argv[])
537 struct Configurable config;
539 + char *args[] = {"ecos-curl", "-K", "curlconf.txt"};
541 + argc = sizeof(args)/sizeof(args[0]);
544 + f = fopen("curlconf.txt", "w");
546 + fprintf(f, "--url file:curlconf.txt");
550 memset(&config, 0, sizeof(struct Configurable));
552 config.errors = stderr; /* default errors to stderr */
557 curl can be compiled on Minix 3 using gcc (ACK has a few problems due
558 to mismatched headers and libraries as of ver. 3.1.2). The gcc and bash
559 packages must be installed first. The default heap size allocated to
560 bash is inadequate for running configure and will result in out of memory
561 errors. Increase it with the command:
563 chmem =2048000 /usr/local/bin/bash
565 Make sure gcc and bash are in the PATH then configure curl with a
568 ./configure GREP=/usr/bin/grep AR=/usr/gnu/bin/gar --disable-ldap
570 Then simply run 'make'.
575 (This section was graciously brought to us by Jim Duey, with additions by
578 Download and unpack the cURL package. Version should be 7.9.1 or later.
580 'cd' to the new directory. (e.g. cd curl-7.12.3)
582 Set environment variables to point to the cross-compile toolchain and call
583 configure with any options you need. Be sure and specify the '--host' and
584 '--build' parameters at configuration time. The following script is an
585 example of cross-compiling for the IBM 405GP PowerPC processor using the
586 toolchain from MonteVista for Hardhat Linux.
592 export PATH=$PATH:/opt/hardhat/devkit/ppc/405/bin
593 export CPPFLAGS="-I/opt/hardhat/devkit/ppc/405/target/usr/include"
597 export RANLIB=ppc_405-ranlib
598 export CC=ppc_405-gcc
601 ./configure --target=powerpc-hardhat-linux \
602 --host=powerpc-hardhat-linux \
603 --build=i586-pc-linux-gnu \
604 --prefix=/opt/hardhat/devkit/ppc/405/target/usr/local \
605 --exec-prefix=/usr/local
609 You may also need to provide a parameter like '--with-random=/dev/urandom'
610 to configure as it cannot detect the presence of a random number
611 generating device for a target system. The '--prefix' parameter
612 specifies where cURL will be installed. If 'configure' completes
613 successfully, do 'make' and 'make install' as usual.
615 In some cases, you may be able to simplify the above commands to as
618 ./configure --host=ARCH-OS
623 There are a number of configure options that can be used to reduce the
624 size of libcurl for embedded applications where binary size is an
625 important factor. First, be sure to set the CFLAGS variable when
626 configuring with any relevant compiler optimization flags to reduce the
627 size of the binary. For gcc, this would mean at minimum the -Os option
628 and probably the -march=X option as well, e.g.:
630 ./configure CFLAGS='-Os' ...
632 Be sure to specify as many --disable- and --without- flags on the configure
633 command-line as you can to disable all the libcurl features that you
634 know your application is not going to need. Besides specifying the
635 --disable-PROTOCOL flags for all the types of URLs your application
636 will not use, here are some other flags that can reduce the size of the
639 --disable-ares (disables support for the ARES DNS library)
640 --disable-cookies (disables support for HTTP cookies)
641 --disable-crypto-auth (disables HTTP cryptographic authentication)
642 --disable-ipv6 (disables support for IPv6)
643 --disable-verbose (eliminates debugging strings and error code strings)
644 --enable-hidden-symbols (eliminates unneeded symbols in the shared library)
645 --without-libidn (disables support for the libidn DNS library)
646 --without-ssl (disables support for SSL/TLS)
647 --without-zlib (disables support for on-the-fly decompression)
649 The GNU linker has a number of options to reduce the size of the libcurl
650 dynamic libraries on some platforms even further. Specify them by giving
651 the options -Wl,-Bsymbolic and -Wl,-s on the gcc command-line.
652 Be sure also to strip debugging symbols from your binaries after
653 compiling using 'strip' (or the appropriate variant if cross-compiling).
654 If space is really tight, you may be able to remove some unneeded
655 sections of the shared library using the -R option to objcopy (e.g. the
658 Using these techniques it is possible to create an HTTP-only shared
659 libcurl library for i386 Linux platforms that is less than 90 KB in
660 size (as of version 7.15.4).
662 You may find that statically linking libcurl to your application will
663 result in a lower total size.
668 This is a probably incomplete list of known hardware and operating systems
669 that curl has been compiled for. If you know a system curl compiles and
670 runs on, that isn't listed, please let us know!
673 - Alpha Digital UNIX v3.2
674 - Alpha FreeBSD 4.1, 4.5
675 - Alpha Linux 2.2, 2.4
678 - Alpha OpenVMS V7.1-1H2
679 - Alpha Tru64 v5.0 5.1
680 - HP-PA HP-UX 9.X 10.X 11.X
685 - Pocket PC/Win CE 3.0
686 - Power AIX 3.2.5, 4.2, 4.3.1, 4.3.2, 5.1, 5.2
691 - SuperH4 Linux 2.6.X
694 - Sparc Solaris 2.4, 2.5, 2.5.1, 2.6, 7, 8, 9, 10
696 - StrongARM (and other ARM) RISC OS 3.1, 4.02
697 - StrongARM/ARM7/ARM9 Linux 2.4, 2.6
698 - StrongARM NetBSD 1.4.1
707 - i386 Linux 1.3, 2.0, 2.2, 2.3, 2.4, 2.6
710 - i386 Novell NetWare
715 - i386 Windows 95, 98, ME, NT, 2000, XP, 2003
717 - i486 ncr-sysv4.3.03 (NCR MP-RAS)
722 - m88k dg-dgux5.4R3.00
724 - XScale/PXA250 Linux 2.4
729 OpenSSL http://www.openssl.org
730 MingW http://www.mingw.org
731 OpenLDAP http://www.openldap.org
732 Zlib http://www.gzip.org/zlib/
733 libssh2 http://www.libssh2.org