source: xsoft/office/abiword.xml@ 7ff76531

<?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.bz2">
  <!ENTITY AbiWord-download-ftp  " ">
  <!ENTITY AbiWord-md5sum        "8ed5fb282b9741aca75b9e47500d39a1">
  <!ENTITY AbiWord-size          "25 MB">
  <!ENTITY AbiWord-buildsize     "262 MB (additional 210 MB to build and install the API docs)">
  <!ENTITY AbiWord-time          "4.5 SBU (to build and install the program, docs and all plugins)">
  <!ENTITY AbiWord-minor-version "2.4">
  <!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">AbiWord Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libgnomeui"/> (for GNOME-2 support),
    <xref linkend="gucharmap"/>,
    <xref linkend="enchant"/> (uses
    <xref linkend="aspell"/>),
    <ulink url="http://wvware.sourceforge.net/">wv</ulink> (with
    <ulink url="http://sourceforge.net/projects/wvware">libwmf</ulink> installed first), and
    <ulink url="http://valgrind.org/">Valgrind</ulink></para>

    <bridgehead renderas="sect4">Optional for Plugins</bridgehead>
    <para role="optional"><xref linkend="libgsf"/> (to build the OpenDocument/OpenOffice plugin),
    <xref linkend="poppler"/> (for the pdf plugin, requires installing with unsupported xpdf headers),
    <xref linkend="librsvg"/>,
    <!-- Currently Broken <xref linkend="html-tidy"/>, -->
    <!-- Currently Broken <ulink url="http://www.inter7.com/index.php?page=eps">EPS</ulink>, -->
    <xref linkend="nautilus"/> (for GNOME-2 support),
    <xref linkend="goffice"/> (you must use a version of
    <ulink url="&gnome-download-http;/goffice/0.2/">GOffice &lt;0.3.0</ulink>),
    <ulink url="http://www.abisource.com/projects/link-grammar/">Link Grammar</ulink>,
    <ulink url="http://aiksaurus.sourceforge.net/">Aiksaurus</ulink>,
    <ulink url="http://www.gnome-db.org/">libgnomedb version &lt;1.3.0</ulink>* (requires
    <ulink url="http://www.gnome-db.org/">libgda version &lt;1.3.0</ulink>),
    <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></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 is known to work).</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>cd abi &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make &amp;&amp;

cd ../abiword-plugins &amp;&amp;
sed -i 's/dictionary_file)/reinterpret_cast&lt;const unsigned char *&gt;(&amp;)/' \
        tools/ots/xp/AbiOts.cpp &amp;&amp;

./configure --prefix=/usr --without-inter7eps &amp;&amp;
make &amp;&amp;

cd ..</userinput></screen>

    <para>If you wish to create the API documentation,
    <xref linkend="doxygen"/> must be installed and issue the following
    commands:</para>

<screen><userinput>pushd abi &amp;&amp;
doxygen &amp;&amp;
popd</userinput></screen>

    <para>This package's test suite requires <ulink
    url="http://valgrind.org/">Valgrind</ulink>. Though the end message will
    indicate the tests failed, there will actually be many tests that run
    to a successful completion. Run the tests by issuing the following
    commands:</para>

<screen><userinput>pushd abi &amp;&amp;
make check &amp;&amp;
popd</userinput></screen>

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

<screen role="root"><userinput>cd abi &amp;&amp;
make install &amp;&amp;

install -v -m755 -d /usr/share/doc/abiword-&AbiWord-version; &amp;&amp;
install -v -m644    docs/*.* \
                    /usr/share/doc/abiword-&AbiWord-version; &amp;&amp;

cd ../abiword-plugins &amp;&amp;
make install &amp;&amp;

cd ..</userinput></screen>

    <para><application>AbiWord</application> is now installed and must be used
    to build the Help files. Issue the following commands as an unprivileged
    user:</para>

<screen><userinput>pushd abiword-docs &amp;&amp;
./make-html.sh &amp;&amp;
cd ..</userinput></screen>

<!-- removing this as it does exactly the same thing as
     the make-html.sh does          ./make-gnome-html.sh &amp;&amp; -->

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

<screen role="root"><userinput>install -v -m644 man/abiword.1 /usr/share/man/man1 &amp;&amp;
install -v -m644 Manual/en/Abiword_Manual.abw \
                 /usr/share/doc/abiword-&AbiWord-version; &amp;&amp;
cp -v -Rf help   /usr/share/AbiSuite-&AbiWord-minor-version;/AbiWord &amp;&amp;
find             /usr/share/AbiSuite-&AbiWord-minor-version;/AbiWord/help \
                 -type d -exec chmod -v 755 {} \;</userinput></screen>

    <para>If you have a <application>GNOME</application> installation, issue
    the following commands as the <systemitem class="username">root</systemitem>
    user to install the <application>AbiWord</application> Bonobo component
    description file:</para>

<screen role="root"><userinput>install -v -m644 abidistfiles/GNOME_AbiWord_Control_&AbiWord-under-version;.server \
        $(pkg-config --variable=prefix ORBit-2.0)/lib/bonobo/servers &amp;&amp;

if [ $(pkg-config --variable=prefix ORBit-2.0) != "/usr" ]; then
    rmdir -v /usr/lib/{bonobo/servers,bonobo}
fi</userinput></screen>

    <para>If you built the API 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/abiword-&AbiWord-version;/api &amp;&amp;

for FILENAME in $(ls abi/docs/dox/html); do
    install -v -m644 abi/docs/dox/html/${FILENAME} \
                     /usr/share/doc/abiword-&AbiWord-version;/api
done</userinput></screen>

  </sect2>

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

    <para><parameter>--without-inter7eps</parameter>: 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><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>

    <para><command>if [ ... != "/usr" ]; then ...;fi</command>:
    This command is used to remove unneeded directories if the
    <application>GNOME</application> installation is in any prefix
    other than <filename class='directory'>/usr</filename>.</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/AbiSuite-&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/AbiSuite-&AbiWord-minor-version;/templates/normal.awt-<replaceable>&lt;lang&gt;</replaceable> \
                    ~/.AbiSuite/templates/normal.awt</userinput></screen>

      <para>Change <replaceable>&lt;lang&gt;</replaceable> in the above
      command to fit the name of the file you want.</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, AbiWord-&AbiWord-minor-version;, ttfadmin.sh, and ttftool</seg>
        <seg>Numerous plugin library support modules</seg>
        <seg>/usr/lib/AbiWord-&AbiWord-minor-version; and
        /usr/share/AbiSuite-&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 a symbolic link to the main
          <command>AbiWord-&AbiWord-minor-version;</command>
          executable.</para>
          <indexterm zone="abiword abiword-prog">
            <primary sortas="g-abiword">abiword</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="AbiWord-version-number">
        <term><command>AbiWord-&AbiWord-minor-version;</command></term>
        <listitem>
          <para>is the word-processing program executable.</para>
          <indexterm zone="abiword AbiWord-version-number">
            <primary sortas="b-AbiWord-&AbiWord-minor-version;">AbiWord-&AbiWord-minor-version;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ttfadmin.sh">
        <term><command>ttfadmin.sh</command></term>
        <listitem>
          <para>generates support files required by
          <application>AbiWord</application> for each TrueType font in a
          given directory.</para>
          <indexterm zone="abiword ttfadmin.sh">
            <primary sortas="b-ttfadmin.sh">ttfadmin.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ttftool">
        <term><command>ttftool</command></term>
        <listitem>
          <para>is a utility for processing TrueType fonts.</para>
          <indexterm zone="abiword ttftool">
            <primary sortas="b-ttftool">ttftool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>