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