source: networking/netlibs/curl.xml@ 73048b77

10.0 10.1 11.0 11.1 11.2 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 73048b77 was 73048b77, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Update cURL DNS Resolution Patch to use standard patch headers

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21766 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 13.4 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.haxx.se/download/curl-&curl-version;.tar.xz">
8 <!ENTITY curl-download-ftp " ">
9 <!ENTITY curl-md5sum "7809378831d10fde18f9f6ae033cd3f3">
10 <!ENTITY curl-size "2.3 MB">
11 <!ENTITY curl-buildsize "79 MB (add 14 MB for tests)">
12 <!ENTITY curl-time "0.4 SBU (add 13 SBU for tests)">
13]>
14
15<sect1 id="curl" xreflabel="cURL-&curl-version;">
16 <?dbhtml filename="curl.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>cURL-&curl-version;</title>
24
25 <indexterm zone="curl">
26 <primary sortas="a-cURL">cURL</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to cURL</title>
31
32 <para>
33 The <application>cURL</application> package contains an utility
34 and a library used for transferring files with URL syntax to any of
35 the following protocols: FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP,
36 TELNET, DICT, LDAP, LDAPS and FILE. Its ability to both download
37 and upload files can be incorporated into other programs to support
38 functions like streaming media.
39 </para>
40
41 &lfs84_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&curl-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&curl-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &curl-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &curl-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &curl-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &curl-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
78 <itemizedlist spacing="compact">
79 <listitem>
80 <para>Patch to fix DNS resolution issues: <ulink
81 url="&patch-root;/curl-7.65.1-fix_dns_segfaults-2.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="c-ares"/>,
97 <xref linkend="gnutls"/>,
98 <xref linkend="libidn2"/>,
99 <xref linkend="libpsl"/>,
100 <xref linkend="libssh2"/>,
101 <xref linkend="mitkrb"/>,
102 <xref linkend="nghttp2"/>,
103 <xref linkend="openldap"/>,
104 <xref linkend="samba"/>,
105 <ulink url="https://github.com/google/brotli/">Brotli</ulink>,
106 <ulink url="https://launchpad.net/libmetalink/">libmetalink</ulink>,
107 <ulink url="http://rtmpdump.mplayerhq.hu/">librtmp</ulink>, and
108 <!--<ulink url="https://tls.mbed.org/">mbed TLS</ulink> (formerly known as
109 PolarSSL), and -->
110 <!-- mbedTLS/PolarSSL support was removed in 7.65.1 -->
111 <ulink url="http://spnego.sourceforge.net/">SPNEGO</ulink>
112 </para>
113
114 <bridgehead renderas="sect4">Optional if Running the Test Suite</bridgehead>
115 <para role="optional">
116 <!-- stunnel is still listed in the docs as required, but 7.58.0
117 tests completed happily without it, although the test for unit1323
118 reported that the tool set in the test case does not exist - ken -->
119 <xref linkend="stunnel"/> (for the HTTPS and FTPS tests) and
120 <xref linkend="valgrind"/> (this will slow the tests down and may cause failures.)
121 </para>
122
123 <para condition="html" role="usernotes">User Notes:
124 <ulink url="&blfs-wiki;/curl"/>
125 </para>
126 </sect2>
127
128 <sect2 role="installation">
129 <title>Installation of cURL</title>
130
131 <para>
132 First, apply a patch to fix DNS resolution issues:
133 </para>
134
135<screen><userinput>patch -Np1 -i ../curl-7.65.1-fix_dns_segfaults-1.patch</userinput></screen>
136
137
138 <para>
139 Install <application>cURL</application> by running the following
140 commands:
141 </para>
142
143<screen><userinput>./configure --prefix=/usr \
144 --disable-static \
145 --enable-threaded-resolver \
146 --with-ca-path=/etc/ssl/certs &amp;&amp;
147make</userinput></screen>
148
149<!--
150 For version 7.54.1 I got:
151 TESTDONE: 869 tests out of 869 reported OK: 100%
152 TESTDONE: 1092 tests were considered during 1080 seconds
153
154 <para>
155 Running the test suite is optional. About 2% of the tests fail. Increase
156 in test time by each failed test is about 10%. Tests SBU above was
157 obtained disabling failing tests, with:
158 </para>
159
160 2017-10-29 - bdubbs
161 For version 7.56.1 I had a lot of test failures which included long
162 timeouts. Could not determine the cause of the timeouts or failures,
163 but I was missing c-ares, MIT Kerberos, ldap, samba, and the six
164 external packages.
165
166 2017-12-01 - bdubbs
167 Still a lot of test failures. I did have c-ares, Kerberos, and ldap
168 installed this time. Best guess is that servers are not available.
169
170 2018-08-01 - renodr
171 No test failures, but I didn't have any of the optional dependencies except
172 for c-ares and libidn2. I might re-run this test suite before release with
173 all of the optional deps, but right now, it isn't a priority - rather
174 the security fix is.
175-->
176
177 <para>
178 To run the test suite, issue: <command>make test</command>.
179 Test 1560 is known to fail.
180 <!-- Two (of 857) tests
181 fail for unknown reasons, and all tests fail is valgrind is installed. Moving
182 valgrind out of $PATH is recommended if you wish to run the test suite while
183 it is installed. -->
184<!--
185Added by Pierre for curl-7.59.0:
186no stunnel, no valgrind, no options
187Warning: smb server unexpectedly alive
188Warning: dict server unexpectedly alive
189TESTDONE: 950 tests out of 951 reported OK: 99%
190TESTFAIL: These test cases failed: 1148
191TESTDONE: 1189 tests were considered during 362 seconds.
192__________
193
194 if stunnel and valgrind are not installed, and also most options
195 (I had rtmpdump), the tests complete without problems.
196Warning: smb server unexpectedly alive
197Warning: dict server unexpectedly alive
198TESTDONE: 938 tests out of 938 reported OK: 100%
199TESTDONE: 1175 tests were considered during 355 seconds.
200 and no. I don't have smb - so commenting the rest of this:
201 To run the test suite, issue: <command>make test</command>. Many tests
202 may fail that depend on optional dependencies that may not be installed
203 or upstream servers that may not be available, especially for tests
204 numbered 700 and above.
205 Test time may be significantly increase due to hanging tests that fail.
206__________
207Added by Bruce for curl-7.60.0:
208TESTDONE: 957 tests out of 959 reported OK: 99%
209TESTFAIL: These test cases failed: 1139 1140
210TESTDONE: 1196 tests were considered during 1184 seconds.
211From the logs, both appear to be ipv6 releated.
212
213==========
214Added by Douglas for curl-7.61.0:
215TESTDONE: 961 tests out of 961 reported OK: 100%
216TESTDONE: 1202 tests were considered during 338 seconds.
217I only have c-ares and libidn2 installed, I will likely try before release
218with all optional dependencies in the book installed.
219
220=========
2217.61.1 NOTE: The test suite is extremely noisy, complaining about verification errors.
222It's possible this is due to openssl-1.1.1, BUT 79/79 tests report as 100% OK. I had
223c-ares, libpsl, and libidn1/2 installed. - Doug
224
225========
2267.62.0: All tests passed. libpsl, c-ares, libssh2, libidn2 installed.
227All 1098 tests report OK.
228
229=======
230Added by Douglas for curl-7.64.0:
231TESTDONE: 1022 tests out of 1023 reported OK: 99%
232TESTFAIL: These tests cases failed: 323
233TESTDONE: 1235 tests were considered during 1279 seconds.
234For dependencies, I had c-ares, gnutls, libidn2, libpsl, krb5, libssh2, nghttp2,
235OpenLDAP, Samba, stunnel, and Valgrind installed.
236=======
237Added by bdubbs for curl-7.64.1:
238TESTDONE: 1022 tests out of 1025 reported OK: 99%
239TESTFAIL: These test cases failed: 323 1139 1140
240TESTDONE: 1242 tests were considered during 1483 seconds
241
242=======
243Added by renodr for curl-7.65.1:
244TESTDONE: 996 tests out of 997 reported OK: 99%
245TESTFAIL: These test cases failed: 1560
246TESTDONE: 1249 tests were considered during 1091 seconds.
247All dependencies except for externals installed.
248-->
249 </para>
250
251 <para>
252 Now, as the <systemitem class="username">root</systemitem>
253 user:
254 </para>
255
256<screen role="root"><userinput>make install &amp;&amp;
257
258rm -rf docs/examples/.deps &amp;&amp;
259
260find docs \( -name Makefile\* -o -name \*.1 -o -name \*.3 \) -exec rm {} \; &amp;&amp;
261
262install -v -d -m755 /usr/share/doc/curl-&curl-version; &amp;&amp;
263cp -v -R docs/* /usr/share/doc/curl-&curl-version;</userinput></screen>
264
265 <para>
266 Simple tests to the new installed <command>curl</command>:
267 <command>curl --trace-ascii debugdump.txt http://www.example.com/</command>
268 and
269 <command>curl --trace-ascii d.txt --trace-time http://example.com/</command>.
270 Inspect the locally created trace files <filename>debugdump.txt</filename>
271 and <filename>d.txt</filename>, which contain version downloaded
272 files information, etc. One file has the time for each action logged.
273 </para>
274 </sect2>
275
276 <sect2 role="commands">
277 <title>Command Explanations</title>
278
279 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
280 href="../../xincludes/static-libraries.xml"/>
281
282 <para>
283 <parameter>--enable-threaded-resolver</parameter>: This switch enables
284 <application>cURL</application>'s builtin threaded DNS resolver.
285 </para>
286
287 <para>
288 <parameter>--with-ca-path=/etc/ssl/certs</parameter>: This
289 switch sets the location of the BLFS Certificate Authority store.
290 </para>
291
292 <para>
293 <option>--with-gssapi</option>: This parameter adds
294 <application>Kerberos 5</application> support to
295 <filename class="libraryfile">libcurl</filename>.
296 </para>
297
298 <para>
299 <option>--without-ssl --with-gnutls</option>: Use to
300 build with <application>GnuTLS</application> support
301 instead of <application>OpenSSL</application> for SSL/TLS.
302 </para>
303
304 <para>
305 <option>--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt</option>: Use
306 this switch instead of <parameter>--with-ca-path</parameter> if
307 building with <application>GnuTLS</application> support
308 instead of <application>OpenSSL</application> for SSL/TLS.
309 </para>
310
311 <para>
312 <option>--with-libssh2</option>: This paramater adds
313 <application>SSH</application> support to cURL. This is disabled
314 by default.
315 </para>
316
317 <para>
318 <option>--enable-ares</option>: This paramater adds
319 support for DNS resolution through the c-ares library. It is disabled
320 by default, but does speed up DNS resolution queries.
321 </para>
322
323 <para>
324 <command>find docs ... -exec rm {} \;</command>: This command removes
325 <filename>Makefiles</filename> and man files from the documentation
326 directory that would otherwise be installed by the commands that follow.
327 </para>
328
329 </sect2>
330
331 <sect2 role="content">
332 <title>Contents</title>
333
334 <segmentedlist>
335 <segtitle>Installed Programs</segtitle>
336 <segtitle>Installed Library</segtitle>
337 <segtitle>Installed Directories</segtitle>
338
339 <seglistitem>
340 <seg>
341 curl and curl-config
342 </seg>
343 <seg>
344 libcurl.so
345 </seg>
346 <seg>
347 /usr/include/curl and
348 /usr/share/doc/curl-&curl-version;
349 </seg>
350 </seglistitem>
351 </segmentedlist>
352
353 <variablelist>
354 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
355 <?dbfo list-presentation="list"?>
356 <?dbhtml list-presentation="table"?>
357
358 <varlistentry id="curl-prog">
359 <term><command>curl</command></term>
360 <listitem>
361 <para>
362 is a command line tool for transferring files with URL syntax.
363 </para>
364 <indexterm zone="curl curl-prog">
365 <primary sortas="b-curl">curl</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="curl-config">
371 <term><command>curl-config</command></term>
372 <listitem>
373 <para>
374 prints information about the last compile, like libraries
375 linked to and prefix setting.
376 </para>
377 <indexterm zone="curl curl-config">
378 <primary sortas="b-curl-config">curl-config</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="libcurl">
384 <term><filename class="libraryfile">libcurl.so</filename></term>
385 <listitem>
386 <para>
387 provides the API functions required by
388 <command>curl</command> and other programs.
389 </para>
390 <indexterm zone="curl libcurl">
391 <primary sortas="c-libcurl">libcurl.so</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 </variablelist>
397
398 </sect2>
399
400</sect1>
Note: See TracBrowser for help on using the repository browser.