glfs/basicnet/netlibs/curl.xml

153 lines
5.1 KiB
XML
Raw Normal View History

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY curl-download-http "http://curl.haxx.se/download/curl-&curl-version;.tar.bz2">
<!ENTITY curl-download-ftp "ftp://ftp.fu-berlin.de/pub/unix/network/curl/curl-&curl-version;.tar.bz2">
<!ENTITY curl-md5sum "d673f68dbab2553acdbfb5435bd1cd48">
<!ENTITY curl-size "1.8 MB">
<!ENTITY curl-buildsize "24.7 MB">
<!ENTITY curl-time "0.40 SBU (additional 0.59 SBU to run the test suite)">
]>
<sect1 id="curl" xreflabel="cURL-&curl-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="curl.html"?>
<title>cURL-&curl-version;</title>
<indexterm zone="curl">
<primary sortas="a-CURL">CURL</primary></indexterm>
<sect2>
<title>Introduction to <application>cURL</application></title>
<para>The <application>cURL</application> package contains
<command>curl</command> and its support library. This is useful for
transferring files with <acronym>URL</acronym> syntax. This ability to both
download and redirect files can be incorporated into other programs to support
functions like streaming media.</para>
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP):
<ulink url="&curl-download-http;"/></para></listitem>
<listitem><para>Download (FTP):
<ulink url="&curl-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: &curl-md5sum;</para></listitem>
<listitem><para>Download size: &curl-size;</para></listitem>
<listitem><para>Estimated disk space required:
&curl-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&curl-time;</para></listitem></itemizedlist>
</sect3>
<sect3><title><application>cURL</application> dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="pkgconfig"/>,
<xref linkend="openssl"/>,
<xref linkend="openldap"/>,
<xref linkend="mitkrb"/> or <xref linkend="heimdal"/>,
<ulink url="http://www.pdc.kth.se/kth-krb/">krb4</ulink>,
<ulink url="http://www.gnu.org/software/libidn/">Libidn</ulink>,
<ulink url="http://www.vintela.com/resources/topics/spnego/">SPNEGO</ulink> and
<ulink url="http://daniel.haxx.se/projects/c-ares/">c-ares</ulink></para>
</sect4>
<sect4><title>Optional (for running the test suite)</title>
<para><xref linkend="stunnel"/> (for running <acronym>HTTPS</acronym> and
<acronym>FTPS</acronym> tests) and
<ulink url="http://valgrind.kde.org/">Valgrind</ulink> (not used if building
the shared library)</para>
</sect4>
</sect3>
</sect2>
<sect2>
<title>Installation of <application>cURL</application></title>
<para>Install <application>cURL</application> by running the following
commands:</para>
<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make</command></userinput></screen>
<para>Now, as the root user:</para>
<screen><userinput role='root'><command>make install &amp;&amp;
find docs -name "Makefile*" \
-o -name "*.1" \
-o -name "*.3" | xargs rm &amp;&amp;
install -v -d -m755 /usr/share/doc/curl-&curl-version; &amp;&amp;
cp -v -R docs/* /usr/share/doc/curl-&curl-version;</command></userinput></screen>
</sect2>
<sect2>
<title>Command explanations</title>
<para><option>--with-gssapi</option>:
This parameter adds <application>Kerberos 5</application> support to
<filename class="libraryfile">libcurl</filename>.</para>
</sect2>
<sect2>
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Library</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>curl and curl-config</seg>
<seg>libcurl.[so,a]</seg>
<seg>/usr/include/curl, /usr/share/curl
and /usr/share/doc/curl-&curl-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<varlistentry id="curl-prog">
<term><command>curl</command></term>
<listitem><para>is a client that can get documents from or send documents to
any of the following protocols: <acronym>HTTP</acronym>,
<acronym>HTTPS</acronym> (needs <xref linkend="openssl"/>),
<acronym>FTP</acronym>, GOPHER, DICT, TELNET, <acronym>LDAP</acronym> (needs
<xref linkend="openldap"/> at run time) or FILE.</para>
<indexterm zone="curl curl-prog">
<primary sortas="b-curl">curl</primary>
</indexterm></listitem>
</varlistentry>
<varlistentry id="curl-config">
<term><command>curl-config</command></term>
<listitem><para>prints information about the last compile, like libraries
linked to and prefix setting.</para>
<indexterm zone="curl curl-config">
<primary sortas="b-curl-config">curl-config</primary>
</indexterm></listitem>
</varlistentry>
<varlistentry id="libcurl">
<term><filename class='libraryfile'>libcurl.[so,a]</filename></term>
<listitem><para>provides the <acronym>API</acronym> functions required by
<command>curl</command> and other programs.</para>
<indexterm zone="curl libcurl">
<primary sortas="c-libcurl">libcurl.[so,a]</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>