source: networking/netlibs/libsoup.xml@ 10516957

<?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/2.38/libsoup-&libsoup-version;.tar.xz">
  <!ENTITY libsoup-download-ftp
           "&gnome-download-ftp;/libsoup/2.38/libsoup-&libsoup-version;.tar.xz">
  <!ENTITY libsoup-md5sum        "d13fb4968acea24c26b83268a308f580">
  <!ENTITY libsoup-size          "608 KB">
  <!ENTITY libsoup-buildsize     "23 MB">
  <!ENTITY libsoup-time          "0.3 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> is HTTP client/server library for
      <application>GNOME</application>. It uses GObject and the GLib main loop
      to integrate with <application>GNOME</application> applications and 
      it also has asynchronous API for use in threaded applications.
    </para>

    &lfs70_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="glib-networking"/> and
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="libgnome-keyring"/> and 
      <xref linkend="sqlite"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="apache"/> (required to run the test suite),
      <xref linkend="curl"/> (required to run the test suite),
      <xref linkend="gtk-doc"/>,
      <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) and
      <xref linkend="samba3"/> (ntlm_auth is required to run the test suite).
    </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 --disable-static &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>

    <para>
      <option>--without-gnome</option>: This switch prevents
      <command>configure</command> looking for GNOME specific 
      dependencies. Use this switch if you have not installed
      <xref linkend="libgnome-keyring"/>.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          libsoup-2.4.so and libsoup-gnome-2.4.so
        </seg>
        <seg>
          /usr/include/libsoup-2.4,
          /usr/include/libsoup-gnome-2.4 and
          /usr/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-2.4">
        <term><filename class='libraryfile'>libsoup-2.4.so</filename></term>
        <listitem>
          <para>
            provides functions for asynchronous HTTP connections.
          </para>
          <indexterm zone="libsoup libsoup-2.4">
            <primary sortas="c-libsoup-2.4">libsoup-2.4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>