source: xsoft/office/gnumeric.xml@ 4cca673

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gnumeric-download-http "http://ftp.gnome.org/pub/GNOME/sources/gnumeric/1.6/gnumeric-&gnumeric-version;.tar.bz2">
  <!ENTITY gnumeric-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/gnumeric/1.6/gnumeric-&gnumeric-version;.tar.bz2">
  <!ENTITY gnumeric-md5sum        "e6f769e4e74c29ffea0305d48691fe28">
  <!ENTITY gnumeric-size          "11.9 MB">
  <!ENTITY gnumeric-buildsize     "178 MB">
  <!ENTITY gnumeric-time          "2.0 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gnumeric-&gnumeric-version;.tar</keyword>
      <keyword role="ftpdir">gnumeric</keyword>
    </keywordset>
  </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 financial 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="python"/>,
    <ulink url="http://www.pygtk.org/">PyGTK</ulink>,
    <xref linkend="libgnomeui"/>, <xref linkend="gnome-doc-utils"/> (to
    convert the help documentation into HTML),
    <ulink url="http://www.gnome-db.org/download.php">libgnomedb</ulink>
    (requires <ulink url="http://www.gnome-db.org/download.php">libgda</ulink>),
    <ulink url="http://pxlib.sourceforge.net/">pxlib</ulink> and
    <ulink url="http://www.frodol.dds.nl/psiconv/index.html">Psiconv</ulink></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>

  </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 \
    --localstatedir=/var/lib --sysconfdir=/etc/gnome &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>

    <para>If you have <xref linkend="gnome-doc-utils"/> installed, you can
    convert the XML help files into HTML with the following command:</para>

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

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

<screen role='root'><userinput>install -vdm 755 /usr/share/doc/gnumeric-&gnumeric-version; &amp;&amp;
cp -v doc/C/html/* /usr/share/doc/gnumeric-&gnumeric-version;</userinput></screen>

  </sect2>

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

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts
    <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">/usr/var/scrollkeeper</filename>. This
    switch may not be applicable if you don't have <xref linkend="yelp"/>
    installed, but won't affect the build otherwise.</para>

    <para><parameter>--sysconfdir=/etc/gnome</parameter>: This switch puts
    configuration files in <filename class="directory">/etc/gnome</filename>
    instead of <filename class="directory">/usr/etc</filename>. This
    switch may not be applicable if you don't have <xref linkend="GConf"/>
    installed, but won't affect the build otherwise.</para>

    <para><parameter>--prefix=$(pkg-config --variable=prefix gnome-doc-utils)</parameter>:
    This rebuilds the <filename>Makefile</filename>s with the same prefix as
    <application>gnome-doc-utils</application></para>

    <para><parameter>make -C doc html</parameter>: This command runs
    <command>make</command> in the <filename class="directory">doc</filename>
    directory with html as the <filename>Makefile</filename> target.</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;, and ssconvert</seg>
        <seg>numerous filters, plugins and <application>GNOME</application>
        components</seg>
        <seg>/etc/gnome/gconf/gconf.xml.defaults/apps/gnumeric,
        /etc/gnome/gconf/gconf.xml.defaults/schemas/apps/gnumeric,
        /usr/lib/gnumeric, /usr/share/doc/gnumeric-&gnumeric-version;,
        /usr/share/gnumeric, /usr/share/mc, /usr/share/omf/gnumeric and
        /usr/share/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>

    </variablelist>

  </sect2>

</sect1>