source: general/genlib/enchant.xml@ e6f368f

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 e6f368f was e6f368f, checked in by Xi Ruoyao <xry111@…>, 21 months ago

enchant: remove compatibilty symlinks

They are added 3 years ago and it's highly likely that they are not
needed anymore. If there is any issue we may revert this, or patch the
downstream instead.

  • Property mode set to 100644
File size: 7.6 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</userinput></screen>
124
125 </sect2>
126
127 <sect2 role="commands">
128 <title>Command Explanations</title>
129
130 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
131 href="../../xincludes/static-libraries.xml"/>
132
133 </sect2>
134
135 <sect2 role="configuration">
136 <title>Configuring enchant</title>
137
138 <sect3 id="enchant-config">
139 <title>Config Files</title>
140 <para>
141 <filename>~/.enchant</filename> and
142 <filename>/usr/share/enchant/enchant.ordering</filename>
143 </para>
144
145 <indexterm zone="enchant enchant-config">
146 <primary sortas="e-AA.enchant">~/.enchant</primary>
147 </indexterm>
148
149 <indexterm zone="enchant enchant-config">
150 <primary
151 sortas="e-usr-share-enchant-enchant.ordering">/usr/share/enchant/enchant.ordering</primary>
152 </indexterm>
153 </sect3>
154
155 <sect3><title>Configuration Information</title>
156<!--
157 Looks like this is not required when installing enchant in the flavor
158 we do above. Leaving it in source (for a while) in case I'm wrong and
159 it needs to be restored.
160 <para>
161 If you wish to use the <xref linkend="aspell"/> backend, create a
162 symlink, as the <systemitem class="username">root</systemitem> user:
163 </para>
164
165<screen role="root"><userinput>ln -svfn ../../lib/aspell /usr/share/enchant/aspell</userinput></screen>
166-->
167 <para>
168 You can test your installation and configuration by creating a test
169 file and running the following commands (you can replace the
170 en_GB dictionary by any other downloaded when installing <xref
171 linkend="aspell"/>):
172 </para>
173
174<screen remap="test"><userinput>cat &gt; /tmp/test-enchant.txt &lt;&lt; "EOF"
175<literal>Tel me more abot linux
176Ther ar so many commads</literal>
177EOF
178
179enchant-2 -d en_GB -l /tmp/test-enchant.txt &amp;&amp;
180enchant-2 -d en_GB -a /tmp/test-enchant.txt</userinput></screen>
181
182 <para>
183 You will see a list of the misspelled words followed by a list of
184 alternatives for them.
185 </para>
186
187 <para>
188 See more details in the enchant manual page.
189 </para>
190
191 </sect3>
192
193 </sect2>
194
195 <sect2 role="content">
196 <title>Contents</title>
197
198 <segmentedlist>
199 <segtitle>Installed Programs</segtitle>
200 <segtitle>Installed Libraries</segtitle>
201 <segtitle>Installed Directories</segtitle>
202
203 <seglistitem>
204 <seg>enchant (symbolic link to enchant-2) and enchant-lsmod-2</seg>
205 <seg>libenchant-2.so and libenchant.so (symbolic link to
206 libenchant-2.so)</seg>
207 <seg>/usr/include/enchant{,-2}, /usr/lib/enchant-2, and
208 /usr/share/enchant</seg>
209 </seglistitem>
210 </segmentedlist>
211
212 <variablelist>
213 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
214 <?dbfo list-presentation="list"?>
215 <?dbhtml list-presentation="table"?>
216
217 <varlistentry id="enchant-prog">
218 <term><command>enchant</command></term>
219 <listitem>
220 <para>
221 is a spellchecker
222 </para>
223 <indexterm zone="enchant enchant-prog">
224 <primary sortas="b-enchant">enchant</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="enchant-lsmod-2">
230 <term><command>enchant-lsmod-2</command></term>
231 <listitem>
232 <para>
233 lists available backends, languages, and dictionaries
234 </para>
235 <indexterm zone="enchant enchant-lsmod-2">
236 <primary sortas="b-enchant-lsmod-2">enchant-lsmod-2</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="libenchant">
242 <term><filename class="libraryfile">libenchant.so</filename></term>
243 <listitem>
244 <para>
245 contains spell checking interface API functions
246 </para>
247 <indexterm zone="enchant libenchant">
248 <primary sortas="c-libenchant">libenchant.{so,a}</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 </variablelist>
254
255 </sect2>
256
257</sect1>
Note: See TracBrowser for help on using the repository browser.