glfs/basicnet/netlibs/libsoup.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libsoup-download-http "&gnome-download-http;/libsoup/&gnome-version;/libsoup-&libsoup-version;.tar.bz2">
  <!ENTITY libsoup-download-ftp  "&gnome-download-ftp;/libsoup/&gnome-version;/libsoup-&libsoup-version;.tar.bz2">
  <!ENTITY libsoup-md5sum        "31d7ad416005eed4b78f07ac01b6b9f0">
  <!ENTITY libsoup-size          "705 KB">
  <!ENTITY libsoup-buildsize     "19 MB">
  <!ENTITY libsoup-time          "0.4 SBU">
]>

<sect1 id="libsoup" xreflabel="libsoup-&libsoup-version;">
  <?dbhtml filename="libsoup.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>libsoup-&libsoup-version;</title>

  <indexterm zone="libsoup">
    <primary sortas="a-Libsoup">Libsoup</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libsoup</title>

    <para>The <application>libsoup</application> package contains an
    HTTP library implementation in <application>C</application>. This is
    useful for accessing HTTP servers in a completely asynchronous mode.</para>

    &lfs65_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Download (HTTP): <ulink url="&libsoup-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libsoup-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libsoup-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libsoup-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libsoup-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libsoup-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libsoup Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/> and
    <xref linkend="libxml2"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="gnutls"/>,
    <xref linkend="gnome-keyring"/>,
    <xref linkend="libproxy"/>, and
    <xref linkend="sqlite"/> (The latter three are required if building <application>GNOME</application>)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/>,
    <xref linkend="apache"/> (required to run the test suite), and
    <xref linkend="php"/> compiled with
    <ulink url="http://xmlrpc-epi.sourceforge.net/main.php?t=php_about">XMLRPC-EPI</ulink>
      support (only used for the XMLRPC regression tests)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libsoup"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libsoup</title>

    <para>Install <application>libsoup</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

    <para><option>--without-gnome</option>: Use this parameter if you will 
    <emphasis role="strong">NOT</emphasis> be installing 
    <application>GNOME</application>.</para>

    <para><option>--disable-ssl</option>: Use this parameter if you wish to
    disable SSL/TLS support.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libsoup-2.4.{so,a} and libsoup-gnome-2.4.{so,a}</seg>
        <seg>/usr/{include/{libsoup-2.4/libsoup,libsoup-gnome-2.4/libsoup},
        share/gtk-doc/html/libsoup-2.4}</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libsoup-lib">
        <term><filename class='libraryfile'>libsoup-2.4.{so,a}</filename></term>
        <listitem>
          <para>provides functions for asynchronous HTTP connections.</para>
          <indexterm zone="libsoup libsoup-lib">
            <primary sortas="c-libsoup-2.4">libsoup-2.4.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsoup-gnome-lib">
        <term><filename class='libraryfile'>libsoup-gnome-2.4.{so,a}</filename></term>
        <listitem>
          <para>provides <application>GNOME</application> specific features.</para>
          <indexterm zone="libsoup libsoup-gnome-lib">
            <primary sortas="c-libsoup-gnome-2.4">libsoup-gnome-2.4.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>