source: x/lib/goffice.xml@ b072b9b

<?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.8/goffice-&goffice-version;.tar.bz2">
  <!ENTITY goffice-download-ftp
  "&gnome-download-ftp;/goffice/0.8/goffice-&goffice-version;.tar.bz2">
  <!ENTITY goffice-md5sum        "b4c924457163e02daf8a8d2428f51d10">
  <!ENTITY goffice-size          "2.2 MB">
  <!ENTITY goffice-buildsize     "86 MB">
  <!ENTITY goffice-time          "1.2 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>

  <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>

    &lfs71_checked;

    <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">GOffice Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="GConf"/>,
      <xref linkend="gtk2"/>,
      <xref linkend="intltool"/>,
      <xref linkend="libgsf"/> and
      <xref linkend="which"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </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>sed -i 's#info (r, NULL#full&amp;, 0#' goffice/utils/regutf8.c &amp;&amp;
./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      If you wish to run the tests, 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>

    <para>
      <option>--disable-static</option>: This switch prevents the static
      libraries in this package being built and installed.
    </para>

    <para>
      <command>sed -i 's#info (r, NULL#full&amp;, 0#'
      goffice/utils/regutf8.c</command>: This sed removes a reference to
      pcre_info, a deprecated function that was removed from
      <application>PCRE-8.30</application>.
    </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 Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>libgoffice-08.so and numerous support plugins.</seg>
        <seg>
          /usr/include/libgoffice-0.8,
          /usr/lib/goffice,
          /usr/share/gtk-doc/html/goffice-0.8 and
          /usr/share/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.8.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.8">libgoffice-0.8.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>