source: gnome/platform/libgdata.xml@ 362cd58

<?xml version="1.0" encoding="UTF-8"?>
<!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 libgdata-download-http "&gnome-download-http;/libgdata/0.18/libgdata-&libgdata-version;.tar.xz">
  <!ENTITY libgdata-download-ftp  " ">
  <!ENTITY libgdata-md5sum        "92b058d1a0af5d1b96c86c21820f1eff">
  <!ENTITY libgdata-size          "832 KB">
  <!ENTITY libgdata-buildsize     "54 MB (with tests)">
  <!ENTITY libgdata-time          "0.5 SBU (with tests)">
]>

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


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

  <indexterm zone="libgdata">
    <primary sortas="a-libgdata">libgdata</primary>
  </indexterm>

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

    <para>
      The <application>libgdata</application> package is a GLib-based
      library for accessing online service APIs using the GData protocol, most
      notably, Google's services. It provides APIs to access the common Google
      services and has full asynchronous support.
    </para>

    &lfs122_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libsoup"/>,
      <xref linkend="gnome-online-accounts"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="json-glib"/>, and
      <xref linkend="vala"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> (for documentation), and
      <xref linkend="liboauth"/> (for OAuth v1 support) <!-- and
      <xref linkend="uhttpmock"/> (required for tests)-->
      <!-- uhttpmock is commented out until libgdata is ported to soup3 -->
    </para>

  </sect2>

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

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

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

meson setup --prefix=/usr               \
            --buildtype=release         \
            -D gtk_doc=false            \
            -D always_build_tests=false \
            ..                          &amp;&amp;
ninja</userinput></screen>

<!--
    <para>
      If you wish to run the test suite, make sure
      <xref linkend="uhttpmock"/> is installed and remove
      <parameter>-D always_build_tests=false</parameter> in the
      <command>meson</command> command line.  To test the results,
      issue: <command>ninja test</command>. Note that
      the tests need network access.
    </para>
 -->

<!-- Tests requires uhttpmock, but they are only compatible with a version that
     uses libsoup2. Without this version, all of the tests fail due to mixing
     symbols from libsoup3 and libsoup2 in the same program. -->

    <para>
      This package does not come with a functional test suite.
    </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>
      <parameter>-D gtk_doc=false</parameter>: Remove this if you have
      <xref linkend="gtk-doc"/> installed and want to rebuild the
      documentation with it.
    </para>
    <para>
      <option>-D oauth1=enabled</option>: Use this option if you wish to build
      in support for OAuth v1. Note that you must have
      <xref linkend="liboauth"/> installed in order to enable 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>
          libgdata.so
        </seg>
        <seg>
          /usr/include/libgdata and
          /usr/share/gtk-doc/html/gdata
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgdata-lib">
        <term><filename class="libraryfile">libgdata.so</filename></term>
        <listitem>
          <para>
            contains the <application>libgdata</application> API functions
          </para>
          <indexterm zone="libgdata libgdata-lib">
            <primary sortas="c-libgdata">libgdata.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>