source: general/genlib/aspell.xml@ 31973174

systemd-13485
Last change on this file since 31973174 was 83f6c770, checked in by DJ Lucas <dj@…>, 8 years ago

Merge Chapter 9 changes from trunk.

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