source: general/genlib/aspell.xml@ 8aeb474

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 8aeb474 was 8aeb474, checked in by Bruce Dubbs <bdubbs@…>, 12 years ago

General cleanup. Mostly removing obsolete comments.

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