1                                  _   _ ____  _
2                              ___| | | |  _ \| |
3                             / __| | | | |_) | |
4                            | (__| |_| |  _ <| |___
5                             \___|\___/|_| \_\_____|
6
7FAQ
8
9 1. Philosophy
10  1.1 What is cURL?
11  1.2 What is libcurl?
12  1.3 What is curl not?
13  1.4 When will you make curl do XXXX ?
14  1.5 Who makes curl?
15  1.6 What do you get for making curl?
16  1.7 What about CURL from curl.com?
17  1.8 I have a problem who do I mail?
18  1.9 Where do I buy commercial support for curl?
19  1.10 How many are using curl?
20  1.11 Why don't you update ca-bundle.crt
21  1.12 I have a problem who can I chat with?
22  1.13 curl's ECCN number?
23  1.14 How do I submit my patch?
24  1.15 How do I port libcurl to my OS?
25
26 2. Install Related Problems
27  2.1 configure doesn't find OpenSSL even when it is installed
28   2.1.1 native linker doesn't find OpenSSL
29   2.1.2 only the libssl lib is missing
30  2.2 Does curl work/build with other SSL libraries?
31  2.3 Where can I find a copy of LIBEAY32.DLL?
32  2.4 Does curl support SOCKS (RFC 1928) ?
33
34 3. Usage Problems
35  3.1 curl: (1) SSL is disabled, https: not supported
36  3.2 How do I tell curl to resume a transfer?
37  3.3 Why doesn't my posting using -F work?
38  3.4 How do I tell curl to run custom FTP commands?
39  3.5 How can I disable the Accept: */* header?
40  3.6 Does curl support ASP, XML, XHTML or HTML version Y?
41  3.7 Can I use curl to delete/rename a file through FTP?
42  3.8 How do I tell curl to follow HTTP redirects?
43  3.9 How do I use curl in my favorite programming language?
44  3.10 What about SOAP, WebDAV, XML-RPC or similar protocols over HTTP?
45  3.11 How do I POST with a different Content-Type?
46  3.12 Why do FTP-specific features over HTTP proxy fail?
47  3.13 Why do my single/double quotes fail?
48  3.14 Does curl support Javascript or PAC (automated proxy config)?
49  3.15 Can I do recursive fetches with curl?
50  3.16 What certificates do I need when I use SSL?
51  3.17 How do I list the root dir of an FTP server?
52  3.18 Can I use curl to send a POST/PUT and not wait for a response?
53  3.19 How do I get HTTP from a host using a specific IP address?
54  3.20 How to SFTP from my user's home directory?
55  3.21 Protocol xxx not supported or disabled in libcurl
56  3.22 curl -X gives me HTTP problems
57
58 4. Running Problems
59  4.1 Problems connecting to SSL servers.
60  4.2 Why do I get problems when I use & or % in the URL?
61  4.3 How can I use {, }, [ or ] to specify multiple URLs?
62  4.4 Why do I get downloaded data even though the web page doesn't exist?
63  4.5 Why do I get return code XXX from a HTTP server?
64   4.5.1 "400 Bad Request"
65   4.5.2 "401 Unauthorized"
66   4.5.3 "403 Forbidden"
67   4.5.4 "404 Not Found"
68   4.5.5 "405 Method Not Allowed"
69   4.5.6 "301 Moved Permanently"
70  4.6 Can you tell me what error code 142 means?
71  4.7 How do I keep user names and passwords secret in Curl command lines?
72  4.8 I found a bug!
73  4.9 Curl can't authenticate to the server that requires NTLM?
74  4.10 My HTTP request using HEAD, PUT or DELETE doesn't work!
75  4.11 Why do my HTTP range requests return the full document?
76  4.12 Why do I get "certificate verify failed" ?
77  4.13 Why is curl -R on Windows one hour off?
78  4.14 Redirects work in browser but not with curl!
79  4.15 FTPS doesn't work
80  4.16 My HTTP POST or PUT requests are slow!
81  4.17 Non-functional connect timeouts on Windows
82  4.18 file:// URLs containing drive letters (Windows, NetWare)
83  4.19 Why doesn't curl return an error when the network cable is unplugged?
84  4.20 curl doesn't return error for HTTP non-200 responses!
85  4.21 Why is there a HTTP/1.1 in my HTTP/2 request?
86
87 5. libcurl Issues
88  5.1 Is libcurl thread-safe?
89  5.2 How can I receive all data into a large memory chunk?
90  5.3 How do I fetch multiple files with libcurl?
91  5.4 Does libcurl do Winsock initing on win32 systems?
92  5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
93  5.6 What about Keep-Alive or persistent connections?
94  5.7 Link errors when building libcurl on Windows!
95  5.8 libcurl.so.X: open failed: No such file or directory
96  5.9 How does libcurl resolve host names?
97  5.10 How do I prevent libcurl from writing the response to stdout?
98  5.11 How do I make libcurl not receive the whole HTTP response?
99  5.12 Can I make libcurl fake or hide my real IP address?
100  5.13 How do I stop an ongoing transfer?
101  5.14 Using C++ non-static functions for callbacks?
102  5.15 How do I get an FTP directory listing?
103  5.16 I want a different time-out!
104  5.17 Can I write a server with libcurl?
105  5.18 Does libcurl use threads?
106
107 6. License Issues
108  6.1 I have a GPL program, can I use the libcurl library?
109  6.2 I have a closed-source program, can I use the libcurl library?
110  6.3 I have a BSD licensed program, can I use the libcurl library?
111  6.4 I have a program that uses LGPL libraries, can I use libcurl?
112  6.5 Can I modify curl/libcurl for my program and keep the changes secret?
113  6.6 Can you please change the curl/libcurl license to XXXX?
114  6.7 What are my obligations when using libcurl in my commercial apps?
115
116 7. PHP/CURL Issues
117  7.1 What is PHP/CURL?
118  7.2 Who wrote PHP/CURL?
119  7.3 Can I perform multiple requests using the same handle?
120  7.4 Does PHP/CURL have dependencies?
121
122==============================================================================
123
1241. Philosophy
125
126  1.1 What is cURL?
127
128  cURL is the name of the project. The name is a play on 'Client for URLs',
129  originally with URL spelled in uppercase to make it obvious it deals with
130  URLs. The fact it can also be pronounced 'see URL' also helped, it works as
131  an abbreviation for "Client URL Request Library" or why not the recursive
132  version: "Curl URL Request Library".
133
134  The cURL project produces two products:
135
136  libcurl
137
138    A free and easy-to-use client-side URL transfer library, supporting DICT,
139    FILE, FTP, FTPS, GOPHER, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT,
140    POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET
141    and TFTP.
142
143    libcurl supports HTTPS certificates, HTTP POST, HTTP PUT, FTP uploading,
144    Kerberos, SPNEGO, HTTP form based upload, proxies, cookies, user+password
145    authentication, file transfer resume, http proxy tunneling and more!
146
147    libcurl is highly portable, it builds and works identically on numerous
148    platforms, including Solaris, NetBSD, FreeBSD, OpenBSD, Darwin, HP-UX,
149    IRIX, AIX, Tru64, Linux, UnixWare, HURD, Windows, Amiga, OS/2, BeOS, Mac
150    OS X, Ultrix, QNX, OpenVMS, RISC OS, Novell NetWare, DOS, Symbian, OSF,
151    Android, Minix, IBM TPF and more...
152
153    libcurl is free, thread-safe, IPv6 compatible, feature rich, well
154    supported and fast.
155
156  curl
157
158    A command line tool for getting or sending files using URL syntax.
159
160    Since curl uses libcurl, curl supports the same wide range of common
161    Internet protocols that libcurl does.
162
163  We pronounce curl with an initial k sound. It rhymes with words like girl
164  and earl. This is a short WAV file to help you:
165
166     https://media.merriam-webster.com/soundc11/c/curl0001.wav
167
168  There are numerous sub-projects and related projects that also use the word
169  curl in the project names in various combinations, but you should take
170  notice that this FAQ is directed at the command-line tool named curl (and
171  libcurl the library), and may therefore not be valid for other curl-related
172  projects. (There is however a small section for the PHP/CURL in this FAQ.)
173
174  1.2 What is libcurl?
175
176  libcurl is a reliable and portable library which provides you with an easy
177  interface to a range of common Internet protocols.
178
179  You can use libcurl for free in your application, be it open source,
180  commercial or closed-source.
181
182  libcurl is most probably the most portable, most powerful and most often
183  used C-based multi-platform file transfer library on this planet - be it
184  open source or commercial.
185
186  1.3 What is curl not?
187
188  Curl is not a wget clone. That is a common misconception.  Never, during
189  curl's development, have we intended curl to replace wget or compete on its
190  market. Curl is targeted at single-shot file transfers.
191
192  Curl is not a website mirroring program. If you want to use curl to mirror
193  something: fine, go ahead and write a script that wraps around curl to make
194  it reality (like curlmirror.pl does).
195
196  Curl is not an FTP site mirroring program. Sure, get and send FTP with curl
197  but if you want systematic and sequential behavior you should write a
198  script (or write a new program that interfaces libcurl) and do it.
199
200  Curl is not a PHP tool, even though it works perfectly well when used from
201  or with PHP (when using the PHP/CURL module).
202
203  Curl is not a program for a single operating system. Curl exists, compiles,
204  builds and runs under a wide range of operating systems, including all
205  modern Unixes (and a bunch of older ones too), Windows, Amiga, BeOS, OS/2,
206  OS X, QNX etc.
207
208  1.4 When will you make curl do XXXX ?
209
210  We love suggestions of what to change in order to make curl and libcurl
211  better. We do however believe in a few rules when it comes to the future of
212  curl:
213
214  Curl -- the command line tool -- is to remain a non-graphical command line
215  tool. If you want GUIs or fancy scripting capabilities, you should look for
216  another tool that uses libcurl.
217
218  We do not add things to curl that other small and available tools already do
219  very well at the side. Curl's output can be piped into another program or
220  redirected to another file for the next program to interpret.
221
222  We focus on protocol related issues and improvements. If you want to do more
223  magic with the supported protocols than curl currently does, chances are good
224  we will agree. If you want to add more protocols, we may very well agree.
225
226  If you want someone else to do all the work while you wait for us to
227  implement it for you, that is not a very friendly attitude. We spend a
228  considerable time already on maintaining and developing curl. In order to
229  get more out of us, you should consider trading in some of your time and
230  effort in return. Simply go to the GitHub repo which resides at
231  https://github.com/curl/curl, fork the project, and create pull requests
232  with your proposed changes.
233
234  If you write the code, chances are better that it will get into curl faster.
235
236  1.5 Who makes curl?
237
238  curl and libcurl are not made by any single individual. Daniel Stenberg is
239  project leader and main developer, but other persons' submissions are
240  important and crucial. Anyone can contribute and post their changes and
241  improvements and have them inserted in the main sources (of course on the
242  condition that developers agree that the fixes are good).
243
244  The full list of all contributors is found in the docs/THANKS file.
245
246  curl is developed by a community, with Daniel at the wheel.
247
248  1.6 What do you get for making curl?
249
250  Project cURL is entirely free and open. We do this voluntarily, mostly in
251  our spare time.  Companies may pay individual developers to work on curl,
252  but that's up to each company and developer. This is not controlled by nor
253  supervised in any way by the curl project.
254
255  We get help from companies. Haxx provides website, bandwidth, mailing lists
256  etc, GitHub hosts the primary git repository and other services like the bug
257  tracker at https://github.com/curl/curl. Also again, some companies have
258  sponsored certain parts of the development in the past and I hope some will
259  continue to do so in the future.
260
261  If you want to support our project, consider a donation or a banner-program
262  or even better: by helping us with coding, documenting or testing etc.
263
264  See also: https://curl.haxx.se/sponsors.html
265
266  1.7 What about CURL from curl.com?
267
268  During the summer of 2001, curl.com was busy advertising their client-side
269  programming language for the web, named CURL.
270
271  We are in no way associated with curl.com or their CURL programming
272  language.
273
274  Our project name curl has been in effective use since 1998. We were not the
275  first computer related project to use the name "curl" and do not claim any
276  rights to the name.
277
278  We recognize that we will be living in parallel with curl.com and wish them
279  every success.
280
281  1.8 I have a problem whom do I mail?
282
283  Please do not mail any single individual unless you really need to. Keep
284  curl-related questions on a suitable mailing list. All available mailing
285  lists are listed in the MANUAL document and online at
286  https://curl.haxx.se/mail/
287
288  Keeping curl-related questions and discussions on mailing lists allows
289  others to join in and help, to share their ideas, to contribute their
290  suggestions and to spread their wisdom. Keeping discussions on public mailing
291  lists also allows for others to learn from this (both current and future
292  users thanks to the web based archives of the mailing lists), thus saving us
293  from having to repeat ourselves even more. Thanks for respecting this.
294
295  If you have found or simply suspect a security problem in curl or libcurl,
296  mail curl-security at haxx.se (closed list of receivers, mails are not
297  disclosed) and tell. Then we can produce a fix in a timely manner before the
298  flaw is announced to the world, thus lessen the impact the problem will have
299  on existing users.
300
301  1.9 Where do I buy commercial support for curl?
302
303  curl is fully open source. It means you can hire any skilled engineer to fix
304  your curl-related problems.
305
306  We list available alternatives on the curl website:
307  https://curl.haxx.se/support.html
308
309  1.10 How many are using curl?
310
311  It is impossible to tell.
312
313  We don't know how many users that knowingly have installed and use curl.
314
315  We don't know how many users that use curl without knowing that they are in
316  fact using it.
317
318  We don't know how many users that downloaded or installed curl and then
319  never use it.
320
321  In 2020, we estimate that curl runs in rougly ten billion installations
322  world wide.
323
324  1.11 Why don't you update ca-bundle.crt
325
326  In the cURL project we've decided not to attempt to keep this file updated
327  (or even present) since deciding what to add to a ca cert bundle is an
328  undertaking we've not been ready to accept, and the one we can get from
329  Mozilla is perfectly fine so there's no need to duplicate that work.
330
331  Today, with many services performed over HTTPS, every operating system
332  should come with a default ca cert bundle that can be deemed somewhat
333  trustworthy and that collection (if reasonably updated) should be deemed to
334  be a lot better than a private curl version.
335
336  If you want the most recent collection of ca certs that Mozilla Firefox
337  uses, we recommend that you extract the collection yourself from Mozilla
338  Firefox (by running 'make ca-bundle), or by using our online service setup
339  for this purpose: https://curl.haxx.se/docs/caextract.html
340
341  1.12 I have a problem who can I chat with?
342
343  There's a bunch of friendly people hanging out in the #curl channel on the
344  IRC network irc.freenode.net. If you're polite and nice, chances are good
345  that you can get -- or provide -- help instantly.
346
347  1.13 curl's ECCN number?
348
349  The US government restricts exports of software that contains or uses
350  cryptography. When doing so, the Export Control Classification Number (ECCN)
351  is used to identify the level of export control etc.
352
353  Apache Software Foundation gives a good explanation of ECCNs at
354  https://www.apache.org/dev/crypto.html
355
356  We believe curl's number might be ECCN 5D002, another possibility is
357  5D992. It seems necessary to write them (the authority that administers ECCN
358  numbers), asking to confirm.
359
360  Comprehensible explanations of the meaning of such numbers and how to obtain
361  them (resp.) are here
362
363  https://www.bis.doc.gov/licensing/exportingbasics.htm
364  https://www.bis.doc.gov/licensing/do_i_needaneccn.html
365
366  An incomprehensible description of the two numbers above is here
367  https://www.bis.doc.gov/index.php/documents/new-encryption/1653-ccl5-pt2-3
368
369  1.14 How do I submit my patch?
370
371  We strongly encourage you to submit changes and improvements directly as
372  "pull requests" on github: https://github.com/curl/curl/pulls
373
374  If you for any reason can't or won't deal with github, send your patch to
375  the curl-library mailing list. We're many subscribers there and there are
376  lots of people who can review patches, comment on them and "receive" them
377  properly.
378
379  Lots of more details are found in the CONTRIBUTE and INTERNALS docs.
380
381  1.15 How do I port libcurl to my OS?
382
383  Here's a rough step-by-step:
384
385  1. copy a suitable lib/config-*.h file as a start to lib/config-[youros].h
386
387  2. edit lib/config-[youros].h to match your OS and setup
388
389  3. edit lib/curl_setup.h to include config-[youros].h when your OS is
390     detected by the preprocessor, in the style others already exist
391
392  4. compile lib/*.c and make them into a library
393
394
3952. Install Related Problems
396
397  2.1 configure doesn't find OpenSSL even when it is installed
398
399  This may be because of several reasons.
400
401    2.1.1 native linker doesn't find openssl
402
403    Affected platforms:
404      Solaris (native cc compiler)
405      HPUX (native cc compiler)
406      SGI IRIX (native cc compiler)
407      SCO UNIX (native cc compiler)
408
409    When configuring curl, I specify --with-ssl. OpenSSL is installed in
410    /usr/local/ssl Configure reports SSL in /usr/local/ssl, but fails to find
411    CRYPTO_lock in -lcrypto
412
413    Cause: The cc for this test places the -L/usr/local/ssl/lib AFTER
414    -lcrypto, so ld can't find the library. This is due to a bug in the GNU
415    autoconf tool.
416
417    Workaround: Specifying "LDFLAGS=-L/usr/local/ssl/lib" in front of
418    ./configure places the -L/usr/local/ssl/lib early enough in the command
419    line to make things work
420
421    2.1.2 only the libssl lib is missing
422
423    If all include files and the libcrypto lib is present, with only the
424    libssl being missing according to configure, this is most likely because
425    a few functions are left out from the libssl.
426
427    If the function names missing include RSA or RSAREF you can be certain
428    that this is because libssl requires the RSA and RSAREF libs to build.
429
430    See the INSTALL file section that explains how to add those libs to
431    configure. Make sure that you remove the config.cache file before you
432    rerun configure with the new flags.
433
434  2.2 Does curl work/build with other SSL libraries?
435
436  Curl has been written to use a generic SSL function layer internally, and
437  that SSL functionality can then be provided by one out of many different SSL
438  backends.
439
440  curl can be built to use one of the following SSL alternatives: OpenSSL,
441  libressl, BoringSSL, GnuTLS, wolfSSL, NSS, mbedTLS, MesaLink, Secure
442  Transport (native iOS/OS X), Schannel (native Windows), GSKit (native IBM
443  i), or BearSSL. They all have their pros and cons, and we try to maintain a
444  comparison of them here: https://curl.haxx.se/docs/ssl-compared.html
445
446  2.3 Where can I find a copy of LIBEAY32.DLL?
447
448  That is an OpenSSL binary built for Windows.
449
450  Curl can be built with OpenSSL to do the SSL stuff. The LIBEAY32.DLL is then
451  what curl needs on a windows machine to do https:// etc. Check out the curl
452  website to find accurate and up-to-date pointers to recent OpenSSL DLLs and
453  other binary packages.
454
455  2.4 Does curl support SOCKS (RFC 1928) ?
456
457  Yes, SOCKS 4 and 5 are supported.
458
459
4603. Usage problems
461
462  3.1 curl: (1) SSL is disabled, https: not supported
463
464  If you get this output when trying to get anything from a https:// server,
465  it means that the instance of curl/libcurl that you're using was built
466  without support for this protocol.
467
468  This could've happened if the configure script that was run at build time
469  couldn't find all libs and include files curl requires for SSL to work. If
470  the configure script fails to find them, curl is simply built without SSL
471  support.
472
473  To get the https:// support into a curl that was previously built but that
474  reports that https:// is not supported, you should dig through the document
475  and logs and check out why the configure script doesn't find the SSL libs
476  and/or include files.
477
478  Also, check out the other paragraph in this FAQ labeled "configure doesn't
479  find OpenSSL even when it is installed".
480
481  3.2 How do I tell curl to resume a transfer?
482
483  Curl supports resumed transfers both ways on both FTP and HTTP.
484  Try the -C option.
485
486  3.3 Why doesn't my posting using -F work?
487
488  You can't arbitrarily use -F or -d, the choice between -F or -d depends on the
489  HTTP operation you need curl to do and what the web server that will receive
490  your post expects.
491
492  If the form you're trying to submit uses the type 'multipart/form-data', then
493  and only then you must use the -F type. In all the most common cases, you
494  should use -d which then causes a posting with the type
495  'application/x-www-form-urlencoded'.
496
497  This is described in some detail in the MANUAL and TheArtOfHttpScripting
498  documents, and if you don't understand it the first time, read it again
499  before you post questions about this to the mailing list. Also, try reading
500  through the mailing list archives for old postings and questions regarding
501  this.
502
503  3.4 How do I tell curl to run custom FTP commands?
504
505  You can tell curl to perform optional commands both before and/or after a
506  file transfer. Study the -Q/--quote option.
507
508  Since curl is used for file transfers, you don't normally use curl to
509  perform FTP commands without transferring anything. Therefore you must
510  always specify a URL to transfer to/from even when doing custom FTP
511  commands, or use -I which implies the "no body" option sent to libcurl.
512
513  3.5 How can I disable the Accept: */* header?
514
515  You can change all internally generated headers by adding a replacement with
516  the -H/--header option. By adding a header with empty contents you safely
517  disable that one. Use -H "Accept:" to disable that specific header.
518
519  3.6 Does curl support ASP, XML, XHTML or HTML version Y?
520
521  To curl, all contents are alike. It doesn't matter how the page was
522  generated. It may be ASP, PHP, Perl, shell-script, SSI or plain HTML
523  files. There's no difference to curl and it doesn't even know what kind of
524  language that generated the page.
525
526  See also item 3.14 regarding javascript.
527
528  3.7 Can I use curl to delete/rename a file through FTP?
529
530  Yes. You specify custom FTP commands with -Q/--quote.
531
532  One example would be to delete a file after you have downloaded it:
533
534     curl -O ftp://download.com/coolfile -Q '-DELE coolfile'
535
536  or rename a file after upload:
537
538     curl -T infile ftp://upload.com/dir/ -Q "-RNFR infile" -Q "-RNTO newname"
539
540  3.8 How do I tell curl to follow HTTP redirects?
541
542  Curl does not follow so-called redirects by default. The Location: header
543  that informs the client about this is only interpreted if you're using the
544  -L/--location option. As in:
545
546     curl -L http://redirector.com
547
548  Not all redirects are HTTP ones, see 4.14
549
550  3.9 How do I use curl in my favorite programming language?
551
552  Many programming languages have interfaces/bindings that allow you to use
553  curl without having to use the command line tool. If you are fluent in such
554  a language, you may prefer to use one of these interfaces instead.
555
556  Find out more about which languages that support curl directly, and how to
557  install and use them, in the libcurl section of the curl website:
558  https://curl.haxx.se/libcurl/
559
560  All the various bindings to libcurl are made by other projects and people,
561  outside of the cURL project. The cURL project itself only produces libcurl
562  with its plain C API. If you don't find anywhere else to ask you can ask
563  about bindings on the curl-library list too, but be prepared that people on
564  that list may not know anything about bindings.
565
566  In February 2019, there were interfaces available for the following
567  languages: Ada95, Basic, C, C++, Ch, Cocoa, D, Delphi, Dylan, Eiffel,
568  Euphoria, Falcon, Ferite, Gambas, glib/GTK+, Go, Guile, Harbour, Haskell,
569  Java, Julia, Lisp, Lua, Mono, .NET, node.js, Object-Pascal, OCaml, Pascal,
570  Perl, PHP, PostgreSQL, Python, R, Rexx, Ring, RPG, Ruby, Rust, Scheme,
571  Scilab, S-Lang, Smalltalk, SP-Forth, SPL, Tcl, Visual Basic, Visual FoxPro,
572  Q, wxwidgets, XBLite and Xoho. By the time you read this, additional ones
573  may have appeared!
574
575  3.10 What about SOAP, WebDAV, XML-RPC or similar protocols over HTTP?
576
577  Curl adheres to the HTTP spec, which basically means you can play with *any*
578  protocol that is built on top of HTTP. Protocols such as SOAP, WEBDAV and
579  XML-RPC are all such ones. You can use -X to set custom requests and -H to
580  set custom headers (or replace internally generated ones).
581
582  Using libcurl is of course just as good and you'd just use the proper
583  library options to do the same.
584
585  3.11 How do I POST with a different Content-Type?
586
587  You can always replace the internally generated headers with -H/--header.
588  To make a simple HTTP POST with text/xml as content-type, do something like:
589
590        curl -d "datatopost" -H "Content-Type: text/xml" [URL]
591
592  3.12 Why do FTP-specific features over HTTP proxy fail?
593
594  Because when you use a HTTP proxy, the protocol spoken on the network will
595  be HTTP, even if you specify a FTP URL. This effectively means that you
596  normally can't use FTP-specific features such as FTP upload and FTP quote
597  etc.
598
599  There is one exception to this rule, and that is if you can "tunnel through"
600  the given HTTP proxy. Proxy tunneling is enabled with a special option (-p)
601  and is generally not available as proxy admins usually disable tunneling to
602  ports other than 443 (which is used for HTTPS access through proxies).
603
604  3.13 Why do my single/double quotes fail?
605
606  To specify a command line option that includes spaces, you might need to
607  put the entire option within quotes. Like in:
608
609   curl -d " with spaces " url.com
610
611  or perhaps
612
613   curl -d ' with spaces ' url.com
614
615  Exactly what kind of quotes and how to do this is entirely up to the shell
616  or command line interpreter that you are using. For most unix shells, you
617  can more or less pick either single (') or double (") quotes. For
618  Windows/DOS prompts I believe you're forced to use double (") quotes.
619
620  Please study the documentation for your particular environment. Examples in
621  the curl docs will use a mix of both of these as shown above. You must
622  adjust them to work in your environment.
623
624  Remember that curl works and runs on more operating systems than most single
625  individuals have ever tried.
626
627  3.14 Does curl support Javascript or PAC (automated proxy config)?
628
629  Many web pages do magic stuff using embedded Javascript. Curl and libcurl
630  have no built-in support for that, so it will be treated just like any other
631  contents.
632
633  .pac files are a netscape invention and are sometimes used by organizations
634  to allow them to differentiate which proxies to use. The .pac contents is
635  just a Javascript program that gets invoked by the browser and that returns
636  the name of the proxy to connect to. Since curl doesn't support Javascript,
637  it can't support .pac proxy configuration either.
638
639  Some workarounds usually suggested to overcome this Javascript dependency:
640
641  Depending on the Javascript complexity, write up a script that translates it
642  to another language and execute that.
643
644  Read the Javascript code and rewrite the same logic in another language.
645
646  Implement a Javascript interpreter, people have successfully used the
647  Mozilla Javascript engine in the past.
648
649  Ask your admins to stop this, for a static proxy setup or similar.
650
651  3.15 Can I do recursive fetches with curl?
652
653  No. curl itself has no code that performs recursive operations, such as
654  those performed by wget and similar tools.
655
656  There exists wrapper scripts with that functionality (for example the
657  curlmirror perl script), and you can write programs based on libcurl to do
658  it, but the command line tool curl itself cannot.
659
660  3.16 What certificates do I need when I use SSL?
661
662  There are three different kinds of "certificates" to keep track of when we
663  talk about using SSL-based protocols (HTTPS or FTPS) using curl or libcurl.
664
665  CLIENT CERTIFICATE
666
667  The server you communicate with may require that you can provide this in
668  order to prove that you actually are who you claim to be.  If the server
669  doesn't require this, you don't need a client certificate.
670
671  A client certificate is always used together with a private key, and the
672  private key has a pass phrase that protects it.
673
674  SERVER CERTIFICATE
675
676  The server you communicate with has a server certificate. You can and should
677  verify this certificate to make sure that you are truly talking to the real
678  server and not a server impersonating it.
679
680  CERTIFICATE AUTHORITY CERTIFICATE ("CA cert")
681
682  You often have several CA certs in a CA cert bundle that can be used to
683  verify a server certificate that was signed by one of the authorities in the
684  bundle. curl does not come with a CA cert bundle but most curl installs
685  provide one. You can also override the default.
686
687  The server certificate verification process is made by using a Certificate
688  Authority certificate ("CA cert") that was used to sign the server
689  certificate. Server certificate verification is enabled by default in curl
690  and libcurl and is often the reason for problems as explained in FAQ entry
691  4.12 and the SSLCERTS document
692  (https://curl.haxx.se/docs/sslcerts.html). Server certificates that are
693  "self-signed" or otherwise signed by a CA that you do not have a CA cert
694  for, cannot be verified. If the verification during a connect fails, you are
695  refused access. You then need to explicitly disable the verification to
696  connect to the server.
697
698  3.17 How do I list the root dir of an FTP server?
699
700  There are two ways. The way defined in the RFC is to use an encoded slash
701  in the first path part. List the "/tmp" dir like this:
702
703     curl ftp://ftp.sunet.se/%2ftmp/
704
705  or the not-quite-kosher-but-more-readable way, by simply starting the path
706  section of the URL with a slash:
707
708     curl ftp://ftp.sunet.se//tmp/
709
710  3.18 Can I use curl to send a POST/PUT and not wait for a response?
711
712  No.
713
714  But you could easily write your own program using libcurl to do such stunts.
715
716  3.19 How do I get HTTP from a host using a specific IP address?
717
718  For example, you may be trying out a website installation that isn't yet in
719  the DNS. Or you have a site using multiple IP addresses for a given host
720  name and you want to address a specific one out of the set.
721
722  Set a custom Host: header that identifies the server name you want to reach
723  but use the target IP address in the URL:
724
725    curl --header "Host: www.example.com" http://127.0.0.1/
726
727  You can also opt to add faked host name entries to curl with the --resolve
728  option. That has the added benefit that things like redirects will also work
729  properly. The above operation would instead be done as:
730
731    curl --resolve www.example.com:80:127.0.0.1 http://www.example.com/
732
733  3.20 How to SFTP from my user's home directory?
734
735  Contrary to how FTP works, SFTP and SCP URLs specify the exact directory to
736  work with. It means that if you don't specify that you want the user's home
737  directory, you get the actual root directory.
738
739  To specify a file in your user's home directory, you need to use the correct
740  URL syntax which for SFTP might look similar to:
741
742    curl -O -u user:password sftp://example.com/~/file.txt
743
744  and for SCP it is just a different protocol prefix:
745
746    curl -O -u user:password scp://example.com/~/file.txt
747
748  3.21 Protocol xxx not supported or disabled in libcurl
749
750  When passing on a URL to curl to use, it may respond that the particular
751  protocol is not supported or disabled. The particular way this error message
752  is phrased is because curl doesn't make a distinction internally of whether
753  a particular protocol is not supported (i.e. never got any code added that
754  knows how to speak that protocol) or if it was explicitly disabled. curl can
755  be built to only support a given set of protocols, and the rest would then
756  be disabled or not supported.
757
758  Note that this error will also occur if you pass a wrongly spelled protocol
759  part as in "htpt://example.com" or as in the less evident case if you prefix
760  the protocol part with a space as in " http://example.com/".
761
762  3.22 curl -X gives me HTTP problems
763
764  In normal circumstances, -X should hardly ever be used.
765
766  By default you use curl without explicitly saying which request method to
767  use when the URL identifies a HTTP transfer. If you just pass in a URL like
768  "curl http://example.com" it will use GET. If you use -d or -F curl will use
769  POST, -I will cause a HEAD and -T will make it a PUT.
770
771  If for whatever reason you're not happy with these default choices that curl
772  does for you, you can override those request methods by specifying -X
773  [WHATEVER]. This way you can for example send a DELETE by doing "curl -X
774  DELETE [URL]".
775
776  It is thus pointless to do "curl -XGET [URL]" as GET would be used
777  anyway. In the same vein it is pointless to do "curl -X POST -d data
778  [URL]"... But you can make a fun and somewhat rare request that sends a
779  request-body in a GET request with something like "curl -X GET -d data
780  [URL]"
781
782  Note that -X doesn't actually change curl's behavior as it only modifies the
783  actual string sent in the request, but that may of course trigger a
784  different set of events.
785
786  Accordingly, by using -XPOST on a command line that for example would follow
787  a 303 redirect, you will effectively prevent curl from behaving
788  correctly. Be aware.
789
790
7914. Running Problems
792
793  4.1 Problems connecting to SSL servers.
794
795  It took a very long time before we could sort out why curl had problems to
796  connect to certain SSL servers when using SSLeay or OpenSSL v0.9+.  The
797  error sometimes showed up similar to:
798
799  16570:error:1407D071:SSL routines:SSL2_READ:bad mac decode:s2_pkt.c:233:
800
801  It turned out to be because many older SSL servers don't deal with SSLv3
802  requests properly. To correct this problem, tell curl to select SSLv2 from
803  the command line (-2/--sslv2).
804
805  There have also been examples where the remote server didn't like the SSLv2
806  request and instead you had to force curl to use SSLv3 with -3/--sslv3.
807
808  4.2 Why do I get problems when I use & or % in the URL?
809
810  In general unix shells, the & symbol is treated specially and when used, it
811  runs the specified command in the background. To safely send the & as a part
812  of a URL, you should quote the entire URL by using single (') or double (")
813  quotes around it. Similar problems can also occur on some shells with other
814  characters, including ?*!$~(){}<>\|;`.  When in doubt, quote the URL.
815
816  An example that would invoke a remote CGI that uses &-symbols could be:
817
818     curl 'http://www.altavista.com/cgi-bin/query?text=yes&q=curl'
819
820  In Windows, the standard DOS shell treats the percent sign specially and you
821  need to use TWO percent signs for each single one you want to use in the
822  URL.
823
824  If you want a literal percent sign to be part of the data you pass in a POST
825  using -d/--data you must encode it as '%25' (which then also needs the
826  percent sign doubled on Windows machines).
827
828  4.3 How can I use {, }, [ or ] to specify multiple URLs?
829
830  Because those letters have a special meaning to the shell, to be used in
831  a URL specified to curl you must quote them.
832
833  An example that downloads two URLs (sequentially) would be:
834
835    curl '{curl,www}.haxx.se'
836
837  To be able to use those characters as actual parts of the URL (without using
838  them for the curl URL "globbing" system), use the -g/--globoff option:
839
840    curl -g 'www.site.com/weirdname[].html'
841
842  4.4 Why do I get downloaded data even though the web page doesn't exist?
843
844  Curl asks remote servers for the page you specify. If the page doesn't exist
845  at the server, the HTTP protocol defines how the server should respond and
846  that means that headers and a "page" will be returned. That's simply how
847  HTTP works.
848
849  By using the --fail option you can tell curl explicitly to not get any data
850  if the HTTP return code doesn't say success.
851
852  4.5 Why do I get return code XXX from a HTTP server?
853
854  RFC2616 clearly explains the return codes. This is a short transcript. Go
855  read the RFC for exact details:
856
857    4.5.1 "400 Bad Request"
858
859    The request could not be understood by the server due to malformed
860    syntax. The client SHOULD NOT repeat the request without modifications.
861
862    4.5.2 "401 Unauthorized"
863
864    The request requires user authentication.
865
866    4.5.3 "403 Forbidden"
867
868    The server understood the request, but is refusing to fulfill it.
869    Authorization will not help and the request SHOULD NOT be repeated.
870
871    4.5.4 "404 Not Found"
872
873    The server has not found anything matching the Request-URI. No indication
874    is given of whether the condition is temporary or permanent.
875
876    4.5.5 "405 Method Not Allowed"
877
878    The method specified in the Request-Line is not allowed for the resource
879    identified by the Request-URI. The response MUST include an Allow header
880    containing a list of valid methods for the requested resource.
881
882    4.5.6 "301 Moved Permanently"
883
884    If you get this return code and an HTML output similar to this:
885
886       <H1>Moved Permanently</H1> The document has moved <A
887       HREF="http://same_url_now_with_a_trailing_slash/">here</A>.
888
889    it might be because you requested a directory URL but without the trailing
890    slash. Try the same operation again _with_ the trailing URL, or use the
891    -L/--location option to follow the redirection.
892
893  4.6 Can you tell me what error code 142 means?
894
895  All curl error codes are described at the end of the man page, in the
896  section called "EXIT CODES".
897
898  Error codes that are larger than the highest documented error code means
899  that curl has exited due to a crash. This is a serious error, and we
900  appreciate a detailed bug report from you that describes how we could go
901  ahead and repeat this!
902
903  4.7 How do I keep user names and passwords secret in Curl command lines?
904
905  This problem has two sides:
906
907  The first part is to avoid having clear-text passwords in the command line
908  so that they don't appear in 'ps' outputs and similar. That is easily
909  avoided by using the "-K" option to tell curl to read parameters from a file
910  or stdin to which you can pass the secret info. curl itself will also
911  attempt to "hide" the given password by blanking out the option - this
912  doesn't work on all platforms.
913
914  To keep the passwords in your account secret from the rest of the world is
915  not a task that curl addresses. You could of course encrypt them somehow to
916  at least hide them from being read by human eyes, but that is not what
917  anyone would call security.
918
919  Also note that regular HTTP (using Basic authentication) and FTP passwords
920  are sent as cleartext across the network. All it takes for anyone to fetch
921  them is to listen on the network. Eavesdropping is very easy. Use more secure
922  authentication methods (like Digest, Negotiate or even NTLM) or consider the
923  SSL-based alternatives HTTPS and FTPS.
924
925  4.8 I found a bug!
926
927  It is not a bug if the behavior is documented. Read the docs first.
928  Especially check out the KNOWN_BUGS file, it may be a documented bug!
929
930  If it is a problem with a binary you've downloaded or a package for your
931  particular platform, try contacting the person who built the package/archive
932  you have.
933
934  If there is a bug, read the BUGS document first. Then report it as described
935  in there.
936
937  4.9 Curl can't authenticate to the server that requires NTLM?
938
939  NTLM support requires OpenSSL, GnuTLS, mbedTLS, NSS, Secure Transport, or
940  Microsoft Windows libraries at build-time to provide this functionality.
941
942  NTLM is a Microsoft proprietary protocol. Proprietary formats are evil. You
943  should not use such ones.
944
945  4.10 My HTTP request using HEAD, PUT or DELETE doesn't work!
946
947  Many web servers allow or demand that the administrator configures the
948  server properly for these requests to work on the web server.
949
950  Some servers seem to support HEAD only on certain kinds of URLs.
951
952  To fully grasp this, try the documentation for the particular server
953  software you're trying to interact with. This is not anything curl can do
954  anything about.
955
956  4.11 Why do my HTTP range requests return the full document?
957
958  Because the range may not be supported by the server, or the server may
959  choose to ignore it and return the full document anyway.
960
961  4.12 Why do I get "certificate verify failed" ?
962
963  You invoke curl 7.10 or later to communicate on a https:// URL and get an
964  error back looking something similar to this:
965
966      curl: (35) SSL: error:14090086:SSL routines:
967      SSL3_GET_SERVER_CERTIFICATE:certificate verify failed
968
969  Then it means that curl couldn't verify that the server's certificate was
970  good. Curl verifies the certificate using the CA cert bundle that comes with
971  the curl installation.
972
973  To disable the verification (which makes it act like curl did before 7.10),
974  use -k. This does however enable man-in-the-middle attacks.
975
976  If you get this failure but are having a CA cert bundle installed and used,
977  the server's certificate is not signed by one of the CA's in the bundle. It
978  might for example be self-signed. You then correct this problem by obtaining
979  a valid CA cert for the server. Or again, decrease the security by disabling
980  this check.
981
982  Details are also in the SSLCERTS file in the release archives, found online
983  here: https://curl.haxx.se/docs/sslcerts.html
984
985  4.13 Why is curl -R on Windows one hour off?
986
987  Since curl 7.53.0 this issue should be fixed as long as curl was built with
988  any modern compiler that allows for a 64-bit curl_off_t type. For older
989  compilers or prior curl versions it may set a time that appears one hour off.
990  This happens due to a flaw in how Windows stores and uses file modification
991  times and it is not easily worked around. For more details read this:
992  https://www.codeproject.com/Articles/1144/Beating-the-Daylight-Savings-Time-bug-and-getting
993
994  4.14 Redirects work in browser but not with curl!
995
996  curl supports HTTP redirects well (see item 3.8). Browsers generally support
997  at least two other ways to perform redirects that curl does not:
998
999  Meta tags. You can write a HTML tag that will cause the browser to redirect
1000  to another given URL after a certain time.
1001
1002  Javascript. You can write a Javascript program embedded in a HTML page that
1003  redirects the browser to another given URL.
1004
1005  There is no way to make curl follow these redirects. You must either
1006  manually figure out what the page is set to do, or write a script that parses
1007  the results and fetches the new URL.
1008
1009  4.15 FTPS doesn't work
1010
1011  curl supports FTPS (sometimes known as FTP-SSL) both implicit and explicit
1012  mode.
1013
1014  When a URL is used that starts with FTPS://, curl assumes implicit SSL on
1015  the control connection and will therefore immediately connect and try to
1016  speak SSL. FTPS:// connections default to port 990.
1017
1018  To use explicit FTPS, you use a FTP:// URL and the --ftp-ssl option (or one
1019  of its related flavors). This is the most common method, and the one
1020  mandated by RFC4217. This kind of connection will then of course use the
1021  standard FTP port 21 by default.
1022
1023  4.16 My HTTP POST or PUT requests are slow!
1024
1025  libcurl makes all POST and PUT requests (except for POST requests with a
1026  very tiny request body) use the "Expect: 100-continue" header. This header
1027  allows the server to deny the operation early so that libcurl can bail out
1028  before having to send any data. This is useful in authentication
1029  cases and others.
1030
1031  However, many servers don't implement the Expect: stuff properly and if the
1032  server doesn't respond (positively) within 1 second libcurl will continue
1033  and send off the data anyway.
1034
1035  You can disable libcurl's use of the Expect: header the same way you disable
1036  any header, using -H / CURLOPT_HTTPHEADER, or by forcing it to use HTTP 1.0.
1037
1038  4.17 Non-functional connect timeouts
1039
1040  In most Windows setups having a timeout longer than 21 seconds make no
1041  difference, as it will only send 3 TCP SYN packets and no more. The second
1042  packet sent three seconds after the first and the third six seconds after
1043  the second.  No more than three packets are sent, no matter how long the
1044  timeout is set.
1045
1046  See option TcpMaxConnectRetransmissions on this page:
1047  https://support.microsoft.com/en-us/kb/175523/en-us
1048
1049  Also, even on non-Windows systems there may run a firewall or anti-virus
1050  software or similar that accepts the connection but does not actually do
1051  anything else. This will make (lib)curl to consider the connection connected
1052  and thus the connect timeout won't trigger.
1053
1054  4.18 file:// URLs containing drive letters (Windows, NetWare)
1055
1056  When using curl to try to download a local file, one might use a URL
1057  in this format:
1058
1059  file://D:/blah.txt
1060
1061  You'll find that even if D:\blah.txt does exist, curl returns a 'file
1062  not found' error.
1063
1064  According to RFC 1738 (https://www.ietf.org/rfc/rfc1738.txt),
1065  file:// URLs must contain a host component, but it is ignored by
1066  most implementations. In the above example, 'D:' is treated as the
1067  host component, and is taken away. Thus, curl tries to open '/blah.txt'.
1068  If your system is installed to drive C:, that will resolve to 'C:\blah.txt',
1069  and if that doesn't exist you will get the not found error.
1070
1071  To fix this problem, use file:// URLs with *three* leading slashes:
1072
1073  file:///D:/blah.txt
1074
1075  Alternatively, if it makes more sense, specify 'localhost' as the host
1076  component:
1077
1078  file://localhost/D:/blah.txt
1079
1080  In either case, curl should now be looking for the correct file.
1081
1082  4.19 Why doesn't curl return an error when the network cable is unplugged?
1083
1084  Unplugging a cable is not an error situation. The TCP/IP protocol stack
1085  was designed to be fault tolerant, so even though there may be a physical
1086  break somewhere the connection shouldn't be affected, just possibly
1087  delayed.  Eventually, the physical break will be fixed or the data will be
1088  re-routed around the physical problem through another path.
1089
1090  In such cases, the TCP/IP stack is responsible for detecting when the
1091  network connection is irrevocably lost. Since with some protocols it is
1092  perfectly legal for the client to wait indefinitely for data, the stack may
1093  never report a problem, and even when it does, it can take up to 20 minutes
1094  for it to detect an issue.  The curl option --keepalive-time enables
1095  keep-alive support in the TCP/IP stack which makes it periodically probe the
1096  connection to make sure it is still available to send data. That should
1097  reliably detect any TCP/IP network failure.
1098
1099  But even that won't detect the network going down before the TCP/IP
1100  connection is established (e.g. during a DNS lookup) or using protocols that
1101  don't use TCP.  To handle those situations, curl offers a number of timeouts
1102  on its own. --speed-limit/--speed-time will abort if the data transfer rate
1103  falls too low, and --connect-timeout and --max-time can be used to put an
1104  overall timeout on the connection phase or the entire transfer.
1105
1106  A libcurl-using application running in a known physical environment (e.g.
1107  an embedded device with only a single network connection) may want to act
1108  immediately if its lone network connection goes down.  That can be achieved
1109  by having the application monitor the network connection on its own using an
1110  OS-specific mechanism, then signaling libcurl to abort (see also item 5.13).
1111
1112  4.20 curl doesn't return error for HTTP non-200 responses!
1113
1114  Correct. Unless you use -f (--fail).
1115
1116  When doing HTTP transfers, curl will perform exactly what you're asking it
1117  to do and if successful it will not return an error. You can use curl to
1118  test your web server's "file not found" page (that gets 404 back), you can
1119  use it to check your authentication protected web pages (that gets a 401
1120  back) and so on.
1121
1122  The specific HTTP response code does not constitute a problem or error for
1123  curl. It simply sends and delivers HTTP as you asked and if that worked,
1124  everything is fine and dandy. The response code is generally providing more
1125  higher level error information that curl doesn't care about. The error was
1126  not in the HTTP transfer.
1127
1128  If you want your command line to treat error codes in the 400 and up range
1129  as errors and thus return a non-zero value and possibly show an error
1130  message, curl has a dedicated option for that: -f (CURLOPT_FAILONERROR in
1131  libcurl speak).
1132
1133  You can also use the -w option and the variable %{response_code} to extract
1134  the exact response code that was returned in the response.
1135
1136  4.21 Why is there a HTTP/1.1 in my HTTP/2 request?
1137
1138  If you use verbose to see the HTTP request when you send off a HTTP/2
1139  request, it will still say 1.1.
1140
1141  The reason for this is that we first generate the request to send using the
1142  old 1.1 style and show that request in the verbose output, and then we
1143  convert it over to the binary header-compressed HTTP/2 style. The actual
1144  "1.1" part from that request is then not actually used in the transfer.
1145  The binary HTTP/2 headers are not human readable.
1146
11475. libcurl Issues
1148
1149  5.1 Is libcurl thread-safe?
1150
1151  Yes.
1152
1153  We have written the libcurl code specifically adjusted for multi-threaded
1154  programs. libcurl will use thread-safe functions instead of non-safe ones if
1155  your system has such.  Note that you must never share the same handle in
1156  multiple threads.
1157
1158  There may be some exceptions to thread safety depending on how libcurl was
1159  built. Please review the guidelines for thread safety to learn more:
1160  https://curl.haxx.se/libcurl/c/threadsafe.html
1161
1162  5.2 How can I receive all data into a large memory chunk?
1163
1164  [ See also the examples/getinmemory.c source ]
1165
1166  You are in full control of the callback function that gets called every time
1167  there is data received from the remote server. You can make that callback do
1168  whatever you want. You do not have to write the received data to a file.
1169
1170  One solution to this problem could be to have a pointer to a struct that you
1171  pass to the callback function. You set the pointer using the
1172  CURLOPT_WRITEDATA option. Then that pointer will be passed to the callback
1173  instead of a FILE * to a file:
1174
1175        /* imaginary struct */
1176        struct MemoryStruct {
1177          char *memory;
1178          size_t size;
1179        };
1180
1181        /* imaginary callback function */
1182        size_t
1183        WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data)
1184        {
1185          size_t realsize = size * nmemb;
1186          struct MemoryStruct *mem = (struct MemoryStruct *)data;
1187
1188          mem->memory = (char *)realloc(mem->memory, mem->size + realsize + 1);
1189          if (mem->memory) {
1190            memcpy(&(mem->memory[mem->size]), ptr, realsize);
1191            mem->size += realsize;
1192            mem->memory[mem->size] = 0;
1193          }
1194          return realsize;
1195        }
1196
1197  5.3 How do I fetch multiple files with libcurl?
1198
1199  libcurl has excellent support for transferring multiple files. You should
1200  just repeatedly set new URLs with curl_easy_setopt() and then transfer it
1201  with curl_easy_perform(). The handle you get from curl_easy_init() is not
1202  only reusable, but you're even encouraged to reuse it if you can, as that
1203  will enable libcurl to use persistent connections.
1204
1205  5.4 Does libcurl do Winsock initialization on win32 systems?
1206
1207  Yes, if told to in the curl_global_init() call.
1208
1209  5.5 Does CURLOPT_WRITEDATA and CURLOPT_READDATA work on win32 ?
1210
1211  Yes, but you cannot open a FILE * and pass the pointer to a DLL and have
1212  that DLL use the FILE * (as the DLL and the client application cannot access
1213  each others' variable memory areas). If you set CURLOPT_WRITEDATA you must
1214  also use CURLOPT_WRITEFUNCTION as well to set a function that writes the
1215  file, even if that simply writes the data to the specified FILE *.
1216  Similarly, if you use CURLOPT_READDATA you must also specify
1217  CURLOPT_READFUNCTION.
1218
1219  5.6 What about Keep-Alive or persistent connections?
1220
1221  curl and libcurl have excellent support for persistent connections when
1222  transferring several files from the same server.  Curl will attempt to reuse
1223  connections for all URLs specified on the same command line/config file, and
1224  libcurl will reuse connections for all transfers that are made using the
1225  same libcurl handle.
1226
1227  When you use the easy interface the connection cache is kept within the easy
1228  handle. If you instead use the multi interface, the connection cache will be
1229  kept within the multi handle and will be shared among all the easy handles
1230  that are used within the same multi handle.
1231
1232  5.7 Link errors when building libcurl on Windows!
1233
1234  You need to make sure that your project, and all the libraries (both static
1235  and dynamic) that it links against, are compiled/linked against the same run
1236  time library.
1237
1238  This is determined by the /MD, /ML, /MT (and their corresponding /M?d)
1239  options to the command line compiler. /MD (linking against MSVCRT dll) seems
1240  to be the most commonly used option.
1241
1242  When building an application that uses the static libcurl library, you must
1243  add -DCURL_STATICLIB to your CFLAGS. Otherwise the linker will look for
1244  dynamic import symbols. If you're using Visual Studio, you need to instead
1245  add CURL_STATICLIB in the "Preprocessor Definitions" section.
1246
1247  If you get linker error like "unknown symbol __imp__curl_easy_init ..." you
1248  have linked against the wrong (static) library.  If you want to use the
1249  libcurl.dll and import lib, you don't need any extra CFLAGS, but use one of
1250  the import libraries below. These are the libraries produced by the various
1251  lib/Makefile.* files:
1252
1253       Target:          static lib.   import lib for libcurl*.dll.
1254       -----------------------------------------------------------
1255       MingW:           libcurl.a     libcurldll.a
1256       MSVC (release):  libcurl.lib   libcurl_imp.lib
1257       MSVC (debug):    libcurld.lib  libcurld_imp.lib
1258       Borland:         libcurl.lib   libcurl_imp.lib
1259
1260  5.8 libcurl.so.X: open failed: No such file or directory
1261
1262  This is an error message you might get when you try to run a program linked
1263  with a shared version of libcurl and your run-time linker (ld.so) couldn't
1264  find the shared library named libcurl.so.X. (Where X is the number of the
1265  current libcurl ABI, typically 3 or 4).
1266
1267  You need to make sure that ld.so finds libcurl.so.X. You can do that
1268  multiple ways, and it differs somewhat between different operating systems,
1269  but they are usually:
1270
1271  * Add an option to the linker command line that specify the hard-coded path
1272    the run-time linker should check for the lib (usually -R)
1273
1274  * Set an environment variable (LD_LIBRARY_PATH for example) where ld.so
1275    should check for libs
1276
1277  * Adjust the system's config to check for libs in the directory where you've
1278    put the dir (like Linux's /etc/ld.so.conf)
1279
1280  'man ld.so' and 'man ld' will tell you more details
1281
1282  5.9 How does libcurl resolve host names?
1283
1284  libcurl supports a large a number of different name resolve functions. One
1285  of them is picked at build-time and will be used unconditionally. Thus, if
1286  you want to change name resolver function you must rebuild libcurl and tell
1287  it to use a different function.
1288
1289  - The non-IPv6 resolver that can use one of four different host name resolve
1290  calls (depending on what your system supports):
1291
1292      A - gethostbyname()
1293      B - gethostbyname_r() with 3 arguments
1294      C - gethostbyname_r() with 5 arguments
1295      D - gethostbyname_r() with 6 arguments
1296
1297  - The IPv6-resolver that uses getaddrinfo()
1298
1299  - The c-ares based name resolver that uses the c-ares library for resolves.
1300    Using this offers asynchronous name resolves.
1301
1302  - The threaded resolver (default option on Windows). It uses:
1303
1304      A - gethostbyname() on plain IPv4 hosts
1305      B - getaddrinfo() on IPv6 enabled hosts
1306
1307  Also note that libcurl never resolves or reverse-lookups addresses given as
1308  pure numbers, such as 127.0.0.1 or ::1.
1309
1310  5.10 How do I prevent libcurl from writing the response to stdout?
1311
1312  libcurl provides a default built-in write function that writes received data
1313  to stdout. Set the CURLOPT_WRITEFUNCTION to receive the data, or possibly
1314  set CURLOPT_WRITEDATA to a different FILE * handle.
1315
1316  5.11 How do I make libcurl not receive the whole HTTP response?
1317
1318  You make the write callback (or progress callback) return an error and
1319  libcurl will then abort the transfer.
1320
1321  5.12 Can I make libcurl fake or hide my real IP address?
1322
1323  No. libcurl operates on a higher level. Besides, faking IP address would
1324  imply sending IP packets with a made-up source address, and then you normally
1325  get a problem with receiving the packet sent back as they would then not be
1326  routed to you!
1327
1328  If you use a proxy to access remote sites, the sites will not see your local
1329  IP address but instead the address of the proxy.
1330
1331  Also note that on many networks NATs or other IP-munging techniques are used
1332  that makes you see and use a different IP address locally than what the
1333  remote server will see you coming from. You may also consider using
1334  https://www.torproject.org/ .
1335
1336  5.13 How do I stop an ongoing transfer?
1337
1338  With the easy interface you make sure to return the correct error code from
1339  one of the callbacks, but none of them are instant. There is no function you
1340  can call from another thread or similar that will stop it immediately.
1341  Instead, you need to make sure that one of the callbacks you use returns an
1342  appropriate value that will stop the transfer.  Suitable callbacks that you
1343  can do this with include the progress callback, the read callback and the
1344  write callback.
1345
1346  If you're using the multi interface, you can also stop a transfer by
1347  removing the particular easy handle from the multi stack at any moment you
1348  think the transfer is done or when you wish to abort the transfer.
1349
1350  5.14 Using C++ non-static functions for callbacks?
1351
1352  libcurl is a C library, it doesn't know anything about C++ member functions.
1353
1354  You can overcome this "limitation" with relative ease using a static
1355  member function that is passed a pointer to the class:
1356
1357     // f is the pointer to your object.
1358     static size_t YourClass::func(void *buffer, size_t sz, size_t n, void *f)
1359     {
1360       // Call non-static member function.
1361       static_cast<YourClass*>(f)->nonStaticFunction();
1362     }
1363
1364     // This is how you pass pointer to the static function:
1365     curl_easy_setopt(hcurl, CURLOPT_WRITEFUNCTION, YourClass::func);
1366     curl_easy_setopt(hcurl, CURLOPT_WRITEDATA, this);
1367
1368  5.15 How do I get an FTP directory listing?
1369
1370  If you end the FTP URL you request with a slash, libcurl will provide you
1371  with a directory listing of that given directory. You can also set
1372  CURLOPT_CUSTOMREQUEST to alter what exact listing command libcurl would use
1373  to list the files.
1374
1375  The follow-up question tends to be how is a program supposed to parse the
1376  directory listing. How does it know what's a file and what's a dir and what's
1377  a symlink etc. If the FTP server supports the MLSD command then it will
1378  return data in a machine-readable format that can be parsed for type. The
1379  types are specified by RFC3659 section 7.5.1. If MLSD is not supported then
1380  you have to work with what you're given. The LIST output format is entirely
1381  at the server's own liking and the NLST output doesn't reveal any types and
1382  in many cases doesn't even include all the directory entries. Also, both LIST
1383  and NLST tend to hide unix-style hidden files (those that start with a dot)
1384  by default so you need to do "LIST -a" or similar to see them.
1385
1386  Example - List only directories.
1387  ftp.funet.fi supports MLSD and ftp.kernel.org does not:
1388
1389     curl -s ftp.funet.fi/pub/ -X MLSD | \
1390       perl -lne 'print if s/(?:^|;)type=dir;[^ ]+ (.+)$/$1/'
1391
1392     curl -s ftp.kernel.org/pub/linux/kernel/ | \
1393       perl -lne 'print if s/^d[-rwx]{9}(?: +[^ ]+){7} (.+)$/$1/'
1394
1395  If you need to parse LIST output in libcurl one such existing
1396  list parser is available at https://cr.yp.to/ftpparse.html  Versions of
1397  libcurl since 7.21.0 also provide the ability to specify a wildcard to
1398  download multiple files from one FTP directory.
1399
1400  5.16 I want a different time-out!
1401
1402  Time and time again users realize that CURLOPT_TIMEOUT and
1403  CURLOPT_CONNECTIMEOUT are not sufficiently advanced or flexible to cover all
1404  the various use cases and scenarios applications end up with.
1405
1406  libcurl offers many more ways to time-out operations. A common alternative
1407  is to use the CURLOPT_LOW_SPEED_LIMIT and CURLOPT_LOW_SPEED_TIME options to
1408  specify the lowest possible speed to accept before to consider the transfer
1409  timed out.
1410
1411  The most flexible way is by writing your own time-out logic and using
1412  CURLOPT_XFERINFOFUNCTION (perhaps in combination with other callbacks) and
1413  use that to figure out exactly when the right condition is met when the
1414  transfer should get stopped.
1415
1416  5.17 Can I write a server with libcurl?
1417
1418  No. libcurl offers no functions or building blocks to build any kind of
1419  internet protocol server. libcurl is only a client-side library. For server
1420  libraries, you need to continue your search elsewhere but there exist many
1421  good open source ones out there for most protocols you could possibly want a
1422  server for. And there are really good stand-alone ones that have been tested
1423  and proven for many years. There's no need for you to reinvent them!
1424
1425  5.18 Does libcurl use threads?
1426
1427  Put simply: no, libcurl will execute in the same thread you call it in. All
1428  callbacks will be called in the same thread as the one you call libcurl in.
1429
1430  If you want to avoid your thread to be blocked by the libcurl call, you make
1431  sure you use the non-blocking API which will do transfers asynchronously -
1432  but still in the same single thread.
1433
1434  libcurl will potentially internally use threads for name resolving, if it
1435  was built to work like that, but in those cases it'll create the child
1436  threads by itself and they will only be used and then killed internally by
1437  libcurl and never exposed to the outside.
1438
14396. License Issues
1440
1441  Curl and libcurl are released under a MIT/X derivate license. The license is
1442  very liberal and should not impose a problem for your project. This section
1443  is just a brief summary for the cases we get the most questions. (Parts of
1444  this section was much enhanced by Bjorn Reese.)
1445
1446  We are not lawyers and this is not legal advice. You should probably consult
1447  one if you want true and accurate legal insights without our prejudice. Note
1448  especially that this section concerns the libcurl license only; compiling in
1449  features of libcurl that depend on other libraries (e.g. OpenSSL) may affect
1450  the licensing obligations of your application.
1451
1452  6.1 I have a GPL program, can I use the libcurl library?
1453
1454  Yes!
1455
1456  Since libcurl may be distributed under the MIT/X derivate license, it can be
1457  used together with GPL in any software.
1458
1459  6.2 I have a closed-source program, can I use the libcurl library?
1460
1461  Yes!
1462
1463  libcurl does not put any restrictions on the program that uses the library.
1464
1465  6.3 I have a BSD licensed program, can I use the libcurl library?
1466
1467  Yes!
1468
1469  libcurl does not put any restrictions on the program that uses the library.
1470
1471  6.4 I have a program that uses LGPL libraries, can I use libcurl?
1472
1473  Yes!
1474
1475  The LGPL license doesn't clash with other licenses.
1476
1477  6.5 Can I modify curl/libcurl for my program and keep the changes secret?
1478
1479  Yes!
1480
1481  The MIT/X derivate license practically allows you to do almost anything with
1482  the sources, on the condition that the copyright texts in the sources are
1483  left intact.
1484
1485  6.6 Can you please change the curl/libcurl license to XXXX?
1486
1487  No.
1488
1489  We have carefully picked this license after years of development and
1490  discussions and a large amount of people have contributed with source code
1491  knowing that this is the license we use. This license puts the restrictions
1492  we want on curl/libcurl and it does not spread to other programs or
1493  libraries that use it. It should be possible for everyone to use libcurl or
1494  curl in their projects, no matter what license they already have in use.
1495
1496  6.7 What are my obligations when using libcurl in my commercial apps?
1497
1498  Next to none. All you need to adhere to is the MIT-style license (stated in
1499  the COPYING file) which basically says you have to include the copyright
1500  notice in "all copies" and that you may not use the copyright holder's name
1501  when promoting your software.
1502
1503  You do not have to release any of your source code.
1504
1505  You do not have to reveal or make public any changes to the libcurl source
1506  code.
1507
1508  You do not have to broadcast to the world that you are using libcurl within
1509  your app.
1510
1511  All we ask is that you disclose "the copyright notice and this permission
1512  notice" somewhere. Most probably like in the documentation or in the section
1513  where other third party dependencies already are mentioned and acknowledged.
1514
1515  As can be seen here: https://curl.haxx.se/docs/companies.html and elsewhere,
1516  more and more companies are discovering the power of libcurl and take
1517  advantage of it even in commercial environments.
1518
1519
15207. PHP/CURL Issues
1521
1522  7.1 What is PHP/CURL?
1523
1524  The module for PHP that makes it possible for PHP programs to access curl-
1525  functions from within PHP.
1526
1527  In the cURL project we call this module PHP/CURL to differentiate it from
1528  curl the command line tool and libcurl the library. The PHP team however
1529  does not refer to it like this (for unknown reasons). They call it plain
1530  CURL (often using all caps) or sometimes ext/curl, but both cause much
1531  confusion to users which in turn gives us a higher question load.
1532
1533  7.2 Who wrote PHP/CURL?
1534
1535  PHP/CURL was initially written by Sterling Hughes.
1536
1537  7.3 Can I perform multiple requests using the same handle?
1538
1539  Yes - at least in PHP version 4.3.8 and later (this has been known to not
1540  work in earlier versions, but the exact version when it started to work is
1541  unknown to me).
1542
1543  After a transfer, you just set new options in the handle and make another
1544  transfer. This will make libcurl re-use the same connection if it can.
1545
1546  7.4 Does PHP/CURL have dependencies?
1547
1548  PHP/CURL is a module that comes with the regular PHP package. It depends on
1549  and uses libcurl, so you need to have libcurl installed properly before
1550  PHP/CURL can be used.
1551