source: networking/netlibs/curl.xml@ b60a77fb

12.1 gimp3 ken/TL2024 lazarus rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since b60a77fb was 1aa19207, checked in by Bruce Dubbs <bdubbs@…>, 6 months ago

Update to curl-8.6.0.

  • Property mode set to 100644
File size: 20.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY curl-download-http "https://curl.se/download/curl-&curl-version;.tar.xz">
8 <!ENTITY curl-download-ftp " ">
9 <!ENTITY curl-md5sum "8f28f7e08c91cc679a45fccf66184fbc">
10 <!ENTITY curl-size "2.5 MB">
11 <!ENTITY curl-buildsize "42 MB (add 18 MB for tests)">
12 <!ENTITY curl-time "0.2 SBU (with parallelism=4; add 4.1 SBU for tests (without valgrind, add 36 SBU with valgrind))">
13]>
14
15<sect1 id="curl" xreflabel="cURL-&curl-version;">
16 <?dbhtml filename="curl.html"?>
17
18
19 <title>cURL-&curl-version;</title>
20
21 <indexterm zone="curl">
22 <primary sortas="a-cURL">cURL</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to cURL</title>
27
28 <para>
29 The <application>cURL</application> package contains an utility
30 and a library used for transferring files with URL syntax to any of
31 the following protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP,
32 HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTSP, SMB, SMBS,
33 SMTP, SMPTS, TELNET, and TFTP. Its ability to both download
34 and upload files can be incorporated into other programs to support
35 functions like streaming media.
36 </para>
37
38 &lfs120_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&curl-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&curl-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &curl-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &curl-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &curl-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &curl-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73<!--
74 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Required patch:
79 <ulink url="&patch-root;/curl-&curl-version;-function_naming-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>
83-->
84
85 <bridgehead renderas="sect3">cURL Dependencies</bridgehead>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref role="runtime" linkend="make-ca"/> (runtime)
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="brotli"/>,
95 <xref linkend="c-ares"/>,
96 <xref linkend="gnutls"/>,
97 <xref linkend="libidn2"/>,
98 <xref linkend="libpsl"/>,
99 <xref linkend="libssh2"/>,
100 <xref linkend="mitkrb"/>,
101 <xref linkend="nghttp2"/>,
102 <xref linkend="openldap"/>,
103 <!-- cURL implements the SMB client with own code. Samba is only
104 used for /usr/bin/ntlm_auth helper. The path is correctly
105 guessed even if Samba is not installed, so "runtime". -->
106 <xref role='runtime' linkend="samba"/>
107 (runtime, for NTLM authentication),
108 <ulink url="https://www.gnu.org/software/gsasl/">gsasl</ulink>,
109 <ulink url="https://www.secureauth.com/labs/open-source-tools/impacket/">impacket</ulink>,
110 <ulink url="https://launchpad.net/libmetalink/">libmetalink</ulink>,
111 <ulink url="https://rtmpdump.mplayerhq.hu/">librtmp</ulink>,
112 <ulink url="https://github.com/ngtcp2/ngtcp2/">ngtcp2</ulink>,
113 <!--<ulink url="https://tls.mbed.org/">mbed TLS</ulink> (formerly known as
114 PolarSSL), and -->
115 <!-- mbedTLS/PolarSSL support was removed in 7.65.1 -->
116 <ulink url="https://github.com/cloudflare/quiche">quiche</ulink>, and
117 <ulink url="https://spnego.sourceforge.net/">SPNEGO</ulink>
118 </para>
119
120 <bridgehead renderas="sect4">Optional if Running the Test Suite</bridgehead>
121 <para role="optional">
122 <!-- stunnel is still listed in the docs as required, but 7.58.0
123 tests completed happily without it, although the test for unit1323
124 reported that the tool set in the test case does not exist - ken -->
125 <xref linkend="apache"/> and
126 <xref linkend="stunnel"/> (for the HTTPS and FTPS tests),
127 <xref linkend="openssh"/>, and
128 <xref linkend="valgrind"/> (this will slow the tests down and may cause failures.)
129 </para>
130
131 </sect2>
132
133 <sect2 role="installation">
134 <title>Installation of cURL</title>
135
136 <para>
137 Install <application>cURL</application> by running the following
138 commands:
139 </para>
140
141<screen><userinput>./configure --prefix=/usr \
142 --disable-static \
143 --with-openssl \
144 --enable-threaded-resolver \
145 --with-ca-path=/etc/ssl/certs &amp;&amp;
146make</userinput></screen>
147
148<!--
149 For version 7.54.1 I got:
150 TESTDONE: 869 tests out of 869 reported OK: 100%
151 TESTDONE: 1092 tests were considered during 1080 seconds
152
153 <para>
154 Running the test suite is optional. About 2% of the tests fail. Increase
155 in test time by each failed test is about 10%. Tests SBU above was
156 obtained disabling failing tests, with:
157 </para>
158
159 2017-10-29 - bdubbs
160 For version 7.56.1 I had a lot of test failures which included long
161 timeouts. Could not determine the cause of the timeouts or failures,
162 but I was missing c-ares, MIT Kerberos, ldap, samba, and the six
163 external packages.
164
165 2017-12-01 - bdubbs
166 Still a lot of test failures. I did have c-ares, Kerberos, and ldap
167 installed this time. Best guess is that servers are not available.
168
169 2018-08-01 - renodr
170 No test failures, but I didn't have any of the optional dependencies except
171 for c-ares and libidn2. I might re-run this test suite before release with
172 all of the optional deps, but right now, it isn't a priority - rather
173 the security fix is.
174-->
175
176 <para>
177 To run the test suite, issue: <command>make test</command>.
178 Foure tests are known to fail due to missing files.
179 <!--One test, <filename>1477</filename>, is known to fail due to
180 a missing file in the curl tarball.--> Some tests are flaky,
181 so if some tests have failed it's possible to
182 run a test again with: <command>(cd tests; ./runtests.pl
183 <replaceable>&lt;test ID&gt;</replaceable>)</command> (the ID of
184 failed tests are shown in the <quote><computeroutput>These test cases
185 failed:</computeroutput></quote> message).
186 </para>
187<!-- Two (of 857) tests
188fail for unknown reasons, and all tests fail is valgrind is installed. Moving
189valgrind out of $PATH is recommended if you wish to run the test suite while
190it is installed.
191
192Added by Pierre for curl-7.59.0:
193no stunnel, no valgrind, no options
194Warning: smb server unexpectedly alive
195Warning: dict server unexpectedly alive
196TESTDONE: 950 tests out of 951 reported OK: 99%
197TESTFAIL: These test cases failed: 1148
198TESTDONE: 1189 tests were considered during 362 seconds.
199__________
200
201 if stunnel and valgrind are not installed, and also most options
202 (I had rtmpdump), the tests complete without problems.
203Warning: smb server unexpectedly alive
204Warning: dict server unexpectedly alive
205TESTDONE: 938 tests out of 938 reported OK: 100%
206TESTDONE: 1175 tests were considered during 355 seconds.
207 and no. I don't have smb - so commenting the rest of this:
208 To run the test suite, issue: <command>make test</command>. Many tests
209 may fail that depend on optional dependencies that may not be installed
210 or upstream servers that may not be available, especially for tests
211 numbered 700 and above.
212 Test time may be significantly increase due to hanging tests that fail.
213__________
214Added by Bruce for curl-7.60.0:
215TESTDONE: 957 tests out of 959 reported OK: 99%
216TESTFAIL: These test cases failed: 1139 1140
217TESTDONE: 1196 tests were considered during 1184 seconds.
218From the logs, both appear to be ipv6 releated.
219
220==========
221Added by Douglas for curl-7.61.0:
222TESTDONE: 961 tests out of 961 reported OK: 100%
223TESTDONE: 1202 tests were considered during 338 seconds.
224I only have c-ares and libidn2 installed, I will likely try before release
225with all optional dependencies in the book installed.
226
227=========
2287.61.1 NOTE: The test suite is extremely noisy, complaining about verification errors.
229It's possible this is due to openssl-1.1.1, BUT 79/79 tests report as 100% OK. I had
230c-ares, libpsl, and libidn1/2 installed. - Doug
231
232========
2337.62.0: All tests passed. libpsl, c-ares, libssh2, libidn2 installed.
234All 1098 tests report OK.
235
236=======
237Added by Douglas for curl-7.64.0:
238TESTDONE: 1022 tests out of 1023 reported OK: 99%
239TESTFAIL: These tests cases failed: 323
240TESTDONE: 1235 tests were considered during 1279 seconds.
241For dependencies, I had c-ares, gnutls, libidn2, libpsl, krb5, libssh2, nghttp2,
242OpenLDAP, Samba, stunnel, and Valgrind installed.
243=======
244Added by bdubbs for curl-7.64.1:
245TESTDONE: 1022 tests out of 1025 reported OK: 99%
246TESTFAIL: These test cases failed: 323 1139 1140
247TESTDONE: 1242 tests were considered during 1483 seconds
248
249=======
250Added by renodr for curl-7.65.1:
251TESTDONE: 996 tests out of 997 reported OK: 99%
252TESTFAIL: These test cases failed: 1560
253TESTDONE: 1249 tests were considered during 1091 seconds.
254All dependencies except for externals installed.
255=======
256Added by bdubbs for curl-7.65.2:
257TESTDONE: 1034 tests out of 1036 reported OK: 99%
258TESTFAIL: These test cases failed: 323 1560
259TESTDONE: 1254 tests were considered during 1362 seconds.
260Time above does not include test build time.
261All dependencies except for externals installed.
262=======
263Added by bdubbs for curl-7.65.3:
264TESTDONE: 1031 tests out of 1036 reported OK: 99%
265TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
266TESTDONE: 1254 tests were considered during 1364 seconds.
267
268The tests that fail seem to be somewhat random. What happened between
269yesterday and today that that tests 1139 1140 1173 now fail?
270
271=======
272Added by bdubbs for curl-7.68.0:
273TESTDONE: 1066 tests out of 1071 reported OK: 99%
274TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
275TESTDONE: 1290 tests were considered during 1515 seconds.
276
277=======
278Added by bdubbs for curl-7.69.0:
279TESTDONE: 074 tests out of 1079 reported OK: 99%
280TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
281TESTDONE: 1320 tests were considered during 1514 seconds.
282
283For curl-7.69.1, 1082 tests out of 1086 reported OK. 1560 now passes.
2841330 tests were considered during 1528 seconds.
285
286======
287Added by renodr for curl-7.70.0:
288TESTDONE: 1062 tests out of 1062 reported OK: 100%
289TESTDONE: 1352 tests were considered during 1218 seconds.
290Tests were ran with all dependencies present except for stunnel.
291impacket only seems to add one extra test to the mix as well.
292
293======
294Added by renodr for curl-7.71.0:
295TESTDONE: 1072 tests out of 1072 reported OK: 100%
296TESTDONE: 1364 tests were considered during 1202 seconds.
297Tests were run similarly to 7.70.0 - all deps except for stunnel.
298
299======
300Added by renodr for curl-7.71.1:
301TESTDONE: 1076 tests out of 1076 reported OK: 100%
302TESTDONE: 1368 tests were considered during 1207 seconds.
303Tests were run similarly to 7.71.0, including impacket, but no stunnel.
304
305======
306Added by renodr for curl-7.72.0:
307TESTDONE: 1094 tests out of 1097 reported OK: 99%
308TESTFAIL: These test cases failed: 1700 1701 1702
309TESTDONE: 1374 tests were considered during 1285 seconds.
310Tests have all BLFS dependencies with the exception of stunnel;
311and the optional impacket python module was installed.
312Tests seem to be failing due to a missing 'nghttpx' executable
313used to start a test server.
314
315======
316Added by renodr for curl-7.73.0:
317TESTDONE: 1121 tests out of 1121 reported OK: 100%
318TESTDONE: 1387 tests were considered during 1303 seconds.
319Tests have all BLFS dependencies installed with the exception of stunnel,
320as well as the optional impacket installed.
321
322======
323Added by renodr for curl-7.74.0:
324TESTDONE: 1119 tests out of 1119 reported OK: 100%
325TESTDONE: 1388 tests were considered during 1370 seconds.
326Tests have all BLFS dependencies installed, as well as impacket.
327stunnel not installed.
328
329======
330Added by bdubbs for curl-7.79.0:
331TESTDONE: 1432 tests were considered during 1543 seconds.
332TESTDONE: 1208 tests out of 1212 reported OK: 99%
333
334Tests have all BLFS dependencies installed but without impacket.
335
336======
337Added by plabs for curl-7.79.1:
338TESTDONE: 1434 tests were considered during 1652 seconds.
339TESTDONE: 1171 tests out of 1171 reported OK: 100%
340Tests have all BLFS dependencies installed except stunnel but without impacket.
341====
342bdubbs curl-7.83.0 2022-04-28
343TESTDONE: 1497 tests were considered during 1666 seconds.
344TESTDONE: 1252 tests out of 1256 reported OK: 99%
345TESTFAIL: These test cases failed: 1139 1140 1173 1177
346====
347Added by xry111 for curl-7.85.0 on 2022-09-01:
348With:
349 all BLFS dependencies but stunnel installed
350 libssh2-2.10.0 patched with libssh2-1.10.0-upstream_fix-1.patch
351 with-{gssapi,libssh2} enable-threaded-resolver
352TESTDONE: 1520 tests were considered during 508 seconds.
353TESTDONE: 1327 tests out of 1328 reported OK: 99%
354TESTFAIL: These test cases failed: 1459
355 It is a SCP test for bad .known_hosts file and fails because of a mismatch
356 of error codes, I don't think it indicated a serious issue.
357[renodr] - Test results for 7.85.0 (2022-09-03), no libssh2 enabled or gssapi
358TESTDONE: 1528 tests were considered during 2041 seconds.
359TESTDONE: 1326 tests out of 1326 reported OK: 100%
360
361[renodr] - Test results for 7.87.0 (2022-12-30)
362TESTDONE: 1559 tests were considered during 2112 seconds.
363TESTDONE: 1342 tests out of 1342 reported OK: 100%
364libssh2 installed and enabled
365
366[renodr] - Test results for 8.0.1 (2023-03-27)
367TESTDONE: 1593 tests were considered during 4761 seconds.
368TESTDONE: 1356 tests out of 1356 reported OK: 100%
369All BLFS dependencies installed.
370Note that if I move /usr/bin/valgrind to a place where it can't be found, I get
371TESTDONE: 1593 tests were considered during 595 seconds.
372TESTDONE: 1356 tests out of 1356 reported OK: 100%
373It appears that every test is now run under valgrind.
374
375[renodr] - Test results for 8.2.1 (2023-07-26)
376TESTDONE: 1611 tests were considered during 2129 seconds.
377TESTDONE: 1369 tests out of 1369 reported OK: 100%
378All BLFS dependencies installed, and run under valgrind.
379
380[renodr] - Test results for 8.3.0 (2023-09-14)
381TESTDONE: 1635 tests were considered during 4068 seconds.
382TESTDONE: 1386 tests out of 1387 reported OK: 99%
383TESTFAIL: These test cases failed: 1474
384All BLFS dependencies installed, and run under valgrind. Test 1474 is flaky.
385
386[renodr] - Test results for 8.4.0 (2023-10-11)
387TESTDONE: 1646 tests were considered during 2290 seconds.
388TESTDONE: 1449 tests out of 1452 reported OK: 99%
389TESTFAIL: These test cases failed: 1474 3021 3022
390All BLFS dependencies are installed, and the tests were run with Valgrind
391installed as well. Test 3021 and 3022 fails due to incompatibilities with
392our version of SSH. See https://github.com/curl/curl/issues/12096
393Test 1474 is still flaky.
394
395[bdubbs] - Test results for 8.6.0 (2024-02-01)
396TESTDONE: 1673 tests were considered during 395 seconds.
397TESTDONE: 1355 tests out of 1360 reported OK: 99%
398TESTFAIL: These test cases failed: 1139 1140 1173 1177 1477
399Run without valgrind.
400Tests seem to looking for man pages that are missing.
401-->
402
403 <para>
404 Now, as the <systemitem class="username">root</systemitem>
405 user:
406 </para>
407
408<screen role="root"><userinput>make install &amp;&amp;
409
410rm -rf docs/examples/.deps &amp;&amp;
411
412find docs \( -name Makefile\* -o \
413 -name \*.1 -o \
414 -name \*.3 -o \
415 -name CMakeLists.txt \) -delete &amp;&amp;
416
417cp -v -R docs -T /usr/share/doc/curl-&curl-version;</userinput></screen>
418
419 <para>
420 To run some simple verification tests on the newly installed
421 <command>curl</command>, issue the following commands:
422 <command>curl --trace-ascii debugdump.txt https://www.example.com/</command>
423 and
424 <command>curl --trace-ascii d.txt --trace-time https://example.com/</command>.
425 Inspect the locally created trace files <filename>debugdump.txt</filename>
426 and <filename>d.txt</filename>, which contains version information,
427 downloaded files information, etc. One file has the time for each action logged.
428 </para>
429 </sect2>
430
431 <sect2 role="commands">
432 <title>Command Explanations</title>
433
434 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
435 href="../../xincludes/static-libraries.xml"/>
436
437 <para>
438 <parameter>--enable-threaded-resolver</parameter>: This switch enables
439 <application>cURL</application>'s builtin threaded DNS resolver.
440 </para>
441
442 <para>
443 <parameter>--with-ca-path=/etc/ssl/certs</parameter>: This
444 switch sets the location of the BLFS Certificate Authority store.
445 </para>
446
447 <para>
448 <parameter>--with-openssl</parameter>: This parameter chooses
449 <application>OpenSSL</application> as SSL/TLS implementation.
450 This seems mandatory now.
451 </para>
452
453 <para>
454 <option>--with-gssapi</option>: This parameter adds
455 <application>Kerberos 5</application> support to
456 <filename class="libraryfile">libcurl</filename>.
457 </para>
458
459 <para>
460 <option>--without-ssl --with-gnutls</option>: Use this switch to
461 build with <application>GnuTLS</application> support
462 instead of <application>OpenSSL</application> for SSL/TLS.
463 </para>
464
465 <para>
466 <option>--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt</option>: Use
467 this switch instead of <parameter>--with-ca-path</parameter> if
468 building with <application>GnuTLS</application> support
469 instead of <application>OpenSSL</application> for SSL/TLS.
470 </para>
471
472 <para>
473 <option>--with-libssh2</option>: This parameter adds
474 <application>SSH</application> support to cURL. This is disabled
475 by default.
476 </para>
477
478 <para>
479 <option>--enable-ares</option>: This parameter adds
480 support for DNS resolution through the c-ares library. It overrides
481 <parameter>--enable-threaded-resolver</parameter> and is not widely
482 tested by the editors.
483 </para>
484
485 <para>
486 <command>find docs ... -exec rm {} \;</command>: This command removes
487 <filename>Makefiles</filename> and man files from the documentation
488 directory that would otherwise be installed by the commands that follow.
489 </para>
490
491 </sect2>
492
493 <sect2 role="content">
494 <title>Contents</title>
495
496 <segmentedlist>
497 <segtitle>Installed Programs</segtitle>
498 <segtitle>Installed Library</segtitle>
499 <segtitle>Installed Directories</segtitle>
500
501 <seglistitem>
502 <seg>
503 curl and curl-config
504 </seg>
505 <seg>
506 libcurl.so
507 </seg>
508 <seg>
509 /usr/include/curl and
510 /usr/share/doc/curl-&curl-version;
511 </seg>
512 </seglistitem>
513 </segmentedlist>
514
515 <variablelist>
516 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
517 <?dbfo list-presentation="list"?>
518 <?dbhtml list-presentation="table"?>
519
520 <varlistentry id="curl-prog">
521 <term><command>curl</command></term>
522 <listitem>
523 <para>
524 is a command line tool for transferring files with URL syntax
525 </para>
526 <indexterm zone="curl curl-prog">
527 <primary sortas="b-curl">curl</primary>
528 </indexterm>
529 </listitem>
530 </varlistentry>
531
532 <varlistentry id="curl-config">
533 <term><command>curl-config</command></term>
534 <listitem>
535 <para>
536 prints information about the last compile, like libraries
537 linked to and prefix setting
538 </para>
539 <indexterm zone="curl curl-config">
540 <primary sortas="b-curl-config">curl-config</primary>
541 </indexterm>
542 </listitem>
543 </varlistentry>
544
545 <varlistentry id="libcurl">
546 <term><filename class="libraryfile">libcurl.so</filename></term>
547 <listitem>
548 <para>
549 provides the API functions required by
550 <command>curl</command> and other programs
551 </para>
552 <indexterm zone="curl libcurl">
553 <primary sortas="c-libcurl">libcurl.so</primary>
554 </indexterm>
555 </listitem>
556 </varlistentry>
557
558 </variablelist>
559
560 </sect2>
561
562</sect1>
Note: See TracBrowser for help on using the repository browser.