| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY aspell-download-http "http://ftp.gnu.org/gnu/aspell/aspell-&aspell-version;.tar.gz">
|
|---|
| 8 | <!ENTITY aspell-download-ftp "ftp://ftp.gnu.org/gnu/aspell/aspell-&aspell-version;.tar.gz">
|
|---|
| 9 | <!ENTITY aspell-md5sum "17fd8acac6293336bcef44391b71e337">
|
|---|
| 10 | <!ENTITY aspell-size "1.7 MB">
|
|---|
| 11 | <!ENTITY aspell-buildsize "40 MB (Additional 8 MB for EN dictionary)">
|
|---|
| 12 | <!ENTITY aspell-time "0.7 SBU">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="aspell" xreflabel="Aspell-&aspell-version;">
|
|---|
| 16 | <?dbhtml filename="aspell.html"?>
|
|---|
| 17 |
|
|---|
| 18 | <sect1info>
|
|---|
| 19 | <othername>$LastChangedBy$</othername>
|
|---|
| 20 | <date>$Date$</date>
|
|---|
| 21 | </sect1info>
|
|---|
| 22 |
|
|---|
| 23 | <title>Aspell-&aspell-version;</title>
|
|---|
| 24 |
|
|---|
| 25 | <indexterm zone="aspell">
|
|---|
| 26 | <primary sortas="a-Aspell">Aspell</primary>
|
|---|
| 27 | </indexterm>
|
|---|
| 28 |
|
|---|
| 29 | <sect2 role="package">
|
|---|
| 30 | <title>Introduction to Aspell</title>
|
|---|
| 31 |
|
|---|
| 32 | <para>The <application>Aspell</application> package contains an interactive
|
|---|
| 33 | spell checking program and the <application>Aspell</application> libraries.
|
|---|
| 34 | <application>Aspell</application> can either be used as a library or as an
|
|---|
| 35 | independent spell checker.</para>
|
|---|
| 36 |
|
|---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 38 | <itemizedlist spacing="compact">
|
|---|
| 39 | <listitem>
|
|---|
| 40 | <para>Download (HTTP): <ulink url="&aspell-download-http;"/></para>
|
|---|
| 41 | </listitem>
|
|---|
| 42 | <listitem>
|
|---|
| 43 | <para>Download (FTP): <ulink url="&aspell-download-ftp;"/></para>
|
|---|
| 44 | </listitem>
|
|---|
| 45 | <listitem>
|
|---|
| 46 | <para>Download MD5 sum: &aspell-md5sum;</para>
|
|---|
| 47 | </listitem>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>Download size: &aspell-size;</para>
|
|---|
| 50 | </listitem>
|
|---|
| 51 | <listitem>
|
|---|
| 52 | <para>Estimated disk space required: &aspell-buildsize;</para>
|
|---|
| 53 | </listitem>
|
|---|
| 54 | <listitem>
|
|---|
| 55 | <para>Estimated build time: &aspell-time;</para>
|
|---|
| 56 | </listitem>
|
|---|
| 57 | </itemizedlist>
|
|---|
| 58 |
|
|---|
| 59 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|---|
| 60 | <para>You'll need to download at least one dictionary. The link below will take
|
|---|
| 61 | you to a page containing links to dictionaries in many languages.</para>
|
|---|
| 62 |
|
|---|
| 63 | <itemizedlist spacing='compact'>
|
|---|
| 64 | <listitem>
|
|---|
| 65 | <para>Aspell dictionaries: <ulink
|
|---|
| 66 | url="ftp://ftp.gnu.org/gnu/aspell/dict"/></para>
|
|---|
| 67 | </listitem>
|
|---|
| 68 | </itemizedlist>
|
|---|
| 69 |
|
|---|
| 70 | <bridgehead renderas="sect3">Aspell Dependencies</bridgehead>
|
|---|
| 71 |
|
|---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 73 | <para role="required"><xref linkend="which"/></para>
|
|---|
| 74 |
|
|---|
| 75 | <!-- <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 76 | <para role="optional"><xref linkend="tetex"/></para> -->
|
|---|
| 77 |
|
|---|
| 78 | <para condition="html" role="usernotes">User Notes:
|
|---|
| 79 | <ulink url="&blfs-wiki;/aspell"/></para>
|
|---|
| 80 |
|
|---|
| 81 | </sect2>
|
|---|
| 82 |
|
|---|
| 83 | <sect2 role="installation">
|
|---|
| 84 | <title>Installation of Aspell</title>
|
|---|
| 85 |
|
|---|
| 86 | <para>Install <application>Aspell</application> by running the following
|
|---|
| 87 | commands:</para>
|
|---|
| 88 |
|
|---|
| 89 | <screen><userinput>./configure --prefix=/usr &&
|
|---|
| 90 | make</userinput></screen>
|
|---|
| 91 |
|
|---|
| 92 | <!-- <para>Pre-built HTML documentation is included in the package. If you have
|
|---|
| 93 | <application>teTeX</application> installed and you wish to build additional
|
|---|
| 94 | formats of the documentation, issue any or all of the following
|
|---|
| 95 | commands:</para>
|
|---|
| 96 |
|
|---|
| 97 | <screen><userinput>make -C manual pdf &&
|
|---|
| 98 | make -C manual pdf &&
|
|---|
| 99 | make -C manual ps &&
|
|---|
| 100 | cd manual &&
|
|---|
| 101 | makeinfo -plaintext -o aspell.txt aspell.texi &&
|
|---|
| 102 | makeinfo -plaintext -o aspell-dev.txt aspell-dev.texi &&
|
|---|
| 103 | cd ..</userinput></screen> -->
|
|---|
| 104 |
|
|---|
| 105 | <para>This package does not come with a test suite.</para>
|
|---|
| 106 |
|
|---|
| 107 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 108 |
|
|---|
| 109 | <screen role="root"><userinput>make install &&
|
|---|
| 110 | install -v -m755 -d /usr/share/doc/aspell-&aspell-version;/aspell{,-dev}.html &&
|
|---|
| 111 | install -v -m644 manual/aspell.html/* \
|
|---|
| 112 | /usr/share/doc/aspell-&aspell-version;/aspell.html &&
|
|---|
| 113 | install -v -m644 manual/aspell-dev.html/* \
|
|---|
| 114 | /usr/share/doc/aspell-&aspell-version;/aspell-dev.html</userinput></screen>
|
|---|
| 115 |
|
|---|
| 116 | <!-- <para>If you built additional formats of the documentation, install them
|
|---|
| 117 | by issuing the following command as the
|
|---|
| 118 | <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 119 |
|
|---|
| 120 | <screen role="root"><userinput>install -v -m644 manual/aspell{,-dev}.{ps,pdf,dvi,txt} \
|
|---|
| 121 | /usr/share/doc/aspell-&aspell-version;</userinput></screen> -->
|
|---|
| 122 |
|
|---|
| 123 | <para>If you do not plan to install <application>Ispell</application>,
|
|---|
| 124 | then copy the wrapper script <command>ispell</command>:</para>
|
|---|
| 125 |
|
|---|
| 126 | <screen role="root"><userinput>install -v -m 755 scripts/ispell /usr/bin/</userinput></screen>
|
|---|
| 127 |
|
|---|
| 128 | <para>If you do not plan to install <application>Spell</application>,
|
|---|
| 129 | then copy the wrapper script <command>spell</command>:</para>
|
|---|
| 130 |
|
|---|
| 131 | <screen role="root"><userinput>install -v -m 755 scripts/spell /usr/bin/</userinput></screen>
|
|---|
| 132 |
|
|---|
| 133 | </sect2>
|
|---|
| 134 |
|
|---|
| 135 | <!-- <sect2 role="commands">
|
|---|
| 136 | <title>Command Explanations</title>
|
|---|
| 137 |
|
|---|
| 138 | <para><command>make -C manual pdf</command>: This command is listed twice
|
|---|
| 139 | as the first time it runs it will display an error and abort, although it
|
|---|
| 140 | creates the requested file. Running the command again ensures the other
|
|---|
| 141 | file is also created.</para>
|
|---|
| 142 |
|
|---|
| 143 | </sect2> -->
|
|---|
| 144 |
|
|---|
| 145 | <sect2 role="configuration">
|
|---|
| 146 | <title>Configuring Aspell</title>
|
|---|
| 147 |
|
|---|
| 148 | <sect3>
|
|---|
| 149 | <title>Configuration Information</title>
|
|---|
| 150 |
|
|---|
| 151 | <para>After <application>Aspell</application> is installed, you must set
|
|---|
| 152 | up at least one dictionary. Install one or more dictionaries by running
|
|---|
| 153 | the following commands:</para>
|
|---|
| 154 |
|
|---|
| 155 | <screen><userinput>./configure &&
|
|---|
| 156 | make</userinput></screen>
|
|---|
| 157 |
|
|---|
| 158 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 159 |
|
|---|
| 160 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 161 |
|
|---|
| 162 | </sect3>
|
|---|
| 163 |
|
|---|
| 164 | </sect2>
|
|---|
| 165 |
|
|---|
| 166 | <sect2 role="content">
|
|---|
| 167 | <title>Contents</title>
|
|---|
| 168 |
|
|---|
| 169 | <segmentedlist>
|
|---|
| 170 | <segtitle>Installed Programs</segtitle>
|
|---|
| 171 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 172 | <segtitle>Installed Directories</segtitle>
|
|---|
| 173 |
|
|---|
| 174 | <seglistitem>
|
|---|
| 175 | <seg>aspell, aspell-import, precat, preunzip, prezip, prezip-bin,
|
|---|
| 176 | pspell-config, run-with-aspell, word-list-compress and optionally,
|
|---|
| 177 | ispell and spell</seg>
|
|---|
| 178 | <seg>libaspell.so and libpspell.so</seg>
|
|---|
| 179 | <seg>/usr/include/pspell and /usr/lib/aspell-0.60</seg>
|
|---|
| 180 | </seglistitem>
|
|---|
| 181 | </segmentedlist>
|
|---|
| 182 |
|
|---|
| 183 | <variablelist>
|
|---|
| 184 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 185 | <?dbfo list-presentation="list"?>
|
|---|
| 186 | <?dbhtml list-presentation="table"?>
|
|---|
| 187 |
|
|---|
| 188 | <varlistentry id="aspell-prog">
|
|---|
| 189 | <term><command>aspell</command></term>
|
|---|
| 190 | <listitem>
|
|---|
| 191 | <para>is a utility that can function as an
|
|---|
| 192 | <command>ispell -a</command> replacement, as an independent spell
|
|---|
| 193 | checker, as a test utility to test out
|
|---|
| 194 | <application>Aspell</application> features, and as
|
|---|
| 195 | a utility for managing dictionaries.</para>
|
|---|
| 196 | <indexterm zone="aspell aspell-prog">
|
|---|
| 197 | <primary sortas="b-aspell">aspell</primary>
|
|---|
| 198 | </indexterm>
|
|---|
| 199 | </listitem>
|
|---|
| 200 | </varlistentry>
|
|---|
| 201 |
|
|---|
| 202 | <varlistentry id="aspell-ispell">
|
|---|
| 203 | <term><command>ispell</command></term>
|
|---|
| 204 | <listitem>
|
|---|
| 205 | <para>is a wrapper around <command>aspell</command> to invoke it in
|
|---|
| 206 | <command>ispell</command> compatible mode.</para>
|
|---|
| 207 | <indexterm zone="aspell aspell-ispell">
|
|---|
| 208 | <primary sortas="b-ispell">ispell</primary>
|
|---|
| 209 | </indexterm>
|
|---|
| 210 | </listitem>
|
|---|
| 211 | </varlistentry>
|
|---|
| 212 |
|
|---|
| 213 | <varlistentry id="aspell-spell">
|
|---|
| 214 | <term><command>spell</command></term>
|
|---|
| 215 | <listitem>
|
|---|
| 216 | <para>is a wrapper around <command>aspell</command> to invoke it in
|
|---|
| 217 | <command>spell</command> compatible mode.</para>
|
|---|
| 218 | <indexterm zone="aspell aspell-spell">
|
|---|
| 219 | <primary sortas="b-spell">spell</primary>
|
|---|
| 220 | </indexterm>
|
|---|
| 221 | </listitem>
|
|---|
| 222 | </varlistentry>
|
|---|
| 223 |
|
|---|
| 224 | <varlistentry id="aspell-import">
|
|---|
| 225 | <term><command>aspell-import</command></term>
|
|---|
| 226 | <listitem>
|
|---|
| 227 | <para>imports old personal dictionaries into
|
|---|
| 228 | <application>Aspell</application>.</para>
|
|---|
| 229 | <indexterm zone="aspell aspell-import">
|
|---|
| 230 | <primary sortas="b-aspell-import">aspell-import</primary>
|
|---|
| 231 | </indexterm>
|
|---|
| 232 | </listitem>
|
|---|
| 233 | </varlistentry>
|
|---|
| 234 |
|
|---|
| 235 | <varlistentry id="precat">
|
|---|
| 236 | <term><command>precat</command></term>
|
|---|
| 237 | <listitem>
|
|---|
| 238 | <para>decompresses a <command>prezip</command>ped file to
|
|---|
| 239 | stdout.</para>
|
|---|
| 240 | <indexterm zone="aspell precat">
|
|---|
| 241 | <primary sortas="b-precat">precat</primary>
|
|---|
| 242 | </indexterm>
|
|---|
| 243 | </listitem>
|
|---|
| 244 | </varlistentry>
|
|---|
| 245 |
|
|---|
| 246 | <varlistentry id="preunzip">
|
|---|
| 247 | <term><command>preunzip</command></term>
|
|---|
| 248 | <listitem>
|
|---|
| 249 | <para>decompresses a <command>prezip</command>ped file.</para>
|
|---|
| 250 | <indexterm zone="aspell preunzip">
|
|---|
| 251 | <primary sortas="b-preunzip">preunzip</primary>
|
|---|
| 252 | </indexterm>
|
|---|
| 253 | </listitem>
|
|---|
| 254 | </varlistentry>
|
|---|
| 255 |
|
|---|
| 256 | <varlistentry id="prezip">
|
|---|
| 257 | <term><command>prezip</command></term>
|
|---|
| 258 | <listitem>
|
|---|
| 259 | <para>is a prefix delta compressor, used to compress sorted word
|
|---|
| 260 | lists or other similar text files.</para>
|
|---|
| 261 | <indexterm zone="aspell prezip">
|
|---|
| 262 | <primary sortas="b-prezip">prezip</primary>
|
|---|
| 263 | </indexterm>
|
|---|
| 264 | </listitem>
|
|---|
| 265 | </varlistentry>
|
|---|
| 266 |
|
|---|
| 267 | <varlistentry id="prezip-bin">
|
|---|
| 268 | <term><command>prezip-bin</command></term>
|
|---|
| 269 | <listitem>
|
|---|
| 270 | <para>is called by the various wrapper scripts to perform the
|
|---|
| 271 | actual compressing and decompressing.</para>
|
|---|
| 272 | <indexterm zone="aspell prezip-bin">
|
|---|
| 273 | <primary sortas="b-prezip-bin">prezip-bin</primary>
|
|---|
| 274 | </indexterm>
|
|---|
| 275 | </listitem>
|
|---|
| 276 | </varlistentry>
|
|---|
| 277 |
|
|---|
| 278 | <varlistentry id="pspell-config">
|
|---|
| 279 | <term><command>pspell-config</command></term>
|
|---|
| 280 | <listitem>
|
|---|
| 281 | <para>displays information about the
|
|---|
| 282 | <filename class='libraryfile'>libpspell</filename> installation,
|
|---|
| 283 | mostly for use in build scripts.</para>
|
|---|
| 284 | <indexterm zone="aspell pspell-config">
|
|---|
| 285 | <primary sortas="b-pspell-config">pspell-config</primary>
|
|---|
| 286 | </indexterm>
|
|---|
| 287 | </listitem>
|
|---|
| 288 | </varlistentry>
|
|---|
| 289 |
|
|---|
| 290 | <varlistentry id="run-with-aspell">
|
|---|
| 291 | <term><command>run-with-aspell</command></term>
|
|---|
| 292 | <listitem>
|
|---|
| 293 | <para>is a script to help use <application>Aspell</application>
|
|---|
| 294 | as an <command>ispell</command> replacement.</para>
|
|---|
| 295 | <indexterm zone="aspell run-with-aspell">
|
|---|
| 296 | <primary sortas="b-run-with-aspell">run-with-aspell</primary>
|
|---|
| 297 | </indexterm>
|
|---|
| 298 | </listitem>
|
|---|
| 299 | </varlistentry>
|
|---|
| 300 |
|
|---|
| 301 | <varlistentry id="word-list-compress">
|
|---|
| 302 | <term><command>word-list-compress</command></term>
|
|---|
| 303 | <listitem>
|
|---|
| 304 | <para>compresses or decompresses sorted word lists for use with the
|
|---|
| 305 | <application>Aspell</application> spell checker.</para>
|
|---|
| 306 | <indexterm zone="aspell word-list-compress">
|
|---|
| 307 | <primary sortas="b-word-list-compress">word-list-compress</primary>
|
|---|
| 308 | </indexterm>
|
|---|
| 309 | </listitem>
|
|---|
| 310 | </varlistentry>
|
|---|
| 311 |
|
|---|
| 312 | <varlistentry id="libaspell">
|
|---|
| 313 | <term><filename class='libraryfile'>libaspell.so</filename></term>
|
|---|
| 314 | <listitem>
|
|---|
| 315 | <para>contains spell checking API functions.</para>
|
|---|
| 316 | <indexterm zone="aspell libaspell">
|
|---|
| 317 | <primary sortas="c-lib">libaspell.so</primary>
|
|---|
| 318 | </indexterm>
|
|---|
| 319 | </listitem>
|
|---|
| 320 | </varlistentry>
|
|---|
| 321 |
|
|---|
| 322 | <varlistentry id="libpspell">
|
|---|
| 323 | <term><filename class='libraryfile'>libpspell.so</filename></term>
|
|---|
| 324 | <listitem>
|
|---|
| 325 | <para>is an interface to the
|
|---|
| 326 | <filename class='libraryfile'>libaspell</filename> library. All the
|
|---|
| 327 | spell checking functionality is now in
|
|---|
| 328 | <filename class='libraryfile'>libaspell</filename> but this library
|
|---|
| 329 | is included for backward compatibility.</para>
|
|---|
| 330 | <indexterm zone="aspell libpspell">
|
|---|
| 331 | <primary sortas="c-libpspell">libpspell.so</primary>
|
|---|
| 332 | </indexterm>
|
|---|
| 333 | </listitem>
|
|---|
| 334 | </varlistentry>
|
|---|
| 335 |
|
|---|
| 336 | </variablelist>
|
|---|
| 337 |
|
|---|
| 338 | </sect2>
|
|---|
| 339 |
|
|---|
| 340 | </sect1>
|
|---|
