source: networking/netlibs/glib-networking.xml@ 0308356

<?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 glib-networking-download-http
    "&gnome-download-http;/glib-networking/2.60/glib-networking-&glib-networking-version;.tar.xz">
  <!ENTITY glib-networking-download-ftp
    "&gnome-download-ftp;/glib-networking/2.60/glib-networking-&glib-networking-version;.tar.xz">
  <!ENTITY glib-networking-md5sum        "83321ffc3c336894b8a5bc18db3fe58d">
  <!ENTITY glib-networking-size          "184 KB">
  <!ENTITY glib-networking-buildsize     "3.6 MB (with tests)">
  <!ENTITY glib-networking-time          "0.1 SBU (with tests)">
]>

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

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

  <title>glib-networking-&glib-networking-version;</title>

  <indexterm zone="glib-networking">
    <primary sortas="a-glib-networking">glib-networking</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GLib Networking</title>

    <para>
      The <application>GLib Networking</application> package contains
      Network related gio modules for <application>GLib</application>.
    </para>

    &lfs84_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/glib-networking-&glib-networking-version;-upstream_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GLib Networking Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>,
      <xref linkend="gnutls"/>, and
      <xref linkend="gsettings-desktop-schemas"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="make-ca"/>
      <!-- p11-kit option no longer exists, and is pulled in by GnuTLS anyway -->
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of GLib Networking</title>

    <!-- 2.60.0 of glib-networking introduced an experimental OpenSSL backend.
    Since it is not tested well upstream yet, and it is recommended by upstream
    to use the GnuTLS backend on Linux, we will continue using the GnuTLS
    backend and not mention the OpenSSL backend to prevent confusion. -->

    <para>
      First, apply a patch to fix a problem introduced by API changes in GnuTLS:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../glib-networking-&glib-networking-version;-upstream_fixes-1.patch</userinput></screen>

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

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

meson --prefix=/usr          \
      -Dlibproxy=disabled .. &amp;&amp;
ninja</userinput></screen>

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

    <!-- glib-networking/#70 -->
    <!-- The patch fixes this problem, and the connection-gnutls failure was
    indicative of a complete failure of the GnuTLS backend to use certificates.
    This broke WebKit and libsoup, and has since been patched. -->
    <!--
    <para>
      The test <emphasis>connection-gnutls</emphasis> is known to fail.
    </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>

    <para>
      <parameter>- -without-ca-certificates</parameter>: This parameter forces
      use of PKCS #11 modules for TLS certificate validation instead of a
      bundle of certificates.
    </para>

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

  </sect2>
  -->
  <!-- This isn't needed anymore and breaks applications which use it.
  <sect2 role="configuration">
    <title>Configuring Glib-networking</title>
    <!- - This breaks the libsoup tests - ->

    <sect3 id="glib-networking-config">
      <title>Config Files</title>
      <para>
        <filename>/etc/profile.d/gio.sh</filename>
      </para>

      <indexterm zone="glib-networking glib-networking-config">
        <primary
        sortas="e-etc-profile.d-gio.sh">/etc/profile.d/gio.sh</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>

      <para>
        For using the PKCS #11 modules, the <envar>GIO_USE_TLS</envar> variable
        should be set in the environment. This can be added to the Bash Startup
        Files (as the <systemitem class="username">root</systemitem> user):
      </para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/gio.sh &lt;&lt; "EOF"
<literal># Begin gio.sh

export GIO_USE_TLS=gnutls-pkcs11

# End gio.sh</literal>
EOF</userinput></screen>
    </sect3>
  </sect2>
-->
  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgiognomeproxy.so and libgiognutls.so (GIO Modules installed in
          <filename class="directory">/usr/lib/gio/modules</filename>)
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>