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.
20 A normal unix installation is made in three or four steps (after you've
21 unpacked the source archive):
28 You probably need to be root when doing the last command.
30 If you have checked out the sources from the CVS repository, read the
31 CVS-INFO on how to proceed.
33 Get a full listing of all available configure options by invoking it like:
37 If you want to install curl in a different file hierarchy than /usr/local,
38 you need to specify that already when running configure:
40 ./configure --prefix=/path/to/curl/tree
42 If you happen to have write permission in that directory, you can do 'make
43 install' without being root. An example of this would be to make a local
44 install in your own home directory:
46 ./configure --prefix=$HOME
50 The configure script always tries to find a working SSL library unless
51 explicitly told not to. If you have OpenSSL installed in the default search
52 path for your compiler/linker, you don't need to do anything special. If
53 you have OpenSSL installed in /usr/local/ssl, you can run configure like:
55 ./configure --with-ssl
57 If you have OpenSSL installed somewhere else (for example, /opt/OpenSSL,)
58 you can run configure like this:
60 ./configure --with-ssl=/opt/OpenSSL
62 If you insist on forcing a build without SSL support, even though you may
63 have OpenSSL installed in your system, you can run configure like this:
65 ./configure --without-ssl
67 If you have OpenSSL installed, but with the libraries in one place and the
68 header files somewhere else, you have to set the LDFLAGS and CPPFLAGS
69 environment variables prior to running configure. Something like this
72 (with the Bourne shell and its clones):
74 CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
77 (with csh, tcsh and their clones):
79 env CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
82 If your SSL library was compiled with rsaref (usually for use in the United
83 States), you may also need to set:
85 LIBS=-lRSAglue -lrsaref
86 (as suggested by Doug Kaufman)
90 To force configure to use the standard cc compiler if both cc and gcc are
91 present, run configure like
97 To force a static library compile, disable the shared library creation
98 by running configure like:
100 ./configure --disable-shared
102 To tell the configure script to skip searching for thread-safe functions,
105 ./configure --disable-thread
107 To build curl with kerberos4 support enabled, curl requires the krb4 libs
108 and headers installed. You can then use a set of options to tell
109 configure where those are:
111 --with-krb4-includes[=DIR] Specify location of kerberos4 headers
112 --with-krb4-libs[=DIR] Specify location of kerberos4 libs
113 --with-krb4[=DIR] where to look for Kerberos4
115 In most cases, /usr/athena is the install prefix and then it works with
117 ./configure --with-krb4=/usr/athena
119 If you're a curl developer and use gcc, you might want to enable more
120 debug options with the --enable-debug option.
127 MingW32 (GCC-2.95) style
128 ------------------------
129 Run the 'mingw32.bat' file to get the proper environment variables
130 set, then run 'make mingw32' in the root dir.
132 If you have any problems linking libraries or finding header files, be
133 sure to verify that the provided "Makefile.m32" files use the proper
134 paths, and adjust as necessary.
138 Almost identical to the unix installation. Run the configure script in
139 the curl root with 'sh configure'. Make sure you have the sh
140 executable in /bin/ or you'll see the configure fail towards the end.
144 Microsoft command line style
145 ----------------------------
146 Run the 'vcvars32.bat' file to get the proper environment variables
147 set, then run 'nmake vc' in the root dir.
149 The vcvars32.bat file is part of the Microsoft development
153 -------------------------
154 If you use VC++, Borland or similar compilers. Include all lib source
155 files in a static lib "project" (all .c and .h files that is).
156 (you should name it libcurl or similar)
158 Make the sources in the src/ drawer be a "win32 console application"
159 project. Name it curl.
161 With VC++, add 'ws2_32.lib' to the link libs when you build curl!
162 Borland seems to do that itself magically. Of course you have to make
163 sure it links with the libcurl too!
165 For VC++ 6, there's an included Makefile.vc6 that should be possible
166 to use out-of-the-box.
168 Microsoft note: add /Zm200 to the compiler options to increase the
169 compiler's memory allocation limit, as the hugehelp.c won't compile
170 due to "too long puts string".
175 MingW32 (GCC-2.95) style
176 ------------------------
177 Run the 'mingw32.bat' file to get the proper environment variables
178 set, then run 'make mingw32-ssl' in the root dir.
180 If you have any problems linking libraries or finding header files, be
181 sure to look at the provided "Makefile.m32" files for the proper
182 paths, and adjust as necessary.
186 Haven't done, nor got any reports on how to do. It should although be
187 identical to the unix setup for the same purpose. See above.
189 Microsoft command line style
190 ----------------------------
192 Please read the OpenSSL documentation on how to compile and install
193 the OpenSSL libraries. The build process of OpenSSL generates the
194 libeay32.dll and ssleay32.dll files in the out32dll subdirectory in
195 the OpenSSL home directory. OpenSSL static libraries (libeay32.lib,
196 ssleay32.lib, RSAglue.lib) are created in the out32 subdirectory.
198 Run the 'vcvars32.bat' file to get a proper environment. The
199 vcvars32.bat file is part of the Microsoft development environment and
200 you may find it in 'C:\Program Files\Microsoft Visual Studio\vc98\bin'
201 provided that you installed Visual C/C++ 6 in the default directory.
203 Before running nmake define the OPENSSL_PATH environment variable with
204 the root/base directory of OpenSSL, for example:
206 set OPENSSL_PATH=c:\openssl-0.9.7a
208 lib/Makefile.vc6 depends on zlib (http://www.gzip.org/zlib/) as well.
209 Please read the zlib documentation on how to compile zlib. Define the
210 ZLIB_PATH environment variable to the location of zlib.h and zlib.lib,
213 set ZLIB_PATH=c:\zlib-1.1.4
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
227 Microsoft / Borland style
228 -------------------------
229 If you have OpenSSL, and want curl to take advantage of it, edit your
230 project properties to use the SSL include path, link with the SSL libs
231 and define the USE_SSLEAY symbol.
233 Using Borland C++ compiler version 5.5.1 (available as free download
235 ---------------------------------------------------------------------
239 Make sure you include the paths to curl/include and openssl/inc32 in
243 eg : -I"c:\Bcc55\include;c:\path_curl\include;c:\path_openssl\inc32"
245 Check to make sure that all of the sources listed in lib/Makefile.b32
246 are present in the /path_to_curl/lib directory. (Check the src
247 directory for missing ones.)
249 Make sure the environment variable "BCCDIR" is set to the install
250 location for the compiler eg : c:\Borland\BCC55
253 make -f /path_to_curl/lib/Makefile-ssl.b32
255 compile simplessl.c with appropriate links
257 c:\curl\docs\examples\> bcc32 -L c:\path_to_curl\lib\libcurl.lib
258 -L c:\borland\bcc55\lib\psdk\ws2_32.lib
259 -L c:\openssl\out32\libeay32.lib
260 -L c:\openssl\out32\ssleay32.lib
263 Disabling Specific Protocols:
265 The configure utility, unfortunately, is not available for the Windows
266 environment, therefore, you cannot use the various disable-protocol
267 options of the configure utility on this platform.
269 However, you can use the following defines to disable specific
272 HTTP_ONLY disables all protocols except HTTP
273 CURL_DISABLE_FTP disables FTP
274 CURL_DISABLE_LDAP disables LDAP
275 CURL_DISABLE_TELNET disables TELNET
276 CURL_DISABLE_DICT disables DICT
277 CURL_DISABLE_FILE disables FILE
278 CURL_DISABLE_GOPHER disables GOPHER
280 If you want to set any of these defines you have the following
284 - Modify lib/Makefile.vc6
285 - Add defines to Project/Settings/C/C++/General/Preprocessor Definitions
286 in the curllib.dsw/curllib.dsp Visual C++ 6 IDE project.
291 Building under OS/2 is not much different from building under unix.
303 If you want to build with OpenSSL or OpenLDAP support, you'll need to
304 download those libraries, too. Dirk Ohme has done some work to port SSL
305 libraries under OS/2, but it looks like he doesn't care about emx. You'll
306 find his patches on: http://come.to/Dirk_Ohme
308 If during the linking you get an error about _errno being an undefined
309 symbol referenced from the text segment, you need to add -D__ST_MT_ERRNO__
312 If everything seems to work fine but there's no curl.exe, you need to add
313 -Zexe to your linker flags.
315 If you're getting huge binaries, probably your makefiles have the -g in
320 (The VMS section is in whole contributed by the friendly Nico Baggus)
322 Curl seems to work with FTP & HTTP other protocols are not tested. (the
323 perl http/ftp testing server supplied as testing too cannot work on VMS
324 because vms has no concept of fork(). [ I tried to give it a whack, but
327 SSL stuff has not been ported.
329 Telnet has about the same issues as for Win32. When the changes for Win32
330 are clear maybe they'll work for VMS too. The basic problem is that select
331 ONLY works for sockets.
333 Marked instances of fopen/[f]stat that might become a problem, especially
334 for non stream files. In this regard, the files opened for writing will be
335 created stream/lf and will thus be safe. Just keep in mind that non-binary
336 read/wring from/to files will have a records size limit of 32767 bytes
339 Stat to get the size of the files is again only safe for stream files &
340 fixed record files without implied CC.
342 -- My guess is that only allowing access to stream files is the quickest
343 way to get around the most issues. Therefore all files need to to be
344 checked to be sure they will be stream/lf before processing them. This is
345 the easiest way out, I know. The reason for this is that code that needs to
346 report the filesize will become a pain in the ass otherwise.
348 Exit status.... Well we needed something done here,
350 VMS has a structured exist status:
352 |1098|765432109876|5432109876543|210|
353 +----+------------+-------------+---+
354 |Ctrl| Facility | Error code |sev|
355 +----+------------+-------------+---+
357 With the Ctrl-bits an application can tell if part or the whole message has
358 allready been printed from the program, DCL doesn't need to print it again.
360 Facility - basicaly the program ID. A code assigned to the program
361 the name can be fetched from external or internal message libraries
362 Errorcode - the errodes assigned by the application
363 Sev. - severity: Even = error, off = non error
371 This all presents itself with:
372 %<FACILITY>-<SeV>-<Errorname>, <Error message>
374 See also the src/curlmsg.msg file, it has the source for the messages In
375 src/main.c a section is devoted to message status values, the globalvalues
376 create symbols with certain values, referenced from a compiled message
377 file. Have all exit function use a exit status derived from a translation
378 table with the compiled message codes.
380 This was all compiled with:
382 Compaq C V6.2-003 on OpenVMS Alpha V7.1-1H2
384 So far for porting notes as of:
390 (This section was graciously brought to us by David Bentham)
392 As QNX is targetted for resource constrained environments, the QNX headers
393 set conservative limits. This includes the FD_SETSIZE macro, set by default
394 to 32. Socket descriptors returned within the CURL library may exceed this,
395 resulting in memory faults/SIGSEGV crashes when passed into select(..)
396 calls using fd_set macros.
398 A good all-round solution to this is to override the default when building
399 libcurl, by overriding CFLAGS during configure, example
400 # configure CFLAGS='-DFD_SETSIZE=64 -g -O2'
405 (This section was graciously brought to us by Jim Duey, 23-oct-2001)
407 Download and unpack the cURL package. Version should be 7.9.1 or later.
409 'cd' to the new directory. (ie. curl-7.9.1-pre4)
411 Set environment variables to point to the cross-compile toolchain and call
412 configure with any options you need. Be sure and specify the '--host' and
413 '--build' parameters at configuration time. The following script is an
414 example of cross-compiling for the IBM 405GP PowerPC processor using the
415 toolchain from MonteVista for Hardhat Linux.
421 export PATH=$PATH:/opt/hardhat/devkit/ppc/405/bin
422 export CPPFLAGS="-I/opt/hardhat/devkit/ppc/405/target/usr/include"
426 export RANLIB=ppc_405-ranlib
427 export CC=ppc_405-gcc
430 configure --target=powerpc-hardhat-linux \
431 --host=powerpc-hardhat-linux \
432 --build=i586-pc-linux-gnu \
433 --prefix=/opt/hardhat/devkit/ppc/405/target/usr/local \
434 --exec-prefix=/usr/local
438 The '--prefix' parameter specifies where cURL will be installed. If
439 'configure' completes successfully, do 'make' and 'make install' as usual.
443 The library can be cross-compiled using gccsdk as follows:
445 CC=riscos-gcc AR=riscos-ar RANLIB='riscos-ar -s' ./configure \
446 --host=arm-riscos-aof --without-random --disable-shared
449 where riscos-gcc and riscos-ar are links to the gccsdk tools.
450 You can then link your program with curl/lib/.libs/libcurl.a
455 (This section was graciously brought to us by Diego Casorran)
457 To build cURL/libcurl on AmigaOS just type 'make amiga' ...
459 What you need is: (not tested with others versions)
461 GeekGadgets / gcc 2.95.3 (http://www.geekgadgets.org/)
463 AmiTCP SDK v4.3 (http://www.aminet.net/comm/tcp/AmiTCP-SDK-4.3.lha)
465 Native Developer Kit (http://www.amiga.com/3.9/download/NDK3.9.lha)
467 As no ixemul.library is required you will be able to build it for
468 WarpOS/PowerPC (not tested by me), as well a MorphOS version should be
469 possible with no problems.
471 To enable SSL support, you need a OpenSSL native version (without ixemul),
472 you can find a precompiled package at http://amiga.sourceforge.net/OpenSSL/
477 This is a probably incomplete list of known hardware and operating systems
478 that curl has been compiled for. If you know a system curl compiles and
479 runs on, that isn't listed, please let us know!
482 - Alpha Digital UNIX v3.2
483 - Alpha FreeBSD 4.1, 4.5
484 - Alpha Linux 2.2, 2.4
487 - Alpha OpenVMS V7.1-1H2
488 - Alpha Tru64 v5.0 5.1
489 - HP-PA HP-UX 9.X 10.X 11.X
494 - Pocket PC/Win CE 3.0
495 - Power AIX 3.2.5, 4.2, 4.3.1, 4.3.2, 5.1
502 - Sparc Solaris 2.4, 2.5, 2.5.1, 2.6, 7, 8
504 - StrongARM (and other ARM) RISC OS 3.1, 4.02
505 - StrongARM Linux 2.4
506 - StrongARM NetBSD 1.4.1
512 - i386 Linux 1.3, 2.0, 2.2, 2.3, 2.4
514 - i386 Novell NetWare
519 - i386 Windows 95, 98, ME, NT, 2000
521 - i486 ncr-sysv4.3.03 (NCR MP-RAS)
526 - m88k dg-dgux5.4R3.00
528 - XScale/PXA250 Linux 2.4
533 You'll find OpenSSL information at:
535 http://www.openssl.org
541 You'll find MingW32 and Cygwin information at:
548 You'll find OpenLDAP information at:
550 http://www.openldap.org