source: general/genlib/libgsf.xml@ 4da8233

<?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.xz">
  <!ENTITY libgsf-download-ftp  "&gnome-download-ftp;/libgsf/1.14/libgsf-&libgsf-version;.tar.xz">
  <!ENTITY libgsf-md5sum        "337a0dfa832d2af6f171b53adac697c1">
  <!ENTITY libgsf-size          "688 KB">
  <!ENTITY libgsf-buildsize     "14 MB (with tests)">
  <!ENTITY libgsf-time          "0.3 SBU (with tests)">
]>

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

  <sect1info>
    <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 a library
      used for providing an extensible input/output abstraction layer for
      structured file formats.
    </para>

    &lfs111_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"/> and
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gdk-pixbuf"/>
      (To build <command>gsf-office-thumbnailer</command>)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk-doc"/>, and
      <xref linkend="perl-xml-parser"/> (for tests)
    </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 --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>
          gsf, gsf-office-thumbnailer, and gsf-vba-dump
        </seg>
        <seg>
          libgsf-1.so
        </seg>
        <seg>
          /usr/include/libgsf-1,
          /usr/share/gtk-doc/html/gsf and
          /usr/share/thumbnailers
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gsf">
        <term><command>gsf</command></term>
        <listitem>
          <para>
            is a simple archive utility, somewhat similar to tar(1)
          </para>
          <indexterm zone="libgsf gsf">
            <primary sortas="b-gsf">gsf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gsf-office-thumbnailer">
        <term><command>gsf-office-thumbnailer</command></term>
        <listitem>
          <para>
            is used internally by <application>GNOME</application> applications
            such as <application>Nautilus</application> to generate
            thumbnails of several types of office application files
          </para>
          <indexterm zone="libgsf gsf-office-thumbnailer">
            <primary sortas="b-gsf-office-thumbnailer">gsf-office-thumbnailer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gsf-vba-dump">
        <term><command>gsf-vba-dump</command></term>
        <listitem>
          <para>
            is used to extract Visual Basic for Applications macros from files
          </para>
          <indexterm zone="libgsf gsf-vba-dump">
            <primary sortas="b-gsf-vba-dump">gsf-vba-dump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgsf-1">
        <term><filename class="libraryfile">libgsf-1.so</filename></term>
        <listitem>
          <para>
            contains the <application>libgsf</application> API functions
          </para>
          <indexterm zone="libgsf libgsf-1">
            <primary sortas="c-libgsf-1">libgsf-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>