source: xsoft/office/abiword.xml@ efc31fb

<?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-minor-version "3.0">

  <!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        "cda6dd58c747c133b421cc7eb18f5796">
  <!ENTITY AbiWord-size          "11 MB">

  <!ENTITY AbiWordDocs-download-http
           "http://www.abisource.com/downloads/abiword/&AbiWord-version;/source/abiword-docs-&AbiWord-version;.tar.gz">
  <!ENTITY AbiWordDocs-md5sum        "c92c0e1e2081db20757231a53d80c338">
  <!ENTITY AbiWordDocs-size          "1.5 MB">

  <!ENTITY AbiWord-buildsize     "626 MB, additional 12 MB for docs (73 MB installed - additional 3.1 MB for docs)">
  <!ENTITY AbiWord-time          "6.5 SBU - additional 0.5 SBU for docs">
]>

<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>
      <application>AbiWord</application> is a word processor which is useful for
      writing reports, letters and other formatted documents.
    </para>

    <!-- https://bugzilla.abisource.com/show_bug.cgi?id=13791. Fixed upstream
    <note>
      <para>
        It has been reported that, depending on the desktop enviroment and on
        the theme settings, the window where <application>Abiword</application>
        is running may flicker. This is known uptream, but no fix seems to be
        available yet.
      </para>
    </note>
-->
    &lfs84_checked;

    <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>
          AbiWord Docs: <ulink url="&AbiWordDocs-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          AbiWord Docs MD5 sum: &AbiWordDocs-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          AbiWord Docs size: &AbiWordDocs-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Required patch (fixes GTK+-3.22.x rendering):
          <ulink url="&patch-root;/abiword-&AbiWord-version;-gtk3_22_render_fix-1.patch"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Recommended patch (fixes flickering and caret problems):
          <ulink url="&patch-root;/abiword-&AbiWord-version;-fix_flicker-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="boost"/>,
      <xref linkend="fribidi"/>,
      <xref linkend="goffice010"/>, and
      <xref linkend="wv"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="enchant"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="dbus-glib"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="libgcrypt"/>,
      <xref linkend="libical"/>,
      <xref linkend="libsoup"/>,
      <xref linkend="redland"/>,
      <xref linkend="valgrind"/>.
      <ulink url="http://aiksaurus.sourceforge.net/">Aiksaurus</ulink>,
      <phrase revision="sysv"><ulink url="&gnome-download-http;/evolution-data-server/">
      Evolution Data Server</ulink></phrase>
      <phrase revision="systemd"><xref linkend="evolution-data-server"/></phrase>,
      <ulink url="http://helm.cs.unibo.it/mml-widget/">GtkMathView</ulink>,
      <phrase revision="sysv"><ulink url="&gnome-download-http;/libchamplain">libchamplain</ulink></phrase>
      <phrase revision="systemd"><xref linkend="libchamplain"/></phrase>,
      <ulink url="http://sourceforge.net/projects/wvware">libwmf</ulink>,
      <ulink url="http://sourceforge.net/projects/libwpd/">libwpd</ulink>,
      <ulink url="http://sourceforge.net/projects/libwpg/">libwpg</ulink>,
      <ulink url="http://sourceforge.net/projects/libwps/">libwps</ulink>,
      <ulink url="http://www.abisource.com/projects/link-grammar/">
      Link Grammar Parser</ulink>,
      <ulink url="&gnome-download-http;/loudmouth">Loudmouth</ulink>,
      <phrase revision="sysv"><ulink url="http://telepathy.freedesktop.org/releases/telepathy-glib/">
      Telepathy GLib</ulink></phrase>
      <phrase revision="systemd"><xref linkend="telepathy-glib"/></phrase>,
      <ulink url="https://sourceforge.net/projects/otslibrary/">OTS</ulink>, and
      <ulink url="http://software.frodo.looijaard.name/psiconv/">Psiconv</ulink>
    </para>

    <note>
      <para>
        To enable many of the optional dependencies, review the information
        from <command>./configure --help</command> for the necessary switches
        you must pass to the <command>configure</command> script.
      </para>
    </note>


    <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>patch -Np1 -i ../abiword-&AbiWord-version;-gtk3_22_render_fix-1.patch &amp;&amp;

patch -Np1 -i ../abiword-&AbiWord-version;-fix_flicker-1.patch &amp;&amp;
   
sed -e "s/free_suggestions/free_string_list/" \
    -e "s/_to_personal//"                     \
    -e "s/in_session/added/"                  \
    -i src/af/xap/xp/enchant_checker.cpp      &amp;&amp;

sed -e "/icaltime_from_timet/{s/timet/&amp;_with_zone/;s/0/0, 0/}" \
    -i src/text/ptbl/xp/pd_DocumentRDF.cpp &amp;&amp;

./configure --prefix=/usr --without-evolution-data-server &amp;&amp;
make</userinput></screen>

    <para>
      This program does not come with a functional test suite.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>

    <note>
      <para>
        In order to install the local help files,
        a graphics session is recommended.
      </para>
    </note>

    <para>
      If you wish to install the local help files, untar and build them first:
    </para>

<!-- I had to hardcode the docs version here, as it doesn't decompress to
     abiword-docs-3.0.2. -->
<screen><userinput>tar -xf ../abiword-docs-&AbiWord-version;.tar.gz &amp;&amp;
cd abiword-docs-3.0.1                &amp;&amp;
./configure --prefix=/usr            &amp;&amp;
make</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>
      <command>sed ...</command>: These commands correct the source for
      changes in dependencies <xref linkend="enchant"/> and 
      <xref linkend="libical"/>.
    </para>

    <para>
      <option>--without-evolution-data-server</option>: This switch disables
      <application>AbiWord</application>
      <application>Evolution Data Server</application> support which is known
      to fail when using recent versions of
      <application>Evolution Data Server</application>.
    </para>

    <para>
      <option>--enable-plugins="collab openxml goffice grammar"</option>: Build
      some or all plugins. The openxml plugin enables
      <application>Abiword</application> to open some .docx files.
      The grammar plugin requires
      <ulink url="http://www.abisource.com/projects/link-grammar/">Link Grammar
      Parser</ulink>
    </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
        <xref linkend="dejavu-fonts"/>,
    <!--
        <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>

      <para>
        If you have <xref linkend="xdg-utils"/> installed, you should
        run the <command>xdg-icon-resource forceupdate --theme hicolor</command>
        command, for the installed icon to be displayed in the menu item.
      </para>

    </sect3>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          abiword
        </seg>
        <seg>
          libabiword-&AbiWord-minor-version;.so
        </seg>
        <seg>
          /usr/include/abiword-&AbiWord-minor-version;,
          /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</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</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>