source: networking/netlibs/curl.xml@ 3026cde

11.0 lazarus qt5new trunk
Last change on this file since 3026cde was 3026cde, checked in by Thomas Trepl (Moody) <thomas@…>, 4 months ago

Fix some typos

  • Property mode set to 100644
File size: 16.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 "3cf78c539cae019cf96ba38571706e06">
10 <!ENTITY curl-size "2.4 MB">
11 <!ENTITY curl-buildsize "103 MB (add 17 MB for tests)">
12 <!ENTITY curl-time "0.3 SBU (add 14 SBU for tests)">
13]>
14
15<sect1 id="curl" xreflabel="cURL-&curl-version;">
16 <?dbhtml filename="curl.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>cURL-&curl-version;</title>
23
24 <indexterm zone="curl">
25 <primary sortas="a-cURL">cURL</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to cURL</title>
30
31 <para>
32 The <application>cURL</application> package contains an utility
33 and a library used for transferring files with URL syntax to any of
34 the following protocols: FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP,
35 TELNET, DICT, LDAP, LDAPS and FILE. Its ability to both download
36 and upload files can be incorporated into other programs to support
37 functions like streaming media.
38 </para>
39
40 &lfs101_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&curl-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&curl-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &curl-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &curl-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &curl-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &curl-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75<!--
76 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
77 <itemizedlist spacing="compact">
78 <listitem>
79 <para>
80 Required patch:
81 <ulink url="&patch-root;/curl-&curl-version;-function_naming-1.patch"/>
82 </para>
83 </listitem>
84 </itemizedlist>
85-->
86
87 <bridgehead renderas="sect3">cURL Dependencies</bridgehead>
88
89 <bridgehead renderas="sect4">Recommended</bridgehead>
90 <para role="recommended">
91 <xref role="runtime" linkend="make-ca"/> (runtime)
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <xref linkend="brotli"/>,
97 <xref linkend="c-ares"/>,
98 <xref linkend="gnutls"/>,
99 <xref linkend="libidn2"/>,
100 <xref linkend="libpsl"/>,
101 <xref linkend="libssh2"/>,
102 <xref linkend="mitkrb"/>,
103 <xref linkend="nghttp2"/>,
104 <xref linkend="openldap"/>,
105 <xref linkend="samba"/>,
106 <ulink url="https://www.secureauth.com/labs/open-source-tools/impacket/">impacket</ulink>,
107 <ulink url="https://launchpad.net/libmetalink/">libmetalink</ulink>,
108 <ulink url="http://rtmpdump.mplayerhq.hu/">librtmp</ulink>,
109 <ulink url="https://github.com/ngtcp2/ngtcp2/">ngtcp2</ulink>,
110 <!--<ulink url="https://tls.mbed.org/">mbed TLS</ulink> (formerly known as
111 PolarSSL), and -->
112 <!-- mbedTLS/PolarSSL support was removed in 7.65.1 -->
113 <ulink url="https://github.com/cloudflare/quiche">quiche</ulink>, and
114 <ulink url="http://spnego.sourceforge.net/">SPNEGO</ulink>
115 </para>
116
117 <bridgehead renderas="sect4">Optional if Running the Test Suite</bridgehead>
118 <para role="optional">
119 <!-- stunnel is still listed in the docs as required, but 7.58.0
120 tests completed happily without it, although the test for unit1323
121 reported that the tool set in the test case does not exist - ken -->
122 <xref linkend="stunnel"/> (for the HTTPS and FTPS tests) and
123 <xref linkend="valgrind"/> (this will slow the tests down and may cause failures.)
124 </para>
125
126 <para condition="html" role="usernotes">User Notes:
127 <ulink url="&blfs-wiki;/curl"/>
128 </para>
129 </sect2>
130
131 <sect2 role="installation">
132 <title>Installation of cURL</title>
133
134 <para>
135 First, adapt the tests to python3:
136 </para>
137
138<screen><userinput remap="pre">grep -rl '#!.*python$' | xargs sed -i '1s/python/&amp;3/'</userinput></screen>
139
140 <para>
141 Install <application>cURL</application> by running the following
142 commands:
143 </para>
144
145<screen><userinput>./configure --prefix=/usr \
146 --disable-static \
147 --with-openssl \
148 --enable-threaded-resolver \
149 --with-ca-path=/etc/ssl/certs &amp;&amp;
150make</userinput></screen>
151
152<!--
153 For version 7.54.1 I got:
154 TESTDONE: 869 tests out of 869 reported OK: 100%
155 TESTDONE: 1092 tests were considered during 1080 seconds
156
157 <para>
158 Running the test suite is optional. About 2% of the tests fail. Increase
159 in test time by each failed test is about 10%. Tests SBU above was
160 obtained disabling failing tests, with:
161 </para>
162
163 2017-10-29 - bdubbs
164 For version 7.56.1 I had a lot of test failures which included long
165 timeouts. Could not determine the cause of the timeouts or failures,
166 but I was missing c-ares, MIT Kerberos, ldap, samba, and the six
167 external packages.
168
169 2017-12-01 - bdubbs
170 Still a lot of test failures. I did have c-ares, Kerberos, and ldap
171 installed this time. Best guess is that servers are not available.
172
173 2018-08-01 - renodr
174 No test failures, but I didn't have any of the optional dependencies except
175 for c-ares and libidn2. I might re-run this test suite before release with
176 all of the optional deps, but right now, it isn't a priority - rather
177 the security fix is.
178-->
179
180 <para>
181 To run the test suite, issue: <command>make test</command>.
182 <!-- Three tests, 1700, 1701, and 1702, are known to fail due to
183 missing executables from the nghttp2 package.-->
184 </para>
185<!-- Two (of 857) tests
186fail for unknown reasons, and all tests fail is valgrind is installed. Moving
187valgrind out of $PATH is recommended if you wish to run the test suite while
188it is installed.
189
190Added by Pierre for curl-7.59.0:
191no stunnel, no valgrind, no options
192Warning: smb server unexpectedly alive
193Warning: dict server unexpectedly alive
194TESTDONE: 950 tests out of 951 reported OK: 99%
195TESTFAIL: These test cases failed: 1148
196TESTDONE: 1189 tests were considered during 362 seconds.
197__________
198
199 if stunnel and valgrind are not installed, and also most options
200 (I had rtmpdump), the tests complete without problems.
201Warning: smb server unexpectedly alive
202Warning: dict server unexpectedly alive
203TESTDONE: 938 tests out of 938 reported OK: 100%
204TESTDONE: 1175 tests were considered during 355 seconds.
205 and no. I don't have smb - so commenting the rest of this:
206 To run the test suite, issue: <command>make test</command>. Many tests
207 may fail that depend on optional dependencies that may not be installed
208 or upstream servers that may not be available, especially for tests
209 numbered 700 and above.
210 Test time may be significantly increase due to hanging tests that fail.
211__________
212Added by Bruce for curl-7.60.0:
213TESTDONE: 957 tests out of 959 reported OK: 99%
214TESTFAIL: These test cases failed: 1139 1140
215TESTDONE: 1196 tests were considered during 1184 seconds.
216From the logs, both appear to be ipv6 releated.
217
218==========
219Added by Douglas for curl-7.61.0:
220TESTDONE: 961 tests out of 961 reported OK: 100%
221TESTDONE: 1202 tests were considered during 338 seconds.
222I only have c-ares and libidn2 installed, I will likely try before release
223with all optional dependencies in the book installed.
224
225=========
2267.61.1 NOTE: The test suite is extremely noisy, complaining about verification errors.
227It's possible this is due to openssl-1.1.1, BUT 79/79 tests report as 100% OK. I had
228c-ares, libpsl, and libidn1/2 installed. - Doug
229
230========
2317.62.0: All tests passed. libpsl, c-ares, libssh2, libidn2 installed.
232All 1098 tests report OK.
233
234=======
235Added by Douglas for curl-7.64.0:
236TESTDONE: 1022 tests out of 1023 reported OK: 99%
237TESTFAIL: These tests cases failed: 323
238TESTDONE: 1235 tests were considered during 1279 seconds.
239For dependencies, I had c-ares, gnutls, libidn2, libpsl, krb5, libssh2, nghttp2,
240OpenLDAP, Samba, stunnel, and Valgrind installed.
241=======
242Added by bdubbs for curl-7.64.1:
243TESTDONE: 1022 tests out of 1025 reported OK: 99%
244TESTFAIL: These test cases failed: 323 1139 1140
245TESTDONE: 1242 tests were considered during 1483 seconds
246
247=======
248Added by renodr for curl-7.65.1:
249TESTDONE: 996 tests out of 997 reported OK: 99%
250TESTFAIL: These test cases failed: 1560
251TESTDONE: 1249 tests were considered during 1091 seconds.
252All dependencies except for externals installed.
253=======
254Added by bdubbs for curl-7.65.2:
255TESTDONE: 1034 tests out of 1036 reported OK: 99%
256TESTFAIL: These test cases failed: 323 1560
257TESTDONE: 1254 tests were considered during 1362 seconds.
258Time above does not include test build time.
259All dependencies except for externals installed.
260=======
261Added by bdubbs for curl-7.65.3:
262TESTDONE: 1031 tests out of 1036 reported OK: 99%
263TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
264TESTDONE: 1254 tests were considered during 1364 seconds.
265
266The tests that fail seem to be somewhat random. What happened between
267yesterday and today that that tests 1139 1140 1173 now fail?
268
269=======
270Added by bdubbs for curl-7.68.0:
271TESTDONE: 1066 tests out of 1071 reported OK: 99%
272TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
273TESTDONE: 1290 tests were considered during 1515 seconds.
274
275=======
276Added by bdubbs for curl-7.69.0:
277TESTDONE: 074 tests out of 1079 reported OK: 99%
278TESTFAIL: These test cases failed: 323 1139 1140 1173 1560
279TESTDONE: 1320 tests were considered during 1514 seconds.
280
281For curl-7.69.1, 1082 tests out of 1086 reported OK. 1560 now passes.
2821330 tests were considered during 1528 seconds.
283
284======
285Added by renodr for curl-7.70.0:
286TESTDONE: 1062 tests out of 1062 reported OK: 100%
287TESTDONE: 1352 tests were considered during 1218 seconds.
288Tests were ran with all dependencies present except for stunnel.
289impacket only seems to add one extra test to the mix as well.
290
291======
292Added by renodr for curl-7.71.0:
293TESTDONE: 1072 tests out of 1072 reported OK: 100%
294TESTDONE: 1364 tests were considered during 1202 seconds.
295Tests were run similarly to 7.70.0 - all deps except for stunnel.
296
297======
298Added by renodr for curl-7.71.1:
299TESTDONE: 1076 tests out of 1076 reported OK: 100%
300TESTDONE: 1368 tests were considered during 1207 seconds.
301Tests were run similarly to 7.71.0, including impacket, but no stunnel.
302
303======
304Added by renodr for curl-7.72.0:
305TESTDONE: 1094 tests out of 1097 reported OK: 99%
306TESTFAIL: These test cases failed: 1700 1701 1702
307TESTDONE: 1374 tests were considered during 1285 seconds.
308Tests have all BLFS dependencies with the exception of stunnel;
309and the optional impacket python module was installed.
310Tests seem to be failing due to a missing 'nghttpx' executable
311used to start a test server.
312
313======
314Added by renodr for curl-7.73.0:
315TESTDONE: 1121 tests out of 1121 reported OK: 100%
316TESTDONE: 1387 tests were considered during 1303 seconds.
317Tests have all BLFS dependencies installed with the exception of stunnel,
318as well as the optional impacket installed.
319
320======
321Added by renodr for curl-7.74.0:
322TESTDONE: 1119 tests out of 1119 reported OK: 100%
323TESTDONE: 1388 tests were considered during 1370 seconds.
324Tests have all BLFS dependencies installed, as well as impacket.
325stunnel not installed.
326-->
327
328 <para>
329 Now, as the <systemitem class="username">root</systemitem>
330 user:
331 </para>
332
333<screen role="root"><userinput>make install &amp;&amp;
334
335rm -rf docs/examples/.deps &amp;&amp;
336
337find docs \( -name Makefile\* -o -name \*.1 -o -name \*.3 \) -exec rm {} \; &amp;&amp;
338
339install -v -d -m755 /usr/share/doc/curl-&curl-version; &amp;&amp;
340cp -v -R docs/* /usr/share/doc/curl-&curl-version;</userinput></screen>
341
342 <para>
343 Simple tests to the new installed <command>curl</command>:
344 <command>curl --trace-ascii debugdump.txt http://www.example.com/</command>
345 and
346 <command>curl --trace-ascii d.txt --trace-time http://example.com/</command>.
347 Inspect the locally created trace files <filename>debugdump.txt</filename>
348 and <filename>d.txt</filename>, which contain version downloaded
349 files information, etc. One file has the time for each action logged.
350 </para>
351 </sect2>
352
353 <sect2 role="commands">
354 <title>Command Explanations</title>
355
356 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
357 href="../../xincludes/static-libraries.xml"/>
358
359 <para>
360 <parameter>--enable-threaded-resolver</parameter>: This switch enables
361 <application>cURL</application>'s builtin threaded DNS resolver.
362 </para>
363
364 <para>
365 <parameter>--with-ca-path=/etc/ssl/certs</parameter>: This
366 switch sets the location of the BLFS Certificate Authority store.
367 </para>
368
369 <para>
370 <option>--with-openssl</option>: This parameter chooses
371 <application>OpenSSL</application> as SSL/TLS implementation.
372 This seems mandatory now.
373 </para>
374
375 <para>
376 <option>--with-gssapi</option>: This parameter adds
377 <application>Kerberos 5</application> support to
378 <filename class="libraryfile">libcurl</filename>.
379 </para>
380
381 <para>
382 <option>--without-ssl --with-gnutls</option>: Use to
383 build with <application>GnuTLS</application> support
384 instead of <application>OpenSSL</application> for SSL/TLS.
385 </para>
386
387 <para>
388 <option>--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt</option>: Use
389 this switch instead of <parameter>--with-ca-path</parameter> if
390 building with <application>GnuTLS</application> support
391 instead of <application>OpenSSL</application> for SSL/TLS.
392 </para>
393
394 <para>
395 <option>--with-libssh2</option>: This paramater adds
396 <application>SSH</application> support to cURL. This is disabled
397 by default.
398 </para>
399
400 <para>
401 <option>--enable-ares</option>: This paramater adds
402 support for DNS resolution through the c-ares library. It is disabled
403 by default, but does speed up DNS resolution queries.
404 </para>
405
406 <para>
407 <command>find docs ... -exec rm {} \;</command>: This command removes
408 <filename>Makefiles</filename> and man files from the documentation
409 directory that would otherwise be installed by the commands that follow.
410 </para>
411
412 </sect2>
413
414 <sect2 role="content">
415 <title>Contents</title>
416
417 <segmentedlist>
418 <segtitle>Installed Programs</segtitle>
419 <segtitle>Installed Library</segtitle>
420 <segtitle>Installed Directories</segtitle>
421
422 <seglistitem>
423 <seg>
424 curl and curl-config
425 </seg>
426 <seg>
427 libcurl.so
428 </seg>
429 <seg>
430 /usr/include/curl and
431 /usr/share/doc/curl-&curl-version;
432 </seg>
433 </seglistitem>
434 </segmentedlist>
435
436 <variablelist>
437 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
438 <?dbfo list-presentation="list"?>
439 <?dbhtml list-presentation="table"?>
440
441 <varlistentry id="curl-prog">
442 <term><command>curl</command></term>
443 <listitem>
444 <para>
445 is a command line tool for transferring files with URL syntax
446 </para>
447 <indexterm zone="curl curl-prog">
448 <primary sortas="b-curl">curl</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="curl-config">
454 <term><command>curl-config</command></term>
455 <listitem>
456 <para>
457 prints information about the last compile, like libraries
458 linked to and prefix setting
459 </para>
460 <indexterm zone="curl curl-config">
461 <primary sortas="b-curl-config">curl-config</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
466 <varlistentry id="libcurl">
467 <term><filename class="libraryfile">libcurl.so</filename></term>
468 <listitem>
469 <para>
470 provides the API functions required by
471 <command>curl</command> and other programs
472 </para>
473 <indexterm zone="curl libcurl">
474 <primary sortas="c-libcurl">libcurl.so</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 </variablelist>
480
481 </sect2>
482
483</sect1>
Note: See TracBrowser for help on using the repository browser.