source: general/genlib/ispell.xml@ e4a21ed

<?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 ispell-download-http "http://membled.com/work/patches/ispell/ispell-&ispell-version;.tar.bz2">
  <!ENTITY ispell-download-ftp " ">
  <!ENTITY ispell-md5sum "d5d867e62776524f60b3b5dcc3d8014f">
  <!ENTITY ispell-size "1.2 MB">
  <!ENTITY ispell-buildsize "11 MB">
  <!ENTITY ispell-time "less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">ispell-&ispell-version;.tar</keyword>
      <keyword role="ftpdir">ispell</keyword>
    </keywordset>
  </sect1info>

  <title>Ispell-&ispell-version;</title>

  <indexterm zone="ispell">
    <primary sortas="a-Ispell">Ispell</primary>
  </indexterm>

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

    <para>The <application>ispell</application> package contains a spell
    checker that can handle international languages.</para>

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

  </sect2>

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

    <para>The first step is to create <filename>local.h</filename>.</para>

<screen><userinput>sed -e "s:/usr/local:/usr:g" -e "s:/lib:/share/ispell:" \
    local.h.linux > local.h</userinput></screen>

    <para>By default, <application>ispell</application> only installs an American
    English dictionary. To set up other languages, check out the
    <filename>config.X</filename> file for the #define entry to append to
    <filename>local.h</filename>.</para>

    <para>Build <application>ispell</application> using the
    following commands:</para>

<screen><userinput>make</userinput></screen>

    <para>To test the build, issue: <command>make test</command>.</para>

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

<screen><userinput>make install</userinput></screen>

  </sect2>

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

    <para><command>sed -e "s:/usr/local:/usr:g" -e "s:/lib:/share/ispell:"
    local.h.linux > local.h</command>: This command corrects the
    installation directories of the package.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>ispell</seg>
        <seg>None</seg>
        <seg>/usr/share/ispell</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ispell-prog">
        <term><command>ispell</command></term>
        <listitem>
          <para>is used for spell checking.</para>
          <indexterm zone="ispell ispell-prog">
            <primary sortas="b-ispell">ispell</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>