source: networking/netlibs/librest.xml@ 27045b7

<?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 librest-download-http "&gnome-download-http;/rest/0.7/rest-&librest-version;.tar.xz">
  <!ENTITY librest-download-ftp  "&gnome-download-ftp;/rest/0.7/rest-&librest-version;.tar.xz">
  <!ENTITY librest-md5sum        "dc14e0d89d38af5d8d544ce8f124d186">
  <!ENTITY librest-size          "293 KB">
  <!ENTITY librest-buildsize     "6.6 MB">
  <!ENTITY librest-time          "0.2 SBU">
]>

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

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

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

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

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

    <para><application>Librest</application> 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>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="cacerts"/>,
    <!--<xref linkend="glib2"/>, pulled in by glib-networking via libsoup -->
    <xref linkend="libsoup"/></para>
    <!--<xref linkend="libxml2"/></para> pulled in byglib-networking via libsoup -->

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

  </sect2>

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

    <para>Install <application>librest</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>:
    The configure script needs to be pointed to the certificates.</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>librest-0.7.so and librest-extras-0.7.so</seg>
        <seg>/usr/{include/rest-0.7/rest-extras,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">
        <term><filename class='libraryfile'>librest-0.7.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="librest librest-0">
            <primary sortas="c-librest-0">librest-0.7.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="librest-extras-0">
        <term><filename class='libraryfile'>librest-extras-0.7.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="librest librest-extras-0">
            <primary sortas="c-librest-extras-0">librest-extras-0.7.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>