source: general/genlib/libgrss.xml@ 875b3b57

<?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 libgrss-download-http "&gnome-download-http;/libgrss/0.7/libgrss-0.7.0.tar.xz">
  <!ENTITY libgrss-download-ftp  " ">
  <!ENTITY libgrss-md5sum        "7c0ee46a82dc0e9610183fe9ef8c7c1d">
  <!ENTITY libgrss-size          "356 KB">
  <!ENTITY libgrss-buildsize     "10 MB">
  <!ENTITY libgrss-time          "0.1 SBU">
]>

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


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

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

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

    <para>
      The <application>libgrss</application> package contains a library
      designed to manipulate RSS and Atom feeds.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/libgrss-&libgrss-version;-bugfixes-2.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libsoup"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

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

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


<screen><userinput>patch -Np1 -i ../libgrss-&libgrss-version;-bugfixes-2.patch &amp;&amp;
autoreconf -fv &amp;&amp;
./configure --prefix=/usr --disable-static &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>

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgrss.so
        </seg>
        <seg>
          /usr/include/libgrss and
          /usr/share/doc/libgrss-&libgrss-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgrss-lib">
        <term><filename class="libraryfile">libgrss.so</filename></term>
        <listitem>
          <para>
            provides API functions for handling RSS feeds
          </para>
          <indexterm zone="libgrss libgrss-lib">
            <primary sortas="c-libgrss">libgrss.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>