glfs/xsoft/office/gnumeric.xml

<?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 gnumeric-download-http "&gnome-download-http;/gnumeric/1.8/gnumeric-&gnumeric-version;.tar.bz2">
  <!ENTITY gnumeric-download-ftp  "&gnome-download-ftp;/gnumeric/1.8/gnumeric-&gnumeric-version;.tar.bz2">
  <!ENTITY gnumeric-md5sum        "f60edc6ca42daa2fb3717f3c90fa8a6e">
  <!ENTITY gnumeric-size          "14.0 MB">
  <!ENTITY gnumeric-buildsize     "206 MB">
  <!ENTITY gnumeric-time          "3.0 SBU (includes creating HTML documentation)">
]>

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

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

  <title>Gnumeric-&gnumeric-version;</title>

  <indexterm zone="gnumeric">
    <primary sortas="a-Gnumeric">Gnumeric</primary>
  </indexterm>

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

    <para>The <application>Gnumeric</application> package contains a
    spreadsheet program. This is useful for mathematical analysis.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgnomeprintui"/> and
    <xref linkend="goffice"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="pygtk"/>,
    <xref linkend="libgnomeui"/> (combined with the
    <filename class='libraryfile'>libgsf-gnome-1</filename> library from the
    <xref linkend="libgsf"/> package will provide GNOME-2 support),
    <ulink url="http://www.gnome-db.org/">libgnomedb</ulink>*
    (requires <ulink url="http://www.gnome-db.org/">libgda</ulink>),
    <ulink url="http://pxlib.sourceforge.net/">pxlib</ulink>,
    <ulink url="http://www.frodol.dds.nl/psiconv/index.html">Psiconv</ulink>,
    <ulink url="http://www.maemo.org/">Hildon</ulink>,
    <ulink url="http://packages.ubuntu.com/warty/libdevel/libgb-dev">Gnome
    Basic</ulink> (this package is no longer under active development), and
    <ulink url="http://www.valgrind.org/">Valgrind</ulink> (to run some of the
    testsuite)</para>

    <para>* The
    <application>libgda</application>/<application>libgnomedb</application>
    stack required for <application>Gnumeric</application> database
    access may conflict with the versions used by the
    <xref linkend="abiword"/> database plugin. Though the libraries
    themselves pose no conflict, the executables and support files will
    overwrite one another. Note that the current (version 3.0.x) stack does not
    pose a conflict with any of the previous versions (but does not support
    <application>Gnumeric</application> or <application>AbiWord</application>
    database access. <application>Gnumeric</application> requires versions
    &gt;1.2.x and &lt;2.x.x (1.99.1 is known to work).</para>

    <note>
      <para>Though only a run-time dependency, if you don't install the
      <xref linkend="yelp"/> package, the built-in help functionality in
      <application>Gnumeric</application> will not be available.</para>
    </note>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib &amp;&amp;
make</userinput></screen>

    <para>This package requires that it is installed before the test suite is
    run. The commands to run the tests are located a bit later in the
    instructions.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>make install &amp;&amp;</userinput></screen>

    <para>If you have <xref linkend="gnome-doc-utils"/> installed you can
    create an HTML version of the Help documentation by issuing the following
    commands:</para>

<screen><userinput>./configure \
    --prefix=$(pkg-config --variable=prefix gnome-doc-utils) &amp;&amp;
make -C doc html</userinput></screen>

    <para>If you created the HTML documentation, install it by issuing the
    following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>install -v -m755 -d /usr/share/doc/gnumeric-&gnumeric-version;/figures/icons &amp;&amp;
install -v -m644    doc/C/figures/*.png \
                    /usr/share/doc/gnumeric-&gnumeric-version;/figures &amp;&amp;
install -v -m644    doc/C/figures/icons/*.png \
                    /usr/share/doc/gnumeric-&gnumeric-version;/figures/icons &amp;&amp;
install -v -m644    doc/C/html/* \
                    /usr/share/doc/gnumeric-&gnumeric-version; &amp;&amp;

ln -v -s /usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;/images \
    /usr/share/doc/gnumeric-&gnumeric-version;/stylesheet</userinput></screen>

    <para>If you wish to install the Developer documentation, issue the
    following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role='root'><userinput>install -v -m755 -d /usr/share/doc/gnumeric-&gnumeric-version;/developer &amp;&amp;
install -v -m644    doc/developer/* \
                    /usr/share/doc/gnumeric-&gnumeric-version;/developer &amp;&amp;

rm -v /usr/share/doc/gnumeric-&gnumeric-version;/developer/Makefile*</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-sysconfdir.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/scrollkeeper-dir.xml"/>

    <para><parameter>--prefix=$(pkg-config
    --variable=prefix gnome-doc-utils)</parameter>:
    This rebuilds the <filename>Makefile</filename>s with the same prefix used
    in the <application>GNOME Doc Utils</application> installation.</para>

  </sect2>

  <sect2 role="testing">
    <title>Testing gnumeric</title>

    <para>If you wish to run the testuite, issue:</para>

<screen><userinput>make check</userinput></screen>

    <para>Two of the seven tests fail because the scripts they use
    are missing, two others fail for unknown reasons.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gnumeric, gnumeric-&gnumeric-version;, ssconvert, and ssindex</seg>
        <seg>libspreadsheet and numerous filters, plugins and
        <application>GNOME</application> components</seg>
        <seg>/usr/lib/gnumeric,
        /usr/share/doc/gnumeric-&gnumeric-version;, and
        /usr/share/{,gnome/help/, omf/, pixmaps/}gnumeric</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnumeric-prog">
        <term><command>gnumeric</command></term>
        <listitem>
          <para>is a symlink to
          <command>gnumeric-&gnumeric-version;</command></para>
          <indexterm zone="gnumeric gnumeric-prog">
            <primary sortas="g-gnumeric">gnumeric</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gnumeric-1">
        <term><command>gnumeric-&gnumeric-version;</command></term>
        <listitem>
          <para>is <application>GNOME</application>'s spreadsheet
          application.</para>
          <indexterm zone="gnumeric gnumeric-1">
            <primary sortas="b-gnumeric-&gnumeric-version;">gnumeric-&gnumeric-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ssconvert">
        <term><command>ssconvert</command></term>
        <listitem>
          <para>is a command line utility to convert spreadsheet files
          between various spreadsheet file formats.</para>
          <indexterm zone="gnumeric ssconvert">
            <primary sortas="b-ssconvert">ssconvert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ssindex">
        <term><command>ssindex</command></term>
        <listitem>
          <para>is a command line utility to generate index data for
          spreadsheet files.</para>
          <indexterm zone="gnumeric ssindex">
            <primary sortas="b-ssindex">ssindex</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>