glfs/general/genlib/libcloudproviders.xml

<?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 libcloudproviders-download-http "&gnome-download-http;/libcloudproviders/0.3/libcloudproviders-&libcloudproviders-version;.tar.xz">
  <!ENTITY libcloudproviders-download-ftp  " ">
  <!ENTITY libcloudproviders-md5sum        "bdb46d0e8222df79eeff4043cd9933b2">
  <!ENTITY libcloudproviders-size          "24 KB">
  <!ENTITY libcloudproviders-buildsize     "1.5 MB">
  <!ENTITY libcloudproviders-time          "less than 0.1 SBU">
]>

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

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

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

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

    <para>
      The <application>libcloudproviders</application> package contains a
      library which provides a DBus API that allows cloud storage sync clients
      to expose their services.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      &gobject-introspection; and
      <xref linkend="vala"/>
    </para>

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

  </sect2>

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

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

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</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>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>-Denable-gtk-doc</option>: Use this switch if you have
      <xref linkend="gtk-doc" role="nodep"/> installed and wish to generate the
      API documentation.
    </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>
          libcloudproviders.so
        </seg>
        <seg>
          /usr/include/cloudproviders
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libcloudproviders-lib">
        <term><filename class="libraryfile">libcloudproviders.so</filename></term>
        <listitem>
          <para>
            contains functions that provide a DBus API to allow cloud storage
            sync clients to expose their services
          </para>
          <indexterm zone="libcloudproviders libcloudproviders-lib">
            <primary sortas="c-libcloudproviders">libcloudproviders.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>