source: general/genlib/libgsf.xml@ 84da85a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY libgsf-download-http "&gnome-download-http;/libgsf/1.14/libgsf-&libgsf-version;.tar.bz2">
  <!ENTITY libgsf-download-ftp  "&gnome-download-ftp;/libgsf/1.14/libgsf-&libgsf-version;.tar.bz2">
  <!ENTITY libgsf-md5sum        "2d3b112a2c6e7e1740306c32b1ebf6ea">
  <!ENTITY libgsf-size          "525 KB">
  <!ENTITY libgsf-buildsize     "13.4 MB">
  <!ENTITY libgsf-time          "0.3 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">libgsf-&libgsf-version;.tar</keyword>
      <keyword role="ftpdir">libgsf</keyword>
    </keywordset>
  </sect1info>

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

  <indexterm zone="libgsf">
    <primary sortas="a-Libgsf">Libgsf</primary>
  </indexterm>

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

    <para>The <application>libgsf</application> package contains
    <filename class="libraryfile">libgsf-1</filename> libraries. These are
    useful for providing an extensible input/output abstraction layer for
    structured file formats.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/>,
    <xref linkend="libxml2"/>, and
    <xref linkend="perl-xml-parser"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="GConf"/> (required to build the
    <command>gsf-office-thumbnailer</command> program),
    <xref linkend="gnome-vfs"/> (required to build the
    <filename class='libraryfile'>libgsf-gnome-1.so</filename>
    library which provides GNOME-2 support), and
    <xref linkend="gtk-doc"/></para>

    <para>Note: you need to build the
    <filename class='libraryfile'>libgsf-gnome-1.so</filename> library if you
    plan on building <xref linkend="gnumeric"/> with GNOME support.</para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>Running <command>make check</command> will build a battery of test
    programs which are built using the just-created
    <filename class='libraryfile'>libgsf-1</filename> library. All the programs
    should build successfully with no errors displayed.</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><option>--sysconfdir=&gnome-etc-dir;</option>: Pass this parameter to
    the <command>configure</command> script if you have
    <application>GNOME</application>-2 installed so that the
    <application>GConf</application> schema files are installed in the
    correct location.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gsf-office-thumbnailer (optional)</seg>
        <seg>libgsf-1.{so,a} and optionally, libgsf-gnome-1.{so,a}</seg>
        <seg>/usr/include/libgsf-1 and /usr/share/gtk-doc/html/gsf</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>