source: general/genlib/enchant.xml@ 55af6ce

<?xml version="1.0" encoding="UTF-8"?>
<!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 enchant-download-http "https://github.com/AbiWord/enchant/releases/download/v&enchant-version;/enchant-&enchant-version;.tar.gz">
  <!ENTITY enchant-download-ftp  " ">
  <!ENTITY enchant-md5sum        "5da2afd6cf92027b4871824d4da4afbf">
  <!ENTITY enchant-size          "5.5 MB">
  <!ENTITY enchant-buildsize     "20 MB (add 63 MB for tests)">
  <!ENTITY enchant-time          "0.1 SBU (add 0.8 SBU for tests)">
]>

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


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

  <indexterm zone="enchant">
    <primary sortas="a-enchant">enchant</primary>
  </indexterm>

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

    <para>
      The <application>enchant</application> package provides a generic
      interface into various existing spell checking libraries.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/> and
      <xref linkend="vala"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="dbus-glib"/>,
      <xref linkend="doxygen"/>,
      <ulink url="http://hspell.ivrix.org.il/">Hspell</ulink>,
      <ulink url="https://hunspell.github.io/">Hunspell</ulink>,
      <ulink url="https://nuspell.github.io/">Nuspell</ulink>,
      <ulink url="https://hunspell.github.io/">Voikko</ulink>, and
      <ulink url="https://github.com/unittest-cpp/unittest-cpp/releases">
        unittest-cpp</ulink> (required for tests)
    </para>


  </sect2>

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

    <para>
      First, remove a generated file that causes the build to fail.
      The file will be regenerated for the current system.
    </para>

<screen><userinput>rm -f src/api.c</userinput></screen>

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

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --docdir /usr/share/doc/enchant-&enchant-version; &amp;&amp;
make</userinput></screen>

    <para>
      To run tests, unittest-cpp must be installed and the
      <option>--enable-relocatable</option> option passed to configure above.
      If these conditions are present, the tests may be run with <command>make
      check</command>.
    </para>

    <para>
      Now, 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>

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

  </sect2>

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

    <sect3 id="enchant-config">
      <title>Config Files</title>
      <para>
        <filename>~/.enchant</filename> and
        <filename>/usr/share/enchant/enchant.ordering</filename>
      </para>

      <indexterm zone="enchant enchant-config">
        <primary sortas="e-AA.enchant">~/.enchant</primary>
      </indexterm>

      <indexterm zone="enchant enchant-config">
        <primary
        sortas="e-usr-share-enchant-enchant.ordering">/usr/share/enchant/enchant.ordering</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>
<!--
   Looks like this is not required when installing enchant in the flavor
   we do above. Leaving it in source (for a while) in case I'm wrong and
   it needs to be restored.
      <para>
        If you wish to use the <xref linkend="aspell"/> backend, create a
        symlink, as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>ln -svfn ../../lib/aspell /usr/share/enchant/aspell</userinput></screen>
-->
      <para>
        You can test your installation and configuration by creating a test
        file and running the following commands (you can replace the
        en_GB dictionary by any other downloaded when installing <xref
        linkend="aspell"/>):
      </para>

<screen remap="test"><userinput>cat &gt; /tmp/test-enchant.txt &lt;&lt; "EOF"
<literal>Tel me more abot linux
Ther ar so many commads</literal>
EOF

enchant-2 -d en_GB -l /tmp/test-enchant.txt &amp;&amp;
enchant-2 -d en_GB -a /tmp/test-enchant.txt</userinput></screen>

      <para>
        You will see a list of the misspelled words followed by a list of
        alternatives for them.
      </para>

      <para>
        See more details in the enchant manual page.
      </para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>enchant-2 and enchant-lsmod-2</seg>
        <seg>libenchant-2.so</seg>
        <seg>/usr/include/enchant-2, /usr/lib/enchant-2,
          /usr/share/enchant, and /usr/share/doc/enchant-&enchant-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="enchant-2">
        <term><command>enchant-2</command></term>
        <listitem>
          <para>
            is a spellchecker
          </para>
          <indexterm zone="enchant enchant-2">
            <primary sortas="b-enchant-2">enchant-2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="enchant-lsmod-2">
        <term><command>enchant-lsmod-2</command></term>
        <listitem>
          <para>
            lists available backends, languages, and dictionaries
          </para>
          <indexterm zone="enchant enchant-lsmod-2">
            <primary sortas="b-enchant-lsmod-2">enchant-lsmod-2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libenchant-2">
        <term><filename class="libraryfile">libenchant-2.so</filename></term>
        <listitem>
          <para>
            contains spell checking interface API functions
          </para>
          <indexterm zone="enchant libenchant-2">
            <primary sortas="c-libenchant-2">libenchant-2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>