source: networking/netlibs/libsoup.xml@ 8558044

<?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.74/libsoup-&libsoup-version;.tar.xz">
  <!ENTITY libsoup-download-ftp
           "&gnome-download-ftp;/libsoup/2.74/libsoup-&libsoup-version;.tar.xz">
  <!ENTITY libsoup-md5sum        "076f7ceeb73ebae2cc55a4c2877f6926">
  <!ENTITY libsoup-size          "1.4 MB">
  <!ENTITY libsoup-buildsize     "15 MB (with tests)">
  <!ENTITY libsoup-time          "0.2 SBU (Using parallelism=4; with tests)">
]>

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

  <sect1info>
    <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 a 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 an asynchronous API for use in threaded applications.
    </para>

    &lfs110a_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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/libsoup-&libsoup-version;-testsuite_fix-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">libsoup Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib-networking"/>,
      <xref linkend="libpsl"/>,
      <xref linkend="libxml2"/>, and
      <xref linkend="sqlite"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="apache"/> (required to run the test suite),
      <xref linkend="brotli"/>,
      <xref linkend="curl"/> (required to run the test suite),
      <xref linkend="sysprof"/> (for profiling),
      <xref linkend="mitkrb"/> (required to run the test suite),
      <xref linkend="gtk-doc"/>,
         <!-- It seems that XMLRPC is part of PHP 5.4.10 -->
      <xref linkend="php"/> compiled with XMLRPC-EPI
      support (only used for the XMLRPC regression tests), and
      <xref linkend="samba"/> (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>
      First, fix a problem in the testsuite caused by
      <xref role="nodep" linkend="glib-networking"/>:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../libsoup-&libsoup-version;-testsuite_fix-1.patch</userinput></screen>
-->
    <para>
      Install <application>libsoup</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr       \
      --buildtype=release \
      -Dvapi=enabled      \
      -Dgssapi=disabled   \
      -Dsysprof=disabled  \
      ..                  &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

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

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

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

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

    <para>
      <option>-Dvapi=disabled</option>: Use this if you have not installed
      <application>Vala</application>, e.g. because you are not building
      <application>GNOME</application>.
    </para>

    <para>
      <option>-Ddoc=enabled</option>: Use this option if you want to build
      the documentation. Note that you must have <xref linkend="gtk-doc"/> installed.
    </para>

    <para>
      <parameter>-Dgssapi=disabled</parameter>: libsoup defaults to building with GSSAPI support,
      which requires Kerberos (as does the test suite). If you are building GNOME or
      have kerberos installed, remove this option.
    </para>

    <para>
      <parameter>-Dsysprof=disabled</parameter>: libsoup will automatically download
      a git version of <xref linkend="sysprof"/> if git is available or use the installed
      version if available.  If you need profiling, remove this option.
    </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 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 <!-- only installed if -Ddoc=true is
          passed. -->
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

      <varlistentry id="libsoup-gnome-2">
        <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">
            <primary sortas="c-libsoup-gnome-2">libsoup-gnome-2.4.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>