source: gnome/platform/rest.xml@ 956d023

<?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 rest-download-http "&gnome-download-http;/rest/0.8/rest-&rest-version;.tar.xz">
  <!ENTITY rest-download-ftp  "&gnome-download-ftp;/rest/0.8/rest-&rest-version;.tar.xz">
  <!ENTITY rest-md5sum        "07ae736561aab03ee9bdd451445926ba">
  <!ENTITY rest-size          "328 KB">
  <!ENTITY rest-buildsize     "14 MB (with tests)">
  <!ENTITY rest-time          "0.4 SBU (with tests)">
]>

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

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

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

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

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

    <para>
      The <application>rest</application> package contains a library
      that was designed to make it easier to access web services that
      claim to be "RESTful". It includes convenience wrappers for
      libsoup and libxml to ease remote use of the RESTful API.
    </para>

    &lfs80_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cacerts"/> and
      <xref linkend="libsoup"/>
    </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"/> and
      <ulink url="http://ltp.sourceforge.net/coverage/lcov.php">LCOV</ulink>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr \
    --with-ca-certificates=/etc/ssl/ca-bundle.crt &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </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>--with-ca-certificates=/etc/ssl/ca-bundle.crt</parameter>: This
      switch sets the location of the BLFS <xref linkend="cacerts"/> bundle.
    </para>

    <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 Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          librest-0.7.so and librest-extras-0.7.so
        </seg>
        <seg>
          /usr/include/rest-0.7 and
          /usr/share/gtk-doc/html/rest-0.7
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="librest-0.7">
        <term><filename class="libraryfile">librest-0.7.so</filename></term>
        <listitem>
          <para>
            contains the RESTful Web API Query functions.
          </para>
          <indexterm zone="rest librest-0.7">
            <primary sortas="c-librest-0.7">librest-0.7.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="librest-extras-0.7">
        <term><filename class="libraryfile">librest-extras-0.7.so</filename></term>
        <listitem>
          <para>
            contains extra RESTful Web API Query functions.
          </para>
          <indexterm zone="rest librest-extras-0.7">
            <primary sortas="c-librest-extras-0.7">librest-extras-0.7.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>