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