glfs/gnome/core/gnome-online-accounts.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 gnome-online-accounts-download-http 
           "&gnome-download-http;/gnome-online-accounts/3.4/gnome-online-accounts-&gnome-online-accounts-version;.tar.xz">
  <!ENTITY gnome-online-accounts-download-ftp  
           "&gnome-download-ftp;/gnome-online-accounts/3.4/gnome-online-accounts-&gnome-online-accounts-version;.tar.xz">
  <!ENTITY gnome-online-accounts-md5sum        "adb39a6ba7661fff915297ebb800ec09">
  <!ENTITY gnome-online-accounts-size          "476 KB">
  <!ENTITY gnome-online-accounts-buildsize     "17 MB">
  <!ENTITY gnome-online-accounts-time          "0.3 SBU">
]>

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

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

  <title>gnome-online-accounts-&gnome-online-accounts-version;</title>

  <indexterm zone="gnome-online-accounts">
    <primary sortas="a-gnome-online-accounts">gnome-online-accounts</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Online Accounts</title>

    <para>
      The <application>GNOME Online Accounts</application> package contains a
      framework used to access the user's online accounts.
    </para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">GNOME Online Accounts Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libgnome-keyring"/>,
      <xref linkend="libnotify"/>,
      <xref linkend="librest"/>,
      <xref linkend="json-glib"/> and
      <xref linkend="webkitgtk"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

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

  <sect2 role="installation">
    <title>Installation of GNOME Online Accounts</title>

    <para>
      Install <application>GNOME Online Accounts</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/gnome-online-accounts \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </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>
      <parameter>--libexecdir=/usr/lib/gnome-online-accounts</parameter>:
      This parameter ensures the <command>goa-demon</command> program is installed in
      <filename class="directory">/usr/lib/gnome-online-accounts</filename> for
      conformance with the FHS.
    </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 Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          goa-daemon
        </seg>
        <seg>
          libgoa-1.0.so and libgoa-backend-1.0.so
        </seg>
        <seg>
          /usr/include/goa-1.0,
          /usr/lib/gnome-online-accounts and
          /usr/share/gtk-doc/html/goa
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="goa-daemon">
        <term><command>goa-daemon</command></term>
        <listitem>
          <para>
            is the <application>GNOME Online Accounts</application> Daemon.
          </para>
          <indexterm zone="gnome-online-accounts goa-daemon">
            <primary sortas="b-goa-daemon">goa-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgoa-1">
        <term><filename class='libraryfile'>libgoa-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>GNOME Online Accounts</application>
            API functions.
          </para>
          <indexterm zone="gnome-online-accounts libgoa-1">
            <primary sortas="c-libgoa-1">libgoa-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgoa-backend-1">
        <term><filename class='libraryfile'>libgoa-backend-1.0.so</filename></term>
        <listitem>
          <para>contains functions used by gnome-online-accounts backends.</para>
          <indexterm zone="gnome-online-accounts libgoa-backend-1">
            <primary sortas="c-libgoa-backend-1">libgoa-backend-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>