Daniel Cater added the mentioning of CURL_DISABLE_TFTP
[platform/upstream/curl.git] / docs / INSTALL
1                                   _   _ ____  _
2                               ___| | | |  _ \| |
3                              / __| | | | |_) | |
4                             | (__| |_| |  _ <| |___
5                              \___|\___/|_| \_\_____|
6
7                                 How To Compile
8
9 Installing Binary Packages
10 ==========================
11
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.
16
17 UNIX
18 ====
19    A normal unix installation is made in three or four steps (after you've
20    unpacked the source archive):
21
22         ./configure
23         make
24         make test (optional)
25         make install
26
27    You probably need to be root when doing the last command.
28
29    If you have checked out the sources from the CVS repository, read the
30    CVS-INFO on how to proceed.
31
32    Get a full listing of all available configure options by invoking it like:
33
34         ./configure --help
35
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:
38
39         ./configure --prefix=/path/to/curl/tree
40
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:
44
45         ./configure --prefix=$HOME
46         make
47         make install
48
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:
53
54         ./configure --with-ssl
55
56    If you have OpenSSL installed somewhere else (for example, /opt/OpenSSL,)
57    you can run configure like this:
58
59         ./configure --with-ssl=/opt/OpenSSL
60
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:
63
64         ./configure --without-ssl
65
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
69    should work:
70
71      (with the Bourne shell and its clones):
72
73        CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
74            ./configure
75
76      (with csh, tcsh and their clones):
77
78        env CPPFLAGS="-I/path/to/ssl/include" LDFLAGS="-L/path/to/ssl/lib" \
79        ./configure
80
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:
85
86         LDFLAGS=-R/usr/local/ssl/lib ./configure --with-ssl
87
88    Another option to the previous trick, is to set LD_LIBRARY_PATH or edit the
89    /etc/ld.so.conf file.
90
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:
93
94      LIBS=-lRSAglue -lrsaref
95      (as suggested by Doug Kaufman)
96
97    MORE OPTIONS
98
99      To force configure to use the standard cc compiler if both cc and gcc are
100      present, run configure like
101
102        CC=cc ./configure
103          or
104        env CC=cc ./configure
105
106      To force a static library compile, disable the shared library creation
107      by running configure like:
108
109        ./configure --disable-shared
110
111      To tell the configure script to skip searching for thread-safe functions,
112      add an option like:
113
114        ./configure --disable-thread
115
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:
119
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
123
124      In most cases, /usr/athena is the install prefix and then it works with
125
126        ./configure --with-krb4=/usr/athena
127
128      If you're a curl developer and use gcc, you might want to enable more
129      debug options with the --enable-debug option.
130
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.
135
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.
138
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.
142
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.
145
146
147 Win32
148 =====
149
150    Building Windows DLLs and C run-time (CRT) linkage issues
151    ---------------------------------------------------------
152
153    As a general rule, building a DLL with static CRT linkage is highly
154    discouraged, and intermixing CRTs in the same app is something to
155    avoid at any cost.
156
157    Reading and comprehension of Microsoft Knowledge Base articles
158    KB94248 and KB140584 is a must for any Windows developer. Especially
159    important is full understanding if you are not going to follow the
160    advice given above.
161
162    KB94248  - How To Use the C Run-Time
163               http://support.microsoft.com/kb/94248/en-us
164
165    KB140584 - How to link with the correct C Run-Time (CRT) library
166               http://support.microsoft.com/kb/140584/en-us
167
168    If your app is misbehaving in some strange way, or it is suffering
169    from memory corruption, before asking for further help, please try
170    first to rebuild every single library your app uses as well as your
171    app using the debug multithreaded dynamic C runtime.
172
173    MingW32
174    -------
175
176    Run the 'mingw32.bat' file to get the proper environment variables set,
177    then run 'make mingw32' in the root dir. Use 'make mingw32-ssl' to build
178    curl SSL enabled.
179
180    If you have any problems linking libraries or finding header files, be sure
181    to verify that the provided "Makefile.m32" files use the proper paths, and
182    adjust as necessary. It is also possible to override these paths with 
183    environment variables, for example:
184
185      set ZLIB_PATH=c:\zlib-1.2.3
186      set OPENSSL_PATH=c:\openssl-0.9.8d
187      set LIBSSH2_PATH=c:\libssh2-0.15
188
189    ATTENTION: if you want to build with libssh2 support you have to use latest
190    sources fetched from CVS - the current 0.14 release will NOT work!
191    Use 'make mingw32-ssh2-ssl' to build curl with SSH2 and SSL enabled.
192
193    Cygwin
194    ------
195
196    Almost identical to the unix installation. Run the configure script in the
197    curl root with 'sh configure'. Make sure you have the sh executable in
198    /bin/ or you'll see the configure fail towards the end.
199
200    Run 'make'
201
202    Dev-Cpp
203    -------
204
205    See the separate INSTALL.devcpp file for details.
206
207    MSVC from command line
208    ----------------------
209
210    Run the 'vcvars32.bat' file to get a proper environment. The
211    vcvars32.bat file is part of the Microsoft development environment and
212    you may find it in 'C:\Program Files\Microsoft Visual Studio\vc98\bin'
213    provided that you installed Visual C/C++ 6 in the default directory.
214
215    Then run 'nmake vc' in curl's root directory.
216
217    If you want to compile with zlib support, you will need to build
218    zlib (http://www.gzip.org/zlib/) as well. Please read the zlib
219    documentation on how to compile zlib. Define the ZLIB_PATH environment
220    variable to the location of zlib.h and zlib.lib, for example:
221
222      set ZLIB_PATH=c:\zlib-1.2.3
223
224    Then run 'nmake vc-zlib' in curl's root directory.
225
226    If you want to compile with SSL support you need the OpenSSL package.
227    Please read the OpenSSL documentation on how to compile and install
228    the OpenSSL libraries.  The build process of OpenSSL generates the
229    libeay32.dll and ssleay32.dll files in the out32dll subdirectory in
230    the OpenSSL home directory.  OpenSSL static libraries (libeay32.lib,
231    ssleay32.lib, RSAglue.lib) are created in the out32 subdirectory.
232
233    Before running nmake define the OPENSSL_PATH environment variable with
234    the root/base directory of OpenSSL, for example:
235
236      set OPENSSL_PATH=c:\openssl-0.9.8d
237
238    Then run 'nmake vc-ssl' or 'nmake vc-ssl-dll' in curl's root
239    directory.  'nmake vc-ssl' will create a libcurl static and dynamic
240    libraries in the lib subdirectory, as well as a statically linked
241    version of curl.exe in the src subdirectory.  This statically linked
242    version is a standalone executable not requiring any DLL at
243    runtime. This make method requires that you have the static OpenSSL
244    libraries available in OpenSSL's out32 subdirectory.
245    'nmake vc-ssl-dll' creates the libcurl dynamic library and
246    links curl.exe against libcurl and OpenSSL dynamically.
247    This executable requires libcurl.dll and the OpenSSL DLLs
248    at runtime.
249    Run 'nmake vc-ssl-zlib' to build with both ssl and zlib support.
250
251    Borland C++ compiler
252    ---------------------
253
254    compile openssl
255
256    Make sure you include the paths to curl/include and openssl/inc32 in
257    your bcc32.cnf file
258
259    eg : -I"c:\Bcc55\include;c:\path_curl\include;c:\path_openssl\inc32"
260
261    Check to make sure that all of the sources listed in lib/Makefile.b32
262    are present in the /path_to_curl/lib directory. (Check the src
263    directory for missing ones.)
264
265    Make sure the environment variable "BCCDIR" is set to the install
266    location for the compiler eg : c:\Borland\BCC55
267
268    command line:
269    make -f /path_to_curl/lib/Makefile-ssl.b32
270
271    compile simplessl.c with appropriate links
272
273    c:\curl\docs\examples\> bcc32 -L c:\path_to_curl\lib\libcurl.lib
274                                  -L c:\borland\bcc55\lib\psdk\ws2_32.lib
275                                  -L c:\openssl\out32\libeay32.lib
276                                  -L c:\openssl\out32\ssleay32.lib
277                                  simplessl.c
278
279
280    MSVC IDE
281    --------
282
283    If you use VC++, Borland or similar compilers. Include all lib source
284    files in a static lib "project" (all .c and .h files that is).
285    (you should name it libcurl or similar)
286
287    Make the sources in the src/ drawer be a "win32 console application"
288    project. Name it curl.
289
290    For VC++ 6, there's an included Makefile.vc6 that should be possible
291    to use out-of-the-box.
292
293
294    Disabling Specific Protocols in Win32 builds
295    --------------------------------------------
296
297    The configure utility, unfortunately, is not available for the Windows
298    environment, therefore, you cannot use the various disable-protocol
299    options of the configure utility on this platform.
300
301    However, you can use the following defines to disable specific
302    protocols:
303
304    HTTP_ONLY             disables all protocols except HTTP
305    CURL_DISABLE_FTP      disables FTP
306    CURL_DISABLE_LDAP     disables LDAP
307    CURL_DISABLE_TELNET   disables TELNET
308    CURL_DISABLE_DICT     disables DICT
309    CURL_DISABLE_FILE     disables FILE
310    CURL_DISABLE_TFTP     disables TFTP
311
312    If you want to set any of these defines you have the following
313    possibilities:
314
315    - Modify lib/setup.h
316    - Modify lib/Makefile.vc6
317    - Add defines to Project/Settings/C/C++/General/Preprocessor Definitions
318      in the curllib.dsw/curllib.dsp Visual C++ 6 IDE project.
319
320
321    Important static libcurl usage note
322    -----------------------------------
323
324    When building an application that uses the static libcurl library, you must
325    add '-DCURL_STATICLIB' to your CFLAGS.  Otherwise the linker will look for
326    dynamic import symbols.
327
328
329 IBM OS/2
330 ========
331    Building under OS/2 is not much different from building under unix.
332    You need:
333
334       - emx 0.9d
335       - GNU make
336       - GNU patch
337       - ksh
338       - GNU bison
339       - GNU file utilities
340       - GNU sed
341       - autoconf 2.13
342
343    If you want to build with OpenSSL or OpenLDAP support, you'll need to
344    download those libraries, too. Dirk Ohme has done some work to port SSL
345    libraries under OS/2, but it looks like he doesn't care about emx.  You'll
346    find his patches on: http://come.to/Dirk_Ohme
347
348    If during the linking you get an error about _errno being an undefined
349    symbol referenced from the text segment, you need to add -D__ST_MT_ERRNO__
350    in your definitions.
351
352    If everything seems to work fine but there's no curl.exe, you need to add
353    -Zexe to your linker flags.
354
355    If you're getting huge binaries, probably your makefiles have the -g in
356    CFLAGS.
357
358
359 VMS
360 ===
361    (The VMS section is in whole contributed by the friendly Nico Baggus)
362
363    Curl seems to work with FTP & HTTP other protocols are not tested.  (the
364    perl http/ftp testing server supplied as testing too cannot work on VMS
365    because vms has no concept of fork(). [ I tried to give it a whack, but
366    thats of no use.
367
368    SSL stuff has not been ported.
369
370    Telnet has about the same issues as for Win32. When the changes for Win32
371    are clear maybe they'll work for VMS too. The basic problem is that select
372    ONLY works for sockets.
373
374    Marked instances of fopen/[f]stat that might become a problem, especially
375    for non stream files. In this regard, the files opened for writing will be
376    created stream/lf and will thus be safe. Just keep in mind that non-binary
377    read/wring from/to files will have a records size limit of 32767 bytes
378    imposed.
379
380    Stat to get the size of the files is again only safe for stream files &
381    fixed record files without implied CC.
382
383    -- My guess is that only allowing access to stream files is the quickest
384    way to get around the most issues. Therefore all files need to to be
385    checked to be sure they will be stream/lf before processing them.  This is
386    the easiest way out, I know. The reason for this is that code that needs to
387    report the filesize will become a pain in the ass otherwise.
388
389    Exit status.... Well we needed something done here,
390
391    VMS has a structured exist status:
392    | 3  |       2    |     1       |  0|
393    |1098|765432109876|5432109876543|210|
394    +----+------------+-------------+---+
395    |Ctrl|  Facility  | Error code  |sev|
396    +----+------------+-------------+---+
397
398    With the Ctrl-bits an application can tell if part or the whole message has
399    already been printed from the program, DCL doesn't need to print it again.
400
401    Facility - basically the program ID. A code assigned to the program
402    the name can be fetched from external or internal message libraries
403    Errorcode - the errodes assigned by the application
404    Sev. - severity: Even = error, off = non error
405       0 = Warning
406       1 = Success
407       2 = Error
408       3 = Information
409       4 = Fatal
410       <5-7> reserved.
411
412    This all presents itself with:
413    %<FACILITY>-<SeV>-<Errorname>, <Error message>
414
415    See also the src/curlmsg.msg file, it has the source for the messages In
416    src/main.c a section is devoted to message status values, the globalvalues
417    create symbols with certain values, referenced from a compiled message
418    file. Have all exit function use a exit status derived from a translation
419    table with the compiled message codes.
420
421    This was all compiled with:
422
423       Compaq C V6.2-003 on OpenVMS Alpha V7.1-1H2
424
425    So far for porting notes as of:
426    13-jul-2001
427    N. Baggus
428
429
430 QNX
431 ===
432    (This section was graciously brought to us by David Bentham)
433
434    As QNX is targeted for resource constrained environments, the QNX headers
435    set conservative limits. This includes the FD_SETSIZE macro, set by default
436    to 32. Socket descriptors returned within the CURL library may exceed this,
437    resulting in memory faults/SIGSEGV crashes when passed into select(..)
438    calls using fd_set macros.
439
440    A good all-round solution to this is to override the default when building
441    libcurl, by overriding CFLAGS during configure, example
442    #  configure CFLAGS='-DFD_SETSIZE=64 -g -O2'
443
444
445 RISC OS
446 =======
447    The library can be cross-compiled using gccsdk as follows:
448
449         CC=riscos-gcc AR=riscos-ar RANLIB='riscos-ar -s' ./configure \
450              --host=arm-riscos-aof --without-random --disable-shared
451         make
452
453    where riscos-gcc and riscos-ar are links to the gccsdk tools.
454    You can then link your program with curl/lib/.libs/libcurl.a
455
456
457 AmigaOS
458 =======
459    (This section was graciously brought to us by Diego Casorran)
460
461    To build cURL/libcurl on AmigaOS just type 'make amiga' ...
462
463    What you need is:    (not tested with others versions)
464
465         GeekGadgets / gcc 2.95.3 (http://www.geekgadgets.org/)
466
467         AmiTCP SDK v4.3 (http://www.aminet.net/comm/tcp/AmiTCP-SDK-4.3.lha)
468
469         Native Developer Kit (http://www.amiga.com/3.9/download/NDK3.9.lha)
470
471    As no ixemul.library is required you will be able to build it for
472    WarpOS/PowerPC (not tested by me), as well a MorphOS version should be
473    possible with no problems.
474
475    To enable SSL support, you need a OpenSSL native version (without ixemul),
476    you can find a precompiled package at http://amiga.sourceforge.net/OpenSSL/
477
478
479 NetWare
480 =======
481    To compile curl.nlm / libcurl.nlm you need:
482    - either any gcc / nlmconv, or CodeWarrior 7 PDK 4 or later.
483    - gnu make and awk running on the platform you compile on;
484      native Win32 versions can be downloaded from:
485      http://www.gknw.net/development/prgtools/
486    - recent Novell LibC SDK available from:
487      http://developer.novell.com/ndk/libc.htm
488    - or recent Novell CLib SDK available from:
489      http://developer.novell.com/ndk/clib.htm
490    - optional zlib sources (static or dynamic linking with zlib.imp);
491      sources with NetWare Makefile can be obtained from:
492      http://www.gknw.net/mirror/zlib/
493    - optional OpenSSL sources (version 0.9.8 or later build with BSD sockets);
494      you can find precompiled packages at:
495      http://www.gknw.net/development/ossl/netware/
496      for CLIB-based builds OpenSSL needs to be extended to build with BSD
497      sockets (currently only a winsock-based CLIB build is supported); 
498    - optional SSH2 sources (version 0.15 or later);
499
500    Set a search path to your compiler, linker and tools; on Linux make
501    sure that the var OSTYPE contains the string 'linux'; set the var
502    NDKBASE to point to the base of your Novell NDK; and then type
503    'make netware' from the top source directory; other tagets available
504    are 'netware-ssl', 'netware-ssl-zlib', 'netware-zlib' and 'netware-ares';
505    if you need other combinations you can control the build with the
506    environment variables WITH_SSL, WITH_ZLIB, WITH_ARES, WITH_SSH2, and
507    ENABLE_IPV6; you can set LINK_STATIC=1 to link curl.nlm statically.
508    I found on some Linux systems (RH9) that OS detection didnt work although
509    a 'set | grep OSTYPE' shows the var present and set; I simply overwrote it
510    with 'OSTYPE=linux-rh9-gnu' and the detection in the Makefile worked...
511    Any help in testing appreciated!
512    Builds automatically created 8 times a day from current CVS are here:
513    http://www.gknw.net/mirror/curl/autobuilds/
514    the status of these builds can be viewed at the autobuild table:
515    http://curl.haxx.se/auto/
516
517
518 eCos
519 ====
520    curl does not use the eCos build system, so you must first build eCos
521    separately, then link curl to the resulting eCos library.  Here's a sample
522    configure line to do so on an x86 Linux box targeting x86:
523
524    GCCLIB=`gcc -print-libgcc-file-name` && \
525    CFLAGS="-D__ECOS=1 -nostdinc -I$ECOS_INSTALL/include \
526     -I`dirname $GCCLIB`/include" \
527    LDFLAGS="-nostdlib -Wl,--gc-sections -Wl,-static \
528     -L$ECOS_INSTALL/lib -Ttarget.ld -ltarget" \
529    ./configure --host=i386 --disable-shared \
530     --without-ssl --without-zlib --disable-manual --disable-ldap
531
532    In most cases, eCos users will be using libcurl from within a custom
533    embedded application.  Using the standard 'curl' executable from
534    within eCos means facing the limitation of the standard eCos C
535    startup code which does not allow passing arguments in main().  To
536    run 'curl' from eCos and have it do something useful, you will need
537    to either modify the eCos startup code to pass in some arguments, or
538    modify the curl application itself to retrieve its arguments from
539    some location set by the bootloader or hard-code them.
540
541    Something like the following patch could be used to hard-code some
542    arguments.  The MTAB_ENTRY line mounts a RAM disk as the root filesystem
543    (without mounting some kind of filesystem, eCos errors out all file
544    operations which curl does not take to well).  The next section synthesizes
545    some command-line arguments for curl to use, in this case to direct curl
546    to read further arguments from a file.  It then creates that file on the
547    RAM disk and places within it a URL to download: a file: URL that
548    just happens to point to the configuration file itself.  The results
549    of running curl in this way is the contents of the configuration file
550    printed to the console.
551
552 --- src/main.c  19 Jul 2006 19:09:56 -0000      1.363
553 +++ src/main.c  24 Jul 2006 21:37:23 -0000
554 @@ -4286,11 +4286,31 @@
555  }
556  
557  
558 +#ifdef __ECOS
559 +#include <cyg/fileio/fileio.h>
560 +MTAB_ENTRY( testfs_mte1,
561 +                   "/",
562 +                   "ramfs",
563 +                   "",
564 +                   0);
565 +#endif
566  
567  int main(int argc, char *argv[])
568  {
569    int res;
570    struct Configurable config;
571 +#ifdef __ECOS
572 +  char *args[] = {"ecos-curl", "-K", "curlconf.txt"};
573 +  FILE *f;
574 +  argc = sizeof(args)/sizeof(args[0]);
575 +  argv = args;
576 +
577 +  f = fopen("curlconf.txt", "w");
578 +  if (f) {
579 +    fprintf(f, "--url file:curlconf.txt");
580 +    fclose(f);
581 +  }
582 +#endif
583    memset(&config, 0, sizeof(struct Configurable));
584  
585    config.errors = stderr; /* default errors to stderr */
586
587
588 Minix
589 =====
590    curl can be compiled on Minix 3 using gcc or ACK (starting with
591    ver. 3.1.3).  The gcc and bash packages must be installed first.
592    The default heap size allocated to bash is inadequate for running
593    configure and will result in out of memory errors.  Increase it with
594    the command:
595
596      chmem =2048000 /usr/local/bin/bash
597
598    Make sure gcc and bash are in the PATH with the command:
599    
600      export PATH=/usr/gnu/bin:$PATH
601    
602    then configure curl with a command like this:
603
604      ./configure CC=gcc GREP=grep AR=/usr/gnu/bin/gar --disable-ldap
605
606    Then simply run 'make'.
607
608    To compile with the ACK C compiler:
609
610      chmem =1024000 /usr/lib/em_cemcom.ansi
611      chmem =512000 /usr/lib/i386/as
612      ./configure CC=cc LD=cc GREP=grep CPPFLAGS=-D_POSIX_SOURCE=1 \
613                  --disable-ldap
614      make
615
616
617 CROSS COMPILE
618 =============
619    (This section was graciously brought to us by Jim Duey, with additions by
620    Dan Fandrich)
621
622    Download and unpack the cURL package.  Version should be 7.9.1 or later.
623
624    'cd' to the new directory. (e.g. cd curl-7.12.3)
625
626    Set environment variables to point to the cross-compile toolchain and call
627    configure with any options you need.  Be sure and specify the '--host' and
628    '--build' parameters at configuration time.  The following script is an
629    example of cross-compiling for the IBM 405GP PowerPC processor using the
630    toolchain from MonteVista for Hardhat Linux.
631
632    (begin script)
633
634    #! /bin/sh
635
636    export PATH=$PATH:/opt/hardhat/devkit/ppc/405/bin
637    export CPPFLAGS="-I/opt/hardhat/devkit/ppc/405/target/usr/include"
638    export AR=ppc_405-ar
639    export AS=ppc_405-as
640    export LD=ppc_405-ld
641    export RANLIB=ppc_405-ranlib
642    export CC=ppc_405-gcc
643    export NM=ppc_405-nm
644
645    ./configure --target=powerpc-hardhat-linux \
646         --host=powerpc-hardhat-linux \
647         --build=i586-pc-linux-gnu \
648         --prefix=/opt/hardhat/devkit/ppc/405/target/usr/local \
649         --exec-prefix=/usr/local
650
651    (end script)
652
653    You may also need to provide a parameter like '--with-random=/dev/urandom'
654    to configure as it cannot detect the presence of a random number
655    generating device for a target system.  The '--prefix' parameter
656    specifies where cURL will be installed.  If 'configure' completes
657    successfully, do 'make' and 'make install' as usual.
658
659    In some cases, you may be able to simplify the above commands to as
660    little as:
661
662        ./configure --host=ARCH-OS
663
664
665 REDUCING SIZE
666 =============
667    There are a number of configure options that can be used to reduce the
668    size of libcurl for embedded applications where binary size is an
669    important factor.  First, be sure to set the CFLAGS variable when
670    configuring with any relevant compiler optimization flags to reduce the
671    size of the binary.  For gcc, this would mean at minimum the -Os option
672    and probably the -march=X option as well, e.g.:
673
674       ./configure CFLAGS='-Os' ...
675
676    Be sure to specify as many --disable- and --without- flags on the configure
677    command-line as you can to disable all the libcurl features that you
678    know your application is not going to need.  Besides specifying the
679    --disable-PROTOCOL flags for all the types of URLs your application
680    will not use, here are some other flags that can reduce the size of the
681    library:
682
683      --disable-ares (disables support for the ARES DNS library)
684      --disable-cookies (disables support for HTTP cookies)
685      --disable-crypto-auth (disables HTTP cryptographic authentication)
686      --disable-ipv6 (disables support for IPv6)
687      --disable-verbose (eliminates debugging strings and error code strings)
688      --enable-hidden-symbols (eliminates unneeded symbols in the shared library)
689      --without-libidn (disables support for the libidn DNS library)
690      --without-ssl (disables support for SSL/TLS)
691      --without-zlib (disables support for on-the-fly decompression)
692
693    The GNU linker has a number of options to reduce the size of the libcurl
694    dynamic libraries on some platforms even further. Specify them by giving
695    the options -Wl,-Bsymbolic and -Wl,-s on the gcc command-line.  
696    Be sure also to strip debugging symbols from your binaries after
697    compiling using 'strip' (or the appropriate variant if cross-compiling).
698    If space is really tight, you may be able to remove some unneeded
699    sections of the shared library using the -R option to objcopy (e.g. the
700    .comment section).
701
702    Using these techniques it is possible to create an HTTP-only shared
703    libcurl library for i386 Linux platforms that is less than 90 KB in
704    size (as of version 7.15.4).
705
706    You may find that statically linking libcurl to your application will
707    result in a lower total size.
708
709
710 PORTS
711 =====
712    This is a probably incomplete list of known hardware and operating systems
713    that curl has been compiled for. If you know a system curl compiles and
714    runs on, that isn't listed, please let us know!
715
716         - Alpha DEC OSF 4
717         - Alpha Digital UNIX v3.2
718         - Alpha FreeBSD 4.1, 4.5
719         - Alpha Linux 2.2, 2.4
720         - Alpha NetBSD 1.5.2
721         - Alpha OpenBSD 3.0
722         - Alpha OpenVMS V7.1-1H2
723         - Alpha Tru64 v5.0 5.1
724         - HP-PA HP-UX 9.X 10.X 11.X
725         - HP-PA Linux
726         - HP3000 MPE/iX
727         - MIPS IRIX 6.2, 6.5
728         - MIPS Linux
729         - Pocket PC/Win CE 3.0
730         - Power AIX 3.2.5, 4.2, 4.3.1, 4.3.2, 5.1, 5.2
731         - PowerPC Darwin 1.0
732         - PowerPC Linux
733         - PowerPC Mac OS 9
734         - PowerPC Mac OS X
735         - SuperH4 Linux 2.6.X
736         - SINIX-Z v5
737         - Sparc Linux
738         - Sparc Solaris 2.4, 2.5, 2.5.1, 2.6, 7, 8, 9, 10
739         - Sparc SunOS 4.1.X
740         - StrongARM (and other ARM) RISC OS 3.1, 4.02
741         - StrongARM/ARM7/ARM9 Linux 2.4, 2.6
742         - StrongARM NetBSD 1.4.1
743         - Ultrix 4.3a
744         - UNICOS 9.0
745         - i386 BeOS
746         - i386 DOS
747         - i386 eCos 1.3.1
748         - i386 Esix 4.1
749         - i386 FreeBSD
750         - i386 HURD
751         - i386 Linux 1.3, 2.0, 2.2, 2.3, 2.4, 2.6
752         - i386 MINIX 3.1
753         - i386 NetBSD
754         - i386 Novell NetWare
755         - i386 OS/2
756         - i386 OpenBSD
757         - i386 SCO unix
758         - i386 Solaris 2.7
759         - i386 Windows 95, 98, ME, NT, 2000, XP, 2003
760         - i386 QNX 6
761         - i486 ncr-sysv4.3.03 (NCR MP-RAS)
762         - ia64 Linux 2.3.99
763         - m68k AmigaOS 3
764         - m68k Linux
765         - m68k OpenBSD
766         - m88k dg-dgux5.4R3.00
767         - s390 Linux
768         - XScale/PXA250 Linux 2.4
769
770 Useful URLs
771 ===========
772
773 OpenSSL   http://www.openssl.org
774 MingW     http://www.mingw.org
775 OpenLDAP  http://www.openldap.org
776 Zlib      http://www.gzip.org/zlib/
777 libssh2   http://www.libssh2.org
778
779