source: general/genlib/enchant.xml@ 45ab6c7

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 22 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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