source: general/genlib/enchant.xml@ 469bc5d4

<?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 enchant-download-http "http://www.abisource.com/downloads/enchant/&enchant-version;/enchant-&enchant-version;.tar.gz">
  <!ENTITY enchant-download-ftp  "ftp://ftp.netbsd.org/pub/pkgsrc/distfiles/enchant-&enchant-version;.tar.gz">
  <!ENTITY enchant-md5sum        "de11011aff801dc61042828041fb59c7">
  <!ENTITY enchant-size          "593 KB">
  <!ENTITY enchant-buildsize     "17 MB">
  <!ENTITY enchant-time          "0.3 SBU">
]>

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

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

  <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 provide a generic
    interface into various existing spell checking libraries.</para>

    &lfs75_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"/></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"/>,
    <ulink url="http://hspell.ivrix.org.il/">Hspell</ulink>,
    <ulink url="http://hunspell.sourceforge.net/">Hunspell</ulink>, and
    <ulink url="http://voikko.sourceforge.net/">Voikko</ulink></para>

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

  </sect2>

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

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

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

  </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>

      <para>See more details in the enchant(1) 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 and enchant-lsmod</seg>
        <seg>libenchant.{so,a} and various backend libraries</seg>
        <seg>/usr/{include/enchant,lib/enchant,share/enchant}</seg>
      </seglistitem>
    </segmentedlist>

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

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

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

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

    </variablelist>

  </sect2>

</sect1>