source: networking/netlibs/curl.xml@ ab4fdfc

12.1 ken/TL2024 lazarus plabs/newcss rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since ab4fdfc was ab4fdfc, checked in by Pierre Labastie <pierre.labastie@…>, 4 months ago

Change all xml decl to encoding=utf-8

  • Property mode set to 100644
File size: 20.0 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 "3e9e5c2db494e7dbd4e7024b149021c9">
10 <!ENTITY curl-size "2.6 MB">
11 <!ENTITY curl-buildsize "53 MB (add 18 MB for tests)">
12 <!ENTITY curl-time "0.3 SBU (with parallelism=4; add 15 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 One test, <filename>1477</filename>, is known to fail due to
179 a missing file in the curl tarball. Some tests are flaky,
180 so if some tests have failed it's possible to
181 run a test again with: <command>(cd tests; ./runtests.pl
182 <replaceable>&lt;test ID&gt;</replaceable>)</command> (the ID of
183 failed tests are shown in the <quote><computeroutput>These test cases
184 failed:</computeroutput></quote> message).
185 </para>
186<!-- Two (of 857) tests
187fail for unknown reasons, and all tests fail is valgrind is installed. Moving
188valgrind out of $PATH is recommended if you wish to run the test suite while
189it is installed.
190
191Added by Pierre for curl-7.59.0:
192no stunnel, no valgrind, no options
193Warning: smb server unexpectedly alive
194Warning: dict server unexpectedly alive
195TESTDONE: 950 tests out of 951 reported OK: 99%
196TESTFAIL: These test cases failed: 1148
197TESTDONE: 1189 tests were considered during 362 seconds.
198__________
199
200 if stunnel and valgrind are not installed, and also most options
201 (I had rtmpdump), the tests complete without problems.
202Warning: smb server unexpectedly alive
203Warning: dict server unexpectedly alive
204TESTDONE: 938 tests out of 938 reported OK: 100%
205TESTDONE: 1175 tests were considered during 355 seconds.
206 and no. I don't have smb - so commenting the rest of this:
207 To run the test suite, issue: <command>make test</command>. Many tests
208 may fail that depend on optional dependencies that may not be installed
209 or upstream servers that may not be available, especially for tests
210 numbered 700 and above.
211 Test time may be significantly increase due to hanging tests that fail.
212__________
213Added by Bruce for curl-7.60.0:
214TESTDONE: 957 tests out of 959 reported OK: 99%
215TESTFAIL: These test cases failed: 1139 1140
216TESTDONE: 1196 tests were considered during 1184 seconds.
217From the logs, both appear to be ipv6 releated.
218
219==========
220Added by Douglas for curl-7.61.0:
221TESTDONE: 961 tests out of 961 reported OK: 100%
222TESTDONE: 1202 tests were considered during 338 seconds.
223I only have c-ares and libidn2 installed, I will likely try before release
224with all optional dependencies in the book installed.
225
226=========
2277.61.1 NOTE: The test suite is extremely noisy, complaining about verification errors.
228It's possible this is due to openssl-1.1.1, BUT 79/79 tests report as 100% OK. I had
229c-ares, libpsl, and libidn1/2 installed. - Doug
230
231========
2327.62.0: All tests passed. libpsl, c-ares, libssh2, libidn2 installed.
233All 1098 tests report OK.
234
235=======
236Added by Douglas for curl-7.64.0:
237TESTDONE: 1022 tests out of 1023 reported OK: 99%
238TESTFAIL: These tests cases failed: 323
239TESTDONE: 1235 tests were considered during 1279 seconds.
240For dependencies, I had c-ares, gnutls, libidn2, libpsl, krb5, libssh2, nghttp2,
241OpenLDAP, Samba, stunnel, and Valgrind installed.
242=======
243Added by bdubbs for curl-7.64.1:
244TESTDONE: 1022 tests out of 1025 reported OK: 99%
245TESTFAIL: These test cases failed: 323 1139 1140
246TESTDONE: 1242 tests were considered during 1483 seconds
247
248=======
249Added by renodr for curl-7.65.1:
250TESTDONE: 996 tests out of 997 reported OK: 99%
251TESTFAIL: These test cases failed: 1560
252TESTDONE: 1249 tests were considered during 1091 seconds.
253All dependencies except for externals installed.
254=======
255Added by bdubbs for curl-7.65.2:
256TESTDONE: 1034 tests out of 1036 reported OK: 99%
257TESTFAIL: These test cases failed: 323 1560
258TESTDONE: 1254 tests were considered during 1362 seconds.
259Time above does not include test build time.
260All dependencies except for externals installed.
261=======
262Added by bdubbs for curl-7.65.3:
263TESTDONE: 1031 tests out of 1036 reported OK: 99%
264TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
265TESTDONE: 1254 tests were considered during 1364 seconds.
266
267The tests that fail seem to be somewhat random. What happened between
268yesterday and today that that tests 1139 1140 1173 now fail?
269
270=======
271Added by bdubbs for curl-7.68.0:
272TESTDONE: 1066 tests out of 1071 reported OK: 99%
273TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
274TESTDONE: 1290 tests were considered during 1515 seconds.
275
276=======
277Added by bdubbs for curl-7.69.0:
278TESTDONE: 074 tests out of 1079 reported OK: 99%
279TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
280TESTDONE: 1320 tests were considered during 1514 seconds.
281
282For curl-7.69.1, 1082 tests out of 1086 reported OK. 1560 now passes.
2831330 tests were considered during 1528 seconds.
284
285======
286Added by renodr for curl-7.70.0:
287TESTDONE: 1062 tests out of 1062 reported OK: 100%
288TESTDONE: 1352 tests were considered during 1218 seconds.
289Tests were ran with all dependencies present except for stunnel.
290impacket only seems to add one extra test to the mix as well.
291
292======
293Added by renodr for curl-7.71.0:
294TESTDONE: 1072 tests out of 1072 reported OK: 100%
295TESTDONE: 1364 tests were considered during 1202 seconds.
296Tests were run similarly to 7.70.0 - all deps except for stunnel.
297
298======
299Added by renodr for curl-7.71.1:
300TESTDONE: 1076 tests out of 1076 reported OK: 100%
301TESTDONE: 1368 tests were considered during 1207 seconds.
302Tests were run similarly to 7.71.0, including impacket, but no stunnel.
303
304======
305Added by renodr for curl-7.72.0:
306TESTDONE: 1094 tests out of 1097 reported OK: 99%
307TESTFAIL: These test cases failed: 1700 1701 1702
308TESTDONE: 1374 tests were considered during 1285 seconds.
309Tests have all BLFS dependencies with the exception of stunnel;
310and the optional impacket python module was installed.
311Tests seem to be failing due to a missing 'nghttpx' executable
312used to start a test server.
313
314======
315Added by renodr for curl-7.73.0:
316TESTDONE: 1121 tests out of 1121 reported OK: 100%
317TESTDONE: 1387 tests were considered during 1303 seconds.
318Tests have all BLFS dependencies installed with the exception of stunnel,
319as well as the optional impacket installed.
320
321======
322Added by renodr for curl-7.74.0:
323TESTDONE: 1119 tests out of 1119 reported OK: 100%
324TESTDONE: 1388 tests were considered during 1370 seconds.
325Tests have all BLFS dependencies installed, as well as impacket.
326stunnel not installed.
327
328======
329Added by bdubbs for curl-7.79.0:
330TESTDONE: 1432 tests were considered during 1543 seconds.
331TESTDONE: 1208 tests out of 1212 reported OK: 99%
332
333Tests have all BLFS dependencies installed but without impacket.
334
335======
336Added by plabs for curl-7.79.1:
337TESTDONE: 1434 tests were considered during 1652 seconds.
338TESTDONE: 1171 tests out of 1171 reported OK: 100%
339Tests have all BLFS dependencies installed except stunnel but without impacket.
340====
341bdubbs curl-7.83.0 2022-04-28
342TESTDONE: 1497 tests were considered during 1666 seconds.
343TESTDONE: 1252 tests out of 1256 reported OK: 99%
344TESTFAIL: These test cases failed: 1139 1140 1173 1177
345====
346Added by xry111 for curl-7.85.0 on 2022-09-01:
347With:
348 all BLFS dependencies but stunnel installed
349 libssh2-2.10.0 patched with libssh2-1.10.0-upstream_fix-1.patch
350 with-{gssapi,libssh2} enable-threaded-resolver
351TESTDONE: 1520 tests were considered during 508 seconds.
352TESTDONE: 1327 tests out of 1328 reported OK: 99%
353TESTFAIL: These test cases failed: 1459
354 It is a SCP test for bad .known_hosts file and fails because of a mismatch
355 of error codes, I don't think it indicated a serious issue.
356[renodr] - Test results for 7.85.0 (2022-09-03), no libssh2 enabled or gssapi
357TESTDONE: 1528 tests were considered during 2041 seconds.
358TESTDONE: 1326 tests out of 1326 reported OK: 100%
359
360[renodr] - Test results for 7.87.0 (2022-12-30)
361TESTDONE: 1559 tests were considered during 2112 seconds.
362TESTDONE: 1342 tests out of 1342 reported OK: 100%
363libssh2 installed and enabled
364
365[renodr] - Test results for 8.0.1 (2023-03-27)
366TESTDONE: 1593 tests were considered during 4761 seconds.
367TESTDONE: 1356 tests out of 1356 reported OK: 100%
368All BLFS dependencies installed.
369Note that if I move /usr/bin/valgrind to a place where it can't be found, I get
370TESTDONE: 1593 tests were considered during 595 seconds.
371TESTDONE: 1356 tests out of 1356 reported OK: 100%
372It appears that every test is now run under valgrind.
373
374[renodr] - Test results for 8.2.1 (2023-07-26)
375TESTDONE: 1611 tests were considered during 2129 seconds.
376TESTDONE: 1369 tests out of 1369 reported OK: 100%
377All BLFS dependencies installed, and run under valgrind.
378
379[renodr] - Test results for 8.3.0 (2023-09-14)
380TESTDONE: 1635 tests were considered during 4068 seconds.
381TESTDONE: 1386 tests out of 1387 reported OK: 99%
382TESTFAIL: These test cases failed: 1474
383All BLFS dependencies installed, and run under valgrind. Test 1474 is flaky.
384
385[renodr] - Test results for 8.4.0 (2023-10-11)
386TESTDONE: 1646 tests were considered during 2290 seconds.
387TESTDONE: 1449 tests out of 1452 reported OK: 99%
388TESTFAIL: These test cases failed: 1474 3021 3022
389All BLFS dependencies are installed, and the tests were run with Valgrind
390installed as well. Test 3021 and 3022 fails due to incompatibilities with
391our version of SSH. See https://github.com/curl/curl/issues/12096
392Test 1474 is still flaky.
393-->
394
395 <para>
396 Now, as the <systemitem class="username">root</systemitem>
397 user:
398 </para>
399
400<screen role="root"><userinput>make install &amp;&amp;
401
402rm -rf docs/examples/.deps &amp;&amp;
403
404find docs \( -name Makefile\* -o \
405 -name \*.1 -o \
406 -name \*.3 -o \
407 -name CMakeLists.txt \) -delete &amp;&amp;
408
409cp -v -R docs -T /usr/share/doc/curl-&curl-version;</userinput></screen>
410
411 <para>
412 To run some simple verification tests on the newly installed
413 <command>curl</command>, issue the following commands:
414 <command>curl --trace-ascii debugdump.txt https://www.example.com/</command>
415 and
416 <command>curl --trace-ascii d.txt --trace-time https://example.com/</command>.
417 Inspect the locally created trace files <filename>debugdump.txt</filename>
418 and <filename>d.txt</filename>, which contains version information,
419 downloaded files information, etc. One file has the time for each action logged.
420 </para>
421 </sect2>
422
423 <sect2 role="commands">
424 <title>Command Explanations</title>
425
426 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
427 href="../../xincludes/static-libraries.xml"/>
428
429 <para>
430 <parameter>--enable-threaded-resolver</parameter>: This switch enables
431 <application>cURL</application>'s builtin threaded DNS resolver.
432 </para>
433
434 <para>
435 <parameter>--with-ca-path=/etc/ssl/certs</parameter>: This
436 switch sets the location of the BLFS Certificate Authority store.
437 </para>
438
439 <para>
440 <parameter>--with-openssl</parameter>: This parameter chooses
441 <application>OpenSSL</application> as SSL/TLS implementation.
442 This seems mandatory now.
443 </para>
444
445 <para>
446 <option>--with-gssapi</option>: This parameter adds
447 <application>Kerberos 5</application> support to
448 <filename class="libraryfile">libcurl</filename>.
449 </para>
450
451 <para>
452 <option>--without-ssl --with-gnutls</option>: Use this switch to
453 build with <application>GnuTLS</application> support
454 instead of <application>OpenSSL</application> for SSL/TLS.
455 </para>
456
457 <para>
458 <option>--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt</option>: Use
459 this switch instead of <parameter>--with-ca-path</parameter> if
460 building with <application>GnuTLS</application> support
461 instead of <application>OpenSSL</application> for SSL/TLS.
462 </para>
463
464 <para>
465 <option>--with-libssh2</option>: This parameter adds
466 <application>SSH</application> support to cURL. This is disabled
467 by default.
468 </para>
469
470 <para>
471 <option>--enable-ares</option>: This parameter adds
472 support for DNS resolution through the c-ares library. It overrides
473 <parameter>--enable-threaded-resolver</parameter> and is not widely
474 tested by the editors.
475 </para>
476
477 <para>
478 <command>find docs ... -exec rm {} \;</command>: This command removes
479 <filename>Makefiles</filename> and man files from the documentation
480 directory that would otherwise be installed by the commands that follow.
481 </para>
482
483 </sect2>
484
485 <sect2 role="content">
486 <title>Contents</title>
487
488 <segmentedlist>
489 <segtitle>Installed Programs</segtitle>
490 <segtitle>Installed Library</segtitle>
491 <segtitle>Installed Directories</segtitle>
492
493 <seglistitem>
494 <seg>
495 curl and curl-config
496 </seg>
497 <seg>
498 libcurl.so
499 </seg>
500 <seg>
501 /usr/include/curl and
502 /usr/share/doc/curl-&curl-version;
503 </seg>
504 </seglistitem>
505 </segmentedlist>
506
507 <variablelist>
508 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
509 <?dbfo list-presentation="list"?>
510 <?dbhtml list-presentation="table"?>
511
512 <varlistentry id="curl-prog">
513 <term><command>curl</command></term>
514 <listitem>
515 <para>
516 is a command line tool for transferring files with URL syntax
517 </para>
518 <indexterm zone="curl curl-prog">
519 <primary sortas="b-curl">curl</primary>
520 </indexterm>
521 </listitem>
522 </varlistentry>
523
524 <varlistentry id="curl-config">
525 <term><command>curl-config</command></term>
526 <listitem>
527 <para>
528 prints information about the last compile, like libraries
529 linked to and prefix setting
530 </para>
531 <indexterm zone="curl curl-config">
532 <primary sortas="b-curl-config">curl-config</primary>
533 </indexterm>
534 </listitem>
535 </varlistentry>
536
537 <varlistentry id="libcurl">
538 <term><filename class="libraryfile">libcurl.so</filename></term>
539 <listitem>
540 <para>
541 provides the API functions required by
542 <command>curl</command> and other programs
543 </para>
544 <indexterm zone="curl libcurl">
545 <primary sortas="c-libcurl">libcurl.so</primary>
546 </indexterm>
547 </listitem>
548 </varlistentry>
549
550 </variablelist>
551
552 </sect2>
553
554</sect1>
Note: See TracBrowser for help on using the repository browser.