source: general/genlib/libgsf.xml@ b88be39

<?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 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        "2d09ad4e61a650b5d554b5fca8250046">
  <!ENTITY libgsf-size          "579 KB">
  <!ENTITY libgsf-buildsize     "20 MB">
  <!ENTITY libgsf-time          "0.4 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </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>

    &lfs67_checked;

    <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="python"/>,
    <xref linkend="pygtk"/>,
    <xref linkend="GConf"/> (required to build the
    <command>gsf-office-thumbnailer</command> program),
    <xref linkend="gnome-vfs"/> and <xref linkend="libbonobo"/> (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 should build the
    <filename class='libraryfile'>libgsf-gnome-1.so</filename> library if you
    plan on building <xref linkend="gnucash"/> or
    <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 --without-python &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>

    <para><parameter>--without-python</parameter>: This parameter is required
    if <application>Python</application> is not installed. Remove it if
    <application>Python</application> is installed.</para>

    <para><option>--disable-static</option>: This switch prevents the
    static libraries in this package being built and installed.</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 Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gsf, gsf-office-thumbnailer (optional), and gsf-vba-dump</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 and
        optionally, /usr/lib/python&python2-majorver;/site-packages/gsf</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>