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