source: general/genlib/aspell.xml@ ff769b8c

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY aspell-download-http "http://gnu.mirror.mcgill.ca/aspell/aspell-&aspell-version;.tar.gz">
<!ENTITY aspell-download-ftp  "ftp://ftp.gnu.org/gnu/aspell/aspell-&aspell-version;.tar.gz">
<!ENTITY aspell-md5sum        "8fa031d0eb37a5538aa6fefa657e707f">
<!ENTITY aspell-size          "1.6 MB">
<!ENTITY aspell-buildsize     "39.3 MB">
<!ENTITY aspell-time          "0.74 SBU">
]>

<sect1 id="aspell" xreflabel="Aspell-&aspell-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="aspell.html"?>
<title>Aspell-&aspell-version;</title>

<sect2>
<title>Introduction to <application>Aspell</application></title>

<para>The <application>Aspell</application> package contains an interactive 
spell checking program and the <application>Aspell</application> libraries.
<application>Aspell</application> can either be used as a library or as an
independent spell checker.</para>

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

<sect3><title>Additional download(s)</title>
<para>You'll need to download at least one dictionary. The link below will take 
you to a page containing links to dictionaries in many languages.</para>

<itemizedlist spacing='compact'>
<listitem><para>Aspell dictionaries: <ulink 
url="ftp://ftp.gnu.org/gnu/aspell/dict"/></para></listitem>
</itemizedlist>
</sect3>

<sect3><title><application>Aspell</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="which"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Aspell</application></title>

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

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Configuring <application>Aspell</application></title>

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

<para>After <application>Aspell</application> is installed, you must set up at 
least one dictionary. Install one or more dictionaries by running the following 
commands:</para>

<screen><userinput><command>./configure &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Aspell</application> package contains 
<command>aspell</command>, 
<command>aspell-import</command>, 
<command>precat</command>, 
<command>preunzip</command>, 
<command>prezip</command>, 
<command>prezip-bin</command>, 
<command>pspell-config</command>, 
<command>run-with-aspell</command>, 
<command>word-list-compress</command>, 
filters, dictionaries, compatibility scripts and the
<filename class='libraryfile'>libaspell</filename> and 
<filename class='libraryfile'>libpspell</filename> libraries.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>aspell</title>
<para><command>aspell</command> is a utility that can function as an 
<command>ispell -a</command> replacement, as an independent spell checker, as 
a test utility to test out <application>Aspell</application> features, and as 
a utility for managing dictionaries.</para></sect3>

<sect3><title>aspell-import</title>
<para><command>aspell-import</command> imports old personal dictionaries into 
<application>Aspell</application>.</para></sect3>

<sect3><title>precat</title>
<para><command>precat</command> decompresses a <command>prezip</command>ped 
file to stdout.</para></sect3>

<sect3><title>preunzip</title>
<para><command>preunzip</command> decompresses a <command>prezip</command>ped 
file.</para></sect3>

<sect3><title>prezip</title>
<para><command>prezip</command> is a prefix delta compressor, used to compress 
sorted word lists or other similar text files.</para></sect3>

<sect3><title>prezip-bin</title>
<para><command>prezip-bin</command> is called by the various wrapper scripts to 
perform the actual compressing and decompressing.</para></sect3>

<sect3><title>pspell-config</title>
<para><command>pspell-config</command> displays information about the 
<filename class='libraryfile'>libpspell</filename> installation, mostly for use 
in build scripts.</para></sect3>

<sect3><title>run-with-aspell</title>
<para><command>run-with-aspell</command> is a script to help use 
<application>Aspell</application> as an <command>ispell</command> 
replacement.</para></sect3>

<sect3><title>word-list-compress</title>
<para><command>word-list-compress</command> compresses or decompresses sorted 
word lists for use with the <application>Aspell</application> spell 
checker.</para></sect3>

<sect3><title>aspell libraries</title>
<para>The <filename class='libraryfile'>lib{a,p}spell</filename> libraries 
are spell checking library interfaces.</para></sect3>

</sect2>

</sect1>