[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 |
|
---|
[fa36572] | 41 | &lfs76_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 | This package does not come with a test suite.
|
---|
| 116 | </para>
|
---|
[28bfba0] | 117 |
|
---|
[9e7fa16] | 118 | <para>
|
---|
| 119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 120 | </para>
|
---|
[4e82a189] | 121 |
|
---|
[28bfba0] | 122 | <screen role="root"><userinput>make install &&
|
---|
| 123 | install -v -m755 -d /usr/share/doc/aspell-&aspell-version;/aspell{,-dev}.html &&
|
---|
[34fb49a7] | 124 |
|
---|
[28bfba0] | 125 | install -v -m644 manual/aspell.html/* \
|
---|
| 126 | /usr/share/doc/aspell-&aspell-version;/aspell.html &&
|
---|
[34fb49a7] | 127 |
|
---|
[28bfba0] | 128 | install -v -m644 manual/aspell-dev.html/* \
|
---|
| 129 | /usr/share/doc/aspell-&aspell-version;/aspell-dev.html</userinput></screen>
|
---|
| 130 |
|
---|
[9e7fa16] | 131 | <para>
|
---|
| 132 | If you do not plan to install <application>Ispell</application>, then copy
|
---|
| 133 | the wrapper script <command>ispell</command>:
|
---|
| 134 | </para>
|
---|
[f14dde87] | 135 |
|
---|
[60b430f] | 136 | <screen role="root"><userinput>install -v -m 755 scripts/ispell /usr/bin/</userinput></screen>
|
---|
[f14dde87] | 137 |
|
---|
[9e7fa16] | 138 | <para>
|
---|
| 139 | If you do not plan to install <application>Spell</application>, then copy
|
---|
| 140 | the wrapper script <command>spell</command>:
|
---|
| 141 | </para>
|
---|
[f14dde87] | 142 |
|
---|
[60b430f] | 143 | <screen role="root"><userinput>install -v -m 755 scripts/spell /usr/bin/</userinput></screen>
|
---|
[28bfba0] | 144 | </sect2>
|
---|
| 145 |
|
---|
[615db3f] | 146 | <!-- <sect2 role="commands">
|
---|
[28bfba0] | 147 | <title>Command Explanations</title>
|
---|
[6473e74] | 148 |
|
---|
[9e7fa16] | 149 | <para>
|
---|
| 150 | <command>make -C manual pdf</command>: This command is listed twice as the
|
---|
| 151 | first time it runs it will display an error and abort, although it creates
|
---|
| 152 | the requested file. Running the command again ensures the other file is
|
---|
| 153 | also created.
|
---|
| 154 | </para>
|
---|
[615db3f] | 155 | </sect2> -->
|
---|
[b280fcc] | 156 |
|
---|
| 157 | <sect2 role="configuration">
|
---|
| 158 | <title>Configuring Aspell</title>
|
---|
[4e82a189] | 159 |
|
---|
[b280fcc] | 160 | <sect3>
|
---|
| 161 | <title>Configuration Information</title>
|
---|
[4e82a189] | 162 |
|
---|
[9e7fa16] | 163 | <para>
|
---|
| 164 | After <application>Aspell</application> is installed, you must set up at
|
---|
| 165 | least one dictionary. Install one or more dictionaries by running the
|
---|
| 166 | following commands:
|
---|
| 167 | </para>
|
---|
[4e82a189] | 168 |
|
---|
[b280fcc] | 169 | <screen><userinput>./configure &&
|
---|
| 170 | make</userinput></screen>
|
---|
[4e82a189] | 171 |
|
---|
[9e7fa16] | 172 | <para>
|
---|
| 173 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 174 | </para>
|
---|
[4e82a189] | 175 |
|
---|
[b280fcc] | 176 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 177 | </sect3>
|
---|
| 178 | </sect2>
|
---|
[4e82a189] | 179 |
|
---|
[b280fcc] | 180 | <sect2 role="content">
|
---|
| 181 | <title>Contents</title>
|
---|
| 182 |
|
---|
| 183 | <segmentedlist>
|
---|
| 184 | <segtitle>Installed Programs</segtitle>
|
---|
| 185 | <segtitle>Installed Libraries</segtitle>
|
---|
| 186 | <segtitle>Installed Directories</segtitle>
|
---|
[4e82a189] | 187 |
|
---|
[b280fcc] | 188 | <seglistitem>
|
---|
[9e7fa16] | 189 | <seg>
|
---|
| 190 | aspell, aspell-import, precat, preunzip, prezip, prezip-bin,
|
---|
| 191 | pspell-config, run-with-aspell, word-list-compress and optionally,
|
---|
| 192 | ispell and spell.
|
---|
| 193 | </seg>
|
---|
[b280fcc] | 194 | <seg>libaspell.so and libpspell.so</seg>
|
---|
| 195 | <seg>/usr/include/pspell and /usr/lib/aspell-0.60</seg>
|
---|
| 196 | </seglistitem>
|
---|
| 197 | </segmentedlist>
|
---|
[4e82a189] | 198 |
|
---|
[b280fcc] | 199 | <variablelist>
|
---|
| 200 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 201 | <?dbfo list-presentation="list"?>
|
---|
| 202 | <?dbhtml list-presentation="table"?>
|
---|
[4e82a189] | 203 |
|
---|
[b280fcc] | 204 | <varlistentry id="aspell-prog">
|
---|
| 205 | <term><command>aspell</command></term>
|
---|
| 206 | <listitem>
|
---|
[9e7fa16] | 207 | <para>
|
---|
| 208 | is a utility that can function as an <command>ispell -a</command>
|
---|
| 209 | replacement, as an independent spell checker, as a test utility to
|
---|
| 210 | test out <application>Aspell</application> features, and as a
|
---|
| 211 | utility for managing dictionaries.
|
---|
| 212 | </para>
|
---|
[b280fcc] | 213 | <indexterm zone="aspell aspell-prog">
|
---|
| 214 | <primary sortas="b-aspell">aspell</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
[4e82a189] | 218 |
|
---|
[0e726f8] | 219 | <varlistentry id="aspell-ispell">
|
---|
| 220 | <term><command>ispell</command></term>
|
---|
| 221 | <listitem>
|
---|
[9e7fa16] | 222 | <para>
|
---|
| 223 | is a wrapper around <command>aspell</command> to invoke it in
|
---|
| 224 | <command>ispell</command> compatible mode.
|
---|
| 225 | </para>
|
---|
[0e726f8] | 226 | <indexterm zone="aspell aspell-ispell">
|
---|
| 227 | <primary sortas="b-ispell">ispell</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | <varlistentry id="aspell-spell">
|
---|
| 233 | <term><command>spell</command></term>
|
---|
| 234 | <listitem>
|
---|
[9e7fa16] | 235 | <para>
|
---|
| 236 | is a wrapper around <command>aspell</command> to invoke it in
|
---|
| 237 | <command>spell</command> compatible mode.
|
---|
| 238 | </para>
|
---|
[0e726f8] | 239 | <indexterm zone="aspell aspell-spell">
|
---|
| 240 | <primary sortas="b-spell">spell</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
[b280fcc] | 245 | <varlistentry id="aspell-import">
|
---|
| 246 | <term><command>aspell-import</command></term>
|
---|
| 247 | <listitem>
|
---|
[9e7fa16] | 248 | <para>
|
---|
| 249 | imports old personal dictionaries into
|
---|
| 250 | <application>Aspell</application>.
|
---|
| 251 | </para>
|
---|
[b280fcc] | 252 | <indexterm zone="aspell aspell-import">
|
---|
| 253 | <primary sortas="b-aspell-import">aspell-import</primary>
|
---|
| 254 | </indexterm>
|
---|
| 255 | </listitem>
|
---|
| 256 | </varlistentry>
|
---|
[4e82a189] | 257 |
|
---|
[b280fcc] | 258 | <varlistentry id="precat">
|
---|
| 259 | <term><command>precat</command></term>
|
---|
| 260 | <listitem>
|
---|
[9e7fa16] | 261 | <para>
|
---|
| 262 | decompresses a <command>prezip</command>ped file to stdout.
|
---|
| 263 | </para>
|
---|
[b280fcc] | 264 | <indexterm zone="aspell precat">
|
---|
| 265 | <primary sortas="b-precat">precat</primary>
|
---|
| 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
[4e82a189] | 269 |
|
---|
[b280fcc] | 270 | <varlistentry id="preunzip">
|
---|
| 271 | <term><command>preunzip</command></term>
|
---|
| 272 | <listitem>
|
---|
[9e7fa16] | 273 | <para>
|
---|
| 274 | decompresses a <command>prezip</command>ped file.
|
---|
| 275 | </para>
|
---|
[b280fcc] | 276 | <indexterm zone="aspell preunzip">
|
---|
| 277 | <primary sortas="b-preunzip">preunzip</primary>
|
---|
| 278 | </indexterm>
|
---|
| 279 | </listitem>
|
---|
| 280 | </varlistentry>
|
---|
[4e82a189] | 281 |
|
---|
[b280fcc] | 282 | <varlistentry id="prezip">
|
---|
| 283 | <term><command>prezip</command></term>
|
---|
| 284 | <listitem>
|
---|
[9e7fa16] | 285 | <para>
|
---|
| 286 | is a prefix delta compressor, used to compress sorted word lists or
|
---|
| 287 | other similar text files.
|
---|
| 288 | </para>
|
---|
[b280fcc] | 289 | <indexterm zone="aspell prezip">
|
---|
| 290 | <primary sortas="b-prezip">prezip</primary>
|
---|
| 291 | </indexterm>
|
---|
| 292 | </listitem>
|
---|
| 293 | </varlistentry>
|
---|
[4e82a189] | 294 |
|
---|
[b280fcc] | 295 | <varlistentry id="prezip-bin">
|
---|
| 296 | <term><command>prezip-bin</command></term>
|
---|
| 297 | <listitem>
|
---|
[9e7fa16] | 298 | <para>
|
---|
| 299 | is called by the various wrapper scripts to perform the actual
|
---|
| 300 | compressing and decompressing.
|
---|
| 301 | </para>
|
---|
[b280fcc] | 302 | <indexterm zone="aspell prezip-bin">
|
---|
| 303 | <primary sortas="b-prezip-bin">prezip-bin</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
[4e82a189] | 307 |
|
---|
[b280fcc] | 308 | <varlistentry id="pspell-config">
|
---|
| 309 | <term><command>pspell-config</command></term>
|
---|
| 310 | <listitem>
|
---|
[9e7fa16] | 311 | <para>
|
---|
| 312 | displays information about the
|
---|
| 313 | <filename class="libraryfile">libpspell</filename> installation,
|
---|
| 314 | mostly for use in build scripts.
|
---|
| 315 | </para>
|
---|
[b280fcc] | 316 | <indexterm zone="aspell pspell-config">
|
---|
| 317 | <primary sortas="b-pspell-config">pspell-config</primary>
|
---|
| 318 | </indexterm>
|
---|
| 319 | </listitem>
|
---|
| 320 | </varlistentry>
|
---|
[4e82a189] | 321 |
|
---|
[b280fcc] | 322 | <varlistentry id="run-with-aspell">
|
---|
| 323 | <term><command>run-with-aspell</command></term>
|
---|
| 324 | <listitem>
|
---|
[9e7fa16] | 325 | <para>
|
---|
| 326 | is a script to help use <application>Aspell</application> as an
|
---|
| 327 | <command>ispell</command> replacement.
|
---|
| 328 | </para>
|
---|
[b280fcc] | 329 | <indexterm zone="aspell run-with-aspell">
|
---|
| 330 | <primary sortas="b-run-with-aspell">run-with-aspell</primary>
|
---|
| 331 | </indexterm>
|
---|
| 332 | </listitem>
|
---|
| 333 | </varlistentry>
|
---|
[4e82a189] | 334 |
|
---|
[b280fcc] | 335 | <varlistentry id="word-list-compress">
|
---|
| 336 | <term><command>word-list-compress</command></term>
|
---|
| 337 | <listitem>
|
---|
[9e7fa16] | 338 | <para>
|
---|
| 339 | compresses or decompresses sorted word lists for use with the
|
---|
| 340 | <application>Aspell</application> spell checker.
|
---|
| 341 | </para>
|
---|
[b280fcc] | 342 | <indexterm zone="aspell word-list-compress">
|
---|
| 343 | <primary sortas="b-word-list-compress">word-list-compress</primary>
|
---|
| 344 | </indexterm>
|
---|
| 345 | </listitem>
|
---|
| 346 | </varlistentry>
|
---|
[4e82a189] | 347 |
|
---|
[b280fcc] | 348 | <varlistentry id="libaspell">
|
---|
[9e7fa16] | 349 | <term><filename class="libraryfile">libaspell.so</filename></term>
|
---|
[b280fcc] | 350 | <listitem>
|
---|
[9e7fa16] | 351 | <para>
|
---|
| 352 | contains spell checking API functions.
|
---|
| 353 | </para>
|
---|
[b280fcc] | 354 | <indexterm zone="aspell libaspell">
|
---|
[e2abad8e] | 355 | <primary sortas="c-libaspell">libaspell.so</primary>
|
---|
[b280fcc] | 356 | </indexterm>
|
---|
| 357 | </listitem>
|
---|
| 358 | </varlistentry>
|
---|
[4e82a189] | 359 |
|
---|
[b280fcc] | 360 | <varlistentry id="libpspell">
|
---|
[9e7fa16] | 361 | <term><filename class="libraryfile">libpspell.so</filename></term>
|
---|
[b280fcc] | 362 | <listitem>
|
---|
[9e7fa16] | 363 | <para>
|
---|
| 364 | is an interface to the
|
---|
| 365 | <filename class="libraryfile">libaspell</filename> library. All the
|
---|
| 366 | spell checking functionality is now in
|
---|
| 367 | <filename class="libraryfile">libaspell</filename> but this library
|
---|
| 368 | is included for backward compatibility.
|
---|
| 369 | </para>
|
---|
[b280fcc] | 370 | <indexterm zone="aspell libpspell">
|
---|
| 371 | <primary sortas="c-libpspell">libpspell.so</primary>
|
---|
| 372 | </indexterm>
|
---|
| 373 | </listitem>
|
---|
| 374 | </varlistentry>
|
---|
| 375 | </variablelist>
|
---|
| 376 | </sect2>
|
---|
[368512b3] | 377 | </sect1>
|
---|