source: xsoft/office/abiword.xml@ 15114f7

<?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 AbiWord-download-http "http://www.abisource.com/downloads/abiword/&AbiWord-version;/source/abiword-&AbiWord-version;.tar.gz">
  <!ENTITY AbiWord-download-ftp  " ">
  <!ENTITY AbiWord-md5sum        "f883b0a7f26229a9c66fd6a1a94381aa">
  <!ENTITY AbiWord-size          "9 MB">
  <!ENTITY AbiWord-buildsize     "684 MB (without collab or plugins except OpenDocument, additional 8 MB to install local HTML docs)">
  <!ENTITY AbiWord-time          "6.6 SBU">
  <!ENTITY AbiWordDocs-download-http "http://www.abisource.com/downloads/abiword/&AbiWord-version;/source/abiword-docs-&AbiWord-version;.tar.gz">
  <!ENTITY AbiWord-minor-version "2.8">
  <!--<!ENTITY AbiWord-under-version "2_4">-->
]>

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

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

  <title>AbiWord-&AbiWord-version;</title>

  <indexterm zone="abiword">
    <primary sortas="a-AbiWord">AbiWord</primary>
  </indexterm>

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

    <para>The <application>AbiWord</application> package contains a word
    processing application. This is useful for writing reports, letters and
    other formatted documents.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Optional Documentation: If running on a gnome desktop, the help
        menu will open <application>epiphany</application> at <ulink
        url="http://www.abisource.com/help/en-US/index.html"/>.  If you wish
        to install a copy of the en-US, fr-FR and pl-PL HTML documentation on
        your machine, download <ulink url="&AbiWordDocs-download-http;"/>
        (size 1.4MB md5sum 197df94c1d9ed287903cb5aa0b60bbc1). The local files
        will not be automatically referenced if you do not have a fairly
        complete gnome desktop (epiphany and yelp on their own are not enough),
        but you can still open them in your browser of choice.</para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="fribidi"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="libpng"/>,
    <xref linkend="librsvg"/> and
    <xref linkend="wv"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <ulink url="http://aiksaurus.sourceforge.net/">Aiksaurus</ulink>,
    <ulink url="http://www.boost.org/">Boost</ulink> (required for collab),
    <xref linkend="dbus-glib"/> (for the collab sugar backend),
    <xref linkend="enchant"/>,
    <xref linkend="goffice"/>),
    <ulink url="http://helm.cs.unibo.it/mml-widget/">GtkMathView</ulink> (requires
    <ulink url="http://www.gnome-db.org/">libgnomedb version &lt;1.3.0</ulink>*
    which requires
    <ulink url="http://www.gnome-db.org/">libgda version &lt;1.3.0</ulink>),
    <ulink url="http://sourceforge.net/projects/mission-control/files/">libmissioncontrol</ulink>,
    <xref linkend="empathy"/> and
    <xref linkend="telepathy-glib"/> (for the collab telepathy backend),
    <ulink url="http://ftp.imendio.com/pub/imendio/loudmouth/src/">loudmouth</ulink>
    (for the collab xmpp backend),
    <xref linkend="gnutls"/> and
    <xref linkend="libsoup"/> (for the collab service),
    <ulink url="http://sourceforge.net/projects/wvware">libwmf</ulink>,
    <ulink url="http://helm.cs.unibo.it/mml-widget/">GtkMathView</ulink> (requires
    <ulink url="http://sourceforge.net/projects/gmetadom/">Gnome DOM Bindings</ulink> which requires
    <ulink url="http://gdome2.cs.unibo.it/">gdome2</ulink>),
    <ulink url="http://libwpd.sourceforge.net/">libwpd</ulink>,
    <ulink url="http://libots.sourceforge.net/">OTS</ulink>, and
    <ulink url="http://software.frodo.looijaard.name/psiconv/">Psiconv</ulink>
    Some of these are not automatically detected and need to be specified to the
    configure script.</para>

    <para>* The
    <application>libgda</application>/<application>libgnomedb</application>
    stack required for <application>AbiWord</application> database
    access may conflict with the versions used by the
    <xref linkend="gnumeric"/> 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>AbiWord</application> or <application>Gnumeric</application>
    database access. <application>AbiWord</application> requires versions
    &lt;1.3.0 (1.2.2 was known to work when last tested).</para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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>

    <para>If you wish to install the local help files, untar them</para>
