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