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 enchant-download-http "https://github.com/AbiWord/enchant/releases/download/v&enchant-version;/enchant-&enchant-version;.tar.gz">
|
---|
8 | <!ENTITY enchant-download-ftp " ">
|
---|
9 | <!ENTITY enchant-md5sum "5da2afd6cf92027b4871824d4da4afbf">
|
---|
10 | <!ENTITY enchant-size "5.5 MB">
|
---|
11 | <!ENTITY enchant-buildsize "20 MB (add 63 MB for tests)">
|
---|
12 | <!ENTITY enchant-time "0.1 SBU (add 0.8 SBU for tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="enchant" xreflabel="enchant-&enchant-version;">
|
---|
16 | <?dbhtml filename="enchant.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>enchant-&enchant-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="enchant">
|
---|
22 | <primary sortas="a-enchant">enchant</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to enchant</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>enchant</application> package provides a generic
|
---|
30 | interface into various existing spell checking libraries.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs121_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&enchant-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&enchant-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &enchant-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &enchant-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &enchant-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &enchant-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <bridgehead renderas="sect3">enchant Dependencies</bridgehead>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
72 | <para role="required">
|
---|
73 | <xref linkend="glib2"/> and
|
---|
74 | <xref linkend="vala"/>
|
---|
75 | </para>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
78 | <para role="recommended">
|
---|
79 | <xref linkend="aspell"/>
|
---|
80 | </para>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
83 | <para role="optional">
|
---|
84 | <xref linkend="dbus-glib"/>,
|
---|
85 | <xref linkend="doxygen"/>,
|
---|
86 | <ulink url="http://hspell.ivrix.org.il/">Hspell</ulink>,
|
---|
87 | <ulink url="https://hunspell.github.io/">Hunspell</ulink>,
|
---|
88 | <ulink url="https://nuspell.github.io/">Nuspell</ulink>,
|
---|
89 | <ulink url="https://hunspell.github.io/">Voikko</ulink>, and
|
---|
90 | <ulink url="https://github.com/unittest-cpp/unittest-cpp/releases">
|
---|
91 | unittest-cpp</ulink> (required for tests)
|
---|
92 | </para>
|
---|
93 |
|
---|
94 |
|
---|
95 | </sect2>
|
---|
96 |
|
---|
97 | <sect2 role="installation">
|
---|
98 | <title>Installation of enchant</title>
|
---|
99 |
|
---|
100 | <para>
|
---|
101 | First, remove a generated file that causes the build to fail.
|
---|
102 | The file will be regenerated for the current system.
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <screen><userinput>rm -f src/api.c</userinput></screen>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Install <application>enchant</application> by running the following
|
---|
109 | commands:
|
---|
110 | </para>
|
---|
111 |
|
---|
112 | <screen><userinput>./configure --prefix=/usr \
|
---|
113 | --disable-static \
|
---|
114 | --docdir /usr/share/doc/enchant-&enchant-version; &&
|
---|
115 | make</userinput></screen>
|
---|
116 |
|
---|
117 | <para>
|
---|
118 | To run tests, unittest-cpp must be installed and the
|
---|
119 | <option>--enable-relocatable</option> option passed to configure above.
|
---|
120 | If these conditions are present, the tests may be run with <command>make
|
---|
121 | check</command>.
|
---|
122 | </para>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
129 |
|
---|
130 | </sect2>
|
---|
131 |
|
---|
132 | <sect2 role="commands">
|
---|
133 | <title>Command Explanations</title>
|
---|
134 |
|
---|
135 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
136 | href="../../xincludes/static-libraries.xml"/>
|
---|
137 |
|
---|
138 | </sect2>
|
---|
139 |
|
---|
140 | <sect2 role="configuration">
|
---|
141 | <title>Configuring enchant</title>
|
---|
142 |
|
---|
143 | <sect3 id="enchant-config">
|
---|
144 | <title>Config Files</title>
|
---|
145 | <para>
|
---|
146 | <filename>~/.enchant</filename> and
|
---|
147 | <filename>/usr/share/enchant/enchant.ordering</filename>
|
---|
148 | </para>
|
---|
149 |
|
---|
150 | <indexterm zone="enchant enchant-config">
|
---|
151 | <primary sortas="e-AA.enchant">~/.enchant</primary>
|
---|
152 | </indexterm>
|
---|
153 |
|
---|
154 | <indexterm zone="enchant enchant-config">
|
---|
155 | <primary
|
---|
156 | sortas="e-usr-share-enchant-enchant.ordering">/usr/share/enchant/enchant.ordering</primary>
|
---|
157 | </indexterm>
|
---|
158 | </sect3>
|
---|
159 |
|
---|
160 | <sect3><title>Configuration Information</title>
|
---|
161 | <!--
|
---|
162 | Looks like this is not required when installing enchant in the flavor
|
---|
163 | we do above. Leaving it in source (for a while) in case I'm wrong and
|
---|
164 | it needs to be restored.
|
---|
165 | <para>
|
---|
166 | If you wish to use the <xref linkend="aspell"/> backend, create a
|
---|
167 | symlink, as the <systemitem class="username">root</systemitem> user:
|
---|
168 | </para>
|
---|
169 |
|
---|
170 | <screen role="root"><userinput>ln -svfn ../../lib/aspell /usr/share/enchant/aspell</userinput></screen>
|
---|
171 | -->
|
---|
172 | <para>
|
---|
173 | You can test your installation and configuration by creating a test
|
---|
174 | file and running the following commands (you can replace the
|
---|
175 | en_GB dictionary by any other downloaded when installing <xref
|
---|
176 | linkend="aspell"/>):
|
---|
177 | </para>
|
---|
178 |
|
---|
179 | <screen remap="test"><userinput>cat > /tmp/test-enchant.txt << "EOF"
|
---|
180 | <literal>Tel me more abot linux
|
---|
181 | Ther ar so many commads</literal>
|
---|
182 | EOF
|
---|
183 |
|
---|
184 | enchant-2 -d en_GB -l /tmp/test-enchant.txt &&
|
---|
185 | enchant-2 -d en_GB -a /tmp/test-enchant.txt</userinput></screen>
|
---|
186 |
|
---|
187 | <para>
|
---|
188 | You will see a list of the misspelled words followed by a list of
|
---|
189 | alternatives for them.
|
---|
190 | </para>
|
---|
191 |
|
---|
192 | <para>
|
---|
193 | See more details in the enchant manual page.
|
---|
194 | </para>
|
---|
195 |
|
---|
196 | </sect3>
|
---|
197 |
|
---|
198 | </sect2>
|
---|
199 |
|
---|
200 | <sect2 role="content">
|
---|
201 | <title>Contents</title>
|
---|
202 |
|
---|
203 | <segmentedlist>
|
---|
204 | <segtitle>Installed Programs</segtitle>
|
---|
205 | <segtitle>Installed Libraries</segtitle>
|
---|
206 | <segtitle>Installed Directories</segtitle>
|
---|
207 |
|
---|
208 | <seglistitem>
|
---|
209 | <seg>enchant-2 and enchant-lsmod-2</seg>
|
---|
210 | <seg>libenchant-2.so</seg>
|
---|
211 | <seg>/usr/include/enchant-2, /usr/lib/enchant-2,
|
---|
212 | /usr/share/enchant, and /usr/share/doc/enchant-&enchant-version;</seg>
|
---|
213 | </seglistitem>
|
---|
214 | </segmentedlist>
|
---|
215 |
|
---|
216 | <variablelist>
|
---|
217 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
218 | <?dbfo list-presentation="list"?>
|
---|
219 | <?dbhtml list-presentation="table"?>
|
---|
220 |
|
---|
221 | <varlistentry id="enchant-2">
|
---|
222 | <term><command>enchant-2</command></term>
|
---|
223 | <listitem>
|
---|
224 | <para>
|
---|
225 | is a spellchecker
|
---|
226 | </para>
|
---|
227 | <indexterm zone="enchant enchant-2">
|
---|
228 | <primary sortas="b-enchant-2">enchant-2</primary>
|
---|
229 | </indexterm>
|
---|
230 | </listitem>
|
---|
231 | </varlistentry>
|
---|
232 |
|
---|
233 | <varlistentry id="enchant-lsmod-2">
|
---|
234 | <term><command>enchant-lsmod-2</command></term>
|
---|
235 | <listitem>
|
---|
236 | <para>
|
---|
237 | lists available backends, languages, and dictionaries
|
---|
238 | </para>
|
---|
239 | <indexterm zone="enchant enchant-lsmod-2">
|
---|
240 | <primary sortas="b-enchant-lsmod-2">enchant-lsmod-2</primary>
|
---|
241 | </indexterm>
|
---|
242 | </listitem>
|
---|
243 | </varlistentry>
|
---|
244 |
|
---|
245 | <varlistentry id="libenchant-2">
|
---|
246 | <term><filename class="libraryfile">libenchant-2.so</filename></term>
|
---|
247 | <listitem>
|
---|
248 | <para>
|
---|
249 | contains spell checking interface API functions
|
---|
250 | </para>
|
---|
251 | <indexterm zone="enchant libenchant-2">
|
---|
252 | <primary sortas="c-libenchant-2">libenchant-2.so</primary>
|
---|
253 | </indexterm>
|
---|
254 | </listitem>
|
---|
255 | </varlistentry>
|
---|
256 |
|
---|
257 | </variablelist>
|
---|
258 |
|
---|
259 | </sect2>
|
---|
260 |
|
---|
261 | </sect1>
|
---|