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