<screen><userinput>tar -xf ../abiword-docs-&AbiWord-version;.tar.gz &amp;&amp;
cd abiword-docs-&AbiWord-version;</userinput></screen>

    <para>and then, 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>--without-inter7eps</option>: Some of the headers from
    the <application>EPS</application> package are not compatible with
    <application>GCC</application>-&gcc-version;. This parameter prevents
    linking to the package and incurring a build failure.</para>

    <para><option>--disable-static</option>: This switch prevents the static
    library being built. On x86_64 it also saves a large amount of build time.
    </para>

    <para><option>--enable-plugins=collab</option>: Build some or all of the
    collab plugins.</para>

    <para><command>sed -i '...' tools/ots/xp/AbiOts.cpp </command>:
    This command is used to fix an incompatibility with
    <application>GCC</application> and the
    <application>libots</application> package.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring AbiWord</title>

    <sect3 id="abiword-config">
      <title>Config File</title>

      <para><filename>~/.AbiSuite/templates/normal.awt</filename></para>

      <indexterm zone="abiword abiword-config">
        <primary sortas="e-AA.AbiSuite-templates-normal">~/.AbiSuite/templates/normal.awt</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>Choose the right template for your language and locale from the
      list produced by the following command:</para>

<screen><userinput>ls /usr/share/abiword-&AbiWord-minor-version;/templates</userinput></screen>

      <para>Create the folder
      <filename class='directory'>~/.AbiSuite/templates</filename> then copy the
      <filename>normal.awt</filename> you want into it:</para>

<screen><userinput>install -v -m750 -d ~/.AbiSuite/templates &amp;&amp;
install -v -m640    /usr/share/abiword-&AbiWord-minor-version;/templates/normal.awt-<replaceable>&lt;lang&gt;</replaceable> \
                    ~/.AbiSuite/templates/normal.awt</userinput></screen>

      <para>Change <replaceable>&lt;lang&gt;</replaceable> by the above
      command to fit the name of the file you want.</para>

      <para>If you are using multiple languages, you may need to edit the template
      to use a font with greater coverage (e.g. one of the
      <ulink url="http://dejavu.sourceforge.net/">DejaVu fonts</ulink>),
      because <application>Abiword</application> does not use
      <application>fontconfig</application> and can only display glyphs that
      are provided in the chosen font.</para>

      <para>If you have <xref linkend="desktop-file-utils"/> installed,
      you should run the <command>update-desktop-database</command> command
      to update the mimeinfo cache and allow the Help system to work.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>abiword</seg>
        <seg>libabiword-&AbiWord-minor-version; and one or more plugin library
        support modules</seg>
        <seg>/usr/lib/abiword-&AbiWord-minor-version; and
        /usr/share/abiword-&AbiWord-minor-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="abiword-prog">
        <term><command>abiword</command></term>
        <listitem>
          <para>is the word processor, a wrapper for the functions in
          libabiword-&AbiWord-minor-version; - it can also be used on the
          command line, see <command>man 1 abiword</command>.</para>
          <indexterm zone="abiword abiword-prog">
            <primary sortas="b-abiword">abiword</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libabiword">
        <term><filename class='libraryfile'>libabiword-&AbiWord-minor-version;.{so,a}</filename></term>
        <listitem>
          <para>provides functions to access MS Word documents.</para>
          <indexterm zone="abiword libabiword">
            <primary sortas="c-libabiword">libabiword-&AbiWord-minor-version;.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>