source: x/lib/goffice.xml@ cf196f73

<?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 goffice-download-http "&gnome-download-http;/goffice/0.4/goffice-&goffice-version;.tar.bz2">
  <!ENTITY goffice-download-ftp  "&gnome-download-ftp;/goffice/0.4/goffice-&goffice-version;.tar.bz2">
  <!ENTITY goffice-md5sum        "a8aa21d089a0ae6f62cb2a9bb70e83db">
  <!ENTITY goffice-size          "3.0 MB">
  <!ENTITY goffice-buildsize     "53 MB">
  <!ENTITY goffice-time          "1.0 SBU">
]>

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

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

  <title>GOffice-&goffice-version;</title>

  <indexterm zone="goffice">
    <primary sortas="a-GOffice">GOffice</primary>
  </indexterm>

  <!--Required section-->
  <sect2 role="package">
    <title>Introduction to GOffice</title>

    <para>The <application>GOffice</application> package contains a library of
    <application>GLib</application>/<application>GTK</application> document
    centric objects and utilities. This is useful for performing common
    operations for document centric applications that are conceptually simple,
    but complex to implement fully. Some of the operations provided by the
    <application>GOffice</application> library include support for plugins,
    load/save routines for application documents and undo/redo functions.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/goffice-&goffice-version;-gtkdoc_rebase-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgsf"/>,
    <xref linkend="pango"/>,
    <xref linkend="pcre"/>, and
    <xref linkend="which"/></para>

    <bridgehead renderas="sect4">Recommended (for the User Interface
    functionality)</bridgehead>
    <para role="recommended"><xref linkend="libglade"/> and
    <xref linkend="libgnomeprint"/></para>

    <para>Note: not installing the recommended dependencies can render the
    <application>GOffice</application> package incapable of supporting
    applications which depend on it. If, for whatever reason, you elect not
    to install the recommended dependencies, you must add the
    <option>--without-gtk</option> parameter to the <command>configure</command>
    command in the instructions below.</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="intltool"/>,
    <xref linkend="gtk-doc"/>, and
    <xref linkend="libgnomeui"/>
    (with <application>libgsf</application> built to support GNOME by creating
    the <filename class='libraryfile'>libgsf-gnome-1</filename> library)</para>

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

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../goffice-&goffice-version;-gtkdoc_rebase-1.patch &amp;&amp;
</userinput></screen>
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</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/2003/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </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>libgoffice-0.so and numerous support plugins</seg>
        <seg>/usr/include/libgoffice-0.4,
        /usr/lib/goffice,
        /usr/share/{gtk-doc/html/goffice,{pixmaps/}goffice}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgoffice">
        <term><filename class='libraryfile'>libgoffice-0.so</filename></term>
        <listitem>
          <para>contains API functions to provide support for document centric
          objects and utilities.</para>
          <indexterm zone="goffice libgoffice">
            <primary sortas="c-libgoffice-0">libgoffice-0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>