source: networking/netlibs/curl.xml@ 2198a32

10.0 10.1 11.0 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 2198a32 was 2198a32, checked in by DJ Lucas <dj@…>, 4 years ago

Rename make-ca page.

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

  • Property mode set to 100644
File size: 11.3 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 "fcf429f28adddf9295ed0c42e79cb097">
10 <!ENTITY curl-size "2.2 MB">
11 <!ENTITY curl-buildsize "43 MB (add 11 MB for tests without valgrind)">
12 <!ENTITY curl-time "0.4 SBU (add 11+ 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 &lfs82_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<!-- Tests seem to pass without any patch
78 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
79 <itemizedlist spacing="compact">
80 <listitem>
81 <para>
82 Required patch:
83 <ulink url="&patch-root;/curl-&curl-version;-valgrind_filter-1.patch"/>
84 </para>
85 </listitem>
86 </itemizedlist>
87-->
88 <bridgehead renderas="sect3">cURL Dependencies</bridgehead>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref role="runtime" linkend="make-ca"/> (runtime)
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="c-ares"/>,
98 <xref linkend="gnutls"/>,
99 <xref linkend="libidn2"/>,
100 <xref linkend="mitkrb"/>,
101 <xref linkend="nghttp2"/>,
102 <xref linkend="openldap"/>,
103 <xref linkend="samba"/>,
104 <ulink url="https://launchpad.net/libmetalink/">libmetalink</ulink>,
105 <ulink url="https://github.com/rockdaboot/libpsl">libpsl</ulink>,
106 <ulink url="http://rtmpdump.mplayerhq.hu/">librtmp</ulink>,
107 <ulink url="http://www.libssh2.org">libssh2</ulink>,
108 <ulink url="https://tls.mbed.org/">mbed TLS</ulink> (formerly known as
109 PolarSSL), and
110 <ulink url="http://spnego.sourceforge.net/"> SPNEGO</ulink>
111 </para>
112
113 <bridgehead renderas="sect4">Optional if Running the Test Suite</bridgehead>
114 <para role="optional">
115 <!-- stunnel is still listed in the docs as required, but 7.58.0
116 tests completed happily without it, although the test for unit1323
117 reported that the tool set in the test case does not exist - ken -->
118 <xref linkend="stunnel"/> (for the HTTPS and FTPS tests) and
119 <xref linkend="valgrind"/> (this will slow the tests down)
120 </para>
121
122 <para condition="html" role="usernotes">User Notes:
123 <ulink url="&blfs-wiki;/curl"/>
124 </para>
125 </sect2>
126
127 <sect2 role="installation">
128 <title>Installation of cURL</title>
129
130 <para>
131 Install <application>cURL</application> by running the following
132 commands:
133 </para>
134
135<screen><userinput>./configure --prefix=/usr \
136 --disable-static \
137 --enable-threaded-resolver \
138 --with-ca-path=/etc/ssl/certs &amp;&amp;
139make</userinput></screen>
140
141<!--
142 For version 7.54.1 I got:
143 TESTDONE: 869 tests out of 869 reported OK: 100%
144 TESTDONE: 1092 tests were considered during 1080 seconds
145
146 <para>
147 Running the test suite is optional. About 2% of the tests fail. Increase
148 in test time by each failed test is about 10%. Tests SBU above was
149 obtained disabling failing tests, with:
150 </para>
151
152 2017-10-29 - bdubbs
153 For version 7.56.1 I had a lot of test failures which included long
154 timeouts. Could not determine the cause of the timeouts or failures,
155 but I was missing c-ares, MIT Kerberos, ldap, samba, and the six
156 external packages.
157
158 2017-12-01 - bdubbs
159 Still a lot of test failures. I did have c-ares, Kerberos, and ldap
160 installed this time. Best guess is that servers are not available.
161-->
162 <note>
163 <para>
164 If running the tests for this package with valgrind, it will require a
165 version of /lib/ld-2.[MINORVERSION].so library
166 with debugging symbols present.
167 </para>
168
169 <para>Current versions of LFS do not strip /lib/ld-[MINORVERSION].so but
170 previous versions of LFS stripped these debugging symbols at the end of
171 Chapter 6. To get this library on older systems, glibc must be rebuilt
172 with the currently running
173 glibc version using the same compiler that was used to build LFS. The
174 ld-[MINORVERSION].so can then be renamed to ld-2.[MINORVERSION].so.dbg
175 and copied to /lib. Then a symlink needs to be changed:
176 </para>
177
178 <screen role="nodump"><userinput>ln -sfv ld-2.[MINORVERSION].so.dbg /lib/ld-linux-x86-64.so.2</userinput></screen>
179
180 <para>
181 Adjust the above instruction as needed for a 32-bit system
182 and to match your installed version of glibc.
183 </para>
184 </note>
185
186 <para>
187 To run the test suite, issue: <command>make test</command>. <!--
188 if stunnel and valgrind are not installed, and also most options
189 (I had rtmpdump), the tests complete without problems.
190Warning: smb server unexpectedly alive
191Warning: dict server unexpectedly alive
192TESTDONE: 938 tests out of 938 reported OK: 100%
193TESTDONE: 1175 tests were considered during 355 seconds.
194 and no. I don't have smb - so commenting the rest of this:
195 To run the test suite, issue: <command>make test</command>. Many tests
196 may fail that depend on optional dependencies that may not be installed
197 or upstream servers that may not be available, especially for tests
198 numbered 700 and above.
199 Test time may be significantly increase due to hanging tests that fail. -->
200 </para>
201
202 <para>
203 Now, as the <systemitem class="username">root</systemitem>
204 user:
205 </para>
206
207<screen role="root"><userinput>make install &amp;&amp;
208
209rm -rf docs/examples/.deps &amp;&amp;
210
211find docs \( -name Makefile\* -o -name \*.1 -o -name \*.3 \) -exec rm {} \; &amp;&amp;
212
213install -v -d -m755 /usr/share/doc/curl-&curl-version; &amp;&amp;
214cp -v -R docs/* /usr/share/doc/curl-&curl-version;</userinput></screen>
215
216 <para>
217 Simple tests to the new installed <command>curl</command>:
218 <command>curl --trace-ascii debugdump.txt http://www.example.com/</command>
219 and
220 <command>curl --trace-ascii d.txt --trace-time http://example.com/</command>.
221 Inspect the locally created trace files <filename>debugdump.txt</filename>
222 and <filename>d.txt</filename>, which contain version downloaded
223 files information, etc. One file has the time for each action logged.
224 </para>
225 </sect2>
226
227 <sect2 role="commands">
228 <title>Command Explanations</title>
229
230 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
231 href="../../xincludes/static-libraries.xml"/>
232
233 <para>
234 <parameter>--enable-threaded-resolver</parameter>: This switch enables
235 <application>cURL</application>'s builtin threaded DNS resolver.
236 </para>
237
238 <para>
239 <parameter>--with-ca-path=/etc/ssl/certs</parameter>: This
240 switch sets the location of the BLFS Certificate Authority store.
241 </para>
242
243 <para>
244 <option>--with-gssapi</option>: This parameter adds
245 <application>Kerberos 5</application> support to
246 <filename class="libraryfile">libcurl</filename>.
247 </para>
248
249 <para>
250 <option>--without-ssl --with-gnutls</option>: Use to
251 build with <application>GnuTLS</application> support
252 instead of <application>OpenSSL</application> for SSL/TLS.
253 </para>
254
255 <para>
256 <option>--with-ca-bundle=/etc/ssl/ca-bundle.crt</option>: Use
257 this switch instead of <parameter>--with-ca-path</parameter> if
258 building with <application>GnuTLS</application> support
259 instead of <application>OpenSSL</application> for SSL/TLS.
260 </para>
261
262 <para>
263 <command>find docs ... -exec rm {} \;</command>: This command removes
264 <filename>Makefiles</filename> and man files from the documentation
265 directory that would otherwise be installed by the commands that follow.
266 </para>
267
268 </sect2>
269
270 <sect2 role="content">
271 <title>Contents</title>
272
273 <segmentedlist>
274 <segtitle>Installed Programs</segtitle>
275 <segtitle>Installed Library</segtitle>
276 <segtitle>Installed Directories</segtitle>
277
278 <seglistitem>
279 <seg>
280 curl, and curl-config
281 </seg>
282 <seg>
283 libcurl.so
284 </seg>
285 <seg>
286 /usr/include/curl and
287 /usr/share/doc/curl-&curl-version;
288 </seg>
289 </seglistitem>
290 </segmentedlist>
291
292 <variablelist>
293 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
294 <?dbfo list-presentation="list"?>
295 <?dbhtml list-presentation="table"?>
296
297 <varlistentry id="curl-prog">
298 <term><command>curl</command></term>
299 <listitem>
300 <para>
301 is a command line tool for transferring files with URL syntax.
302 </para>
303 <indexterm zone="curl curl-prog">
304 <primary sortas="b-curl">curl</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="curl-config">
310 <term><command>curl-config</command></term>
311 <listitem>
312 <para>
313 prints information about the last compile, like libraries
314 linked to and prefix setting.
315 </para>
316 <indexterm zone="curl curl-config">
317 <primary sortas="b-curl-config">curl-config</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="libcurl">
323 <term><filename class="libraryfile">libcurl.so</filename></term>
324 <listitem>
325 <para>
326 provides the API functions required by
327 <command>curl</command> and other programs.
328 </para>
329 <indexterm zone="curl libcurl">
330 <primary sortas="c-libcurl">libcurl.so</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 </variablelist>
336
337 </sect2>
338
339</sect1>
Note: See TracBrowser for help on using the repository browser.