[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 " ">
|
---|
[a6852d6] | 9 | <!ENTITY enchant-md5sum "c7b9d6a392ecb8758e499f783e8dc883">
|
---|
| 10 | <!ENTITY enchant-size "956 KB">
|
---|
| 11 | <!ENTITY enchant-buildsize "7.5 MB">
|
---|
[2f74a35] | 12 | <!ENTITY enchant-time "0.2 SBU">
|
---|
[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 |
|
---|
[5380ca3] | 37 | &lfs91_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>
|
---|
[aa4778c4] | 76 | <para role="required"><xref linkend="glib2"/></para>
|
---|
[7ff76531] | 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 79 | <para role="recommended"><xref linkend="aspell"/></para>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 82 | <para role="optional"><xref linkend="dbus-glib"/>,
|
---|
[a6852d6] | 83 | <xref linkend="doxygen"/>,
|
---|
[15114f7] | 84 | <ulink url="http://hspell.ivrix.org.il/">Hspell</ulink>,
|
---|
[a7c2ccc] | 85 | <ulink url="http://hunspell.github.io/">Hunspell</ulink>,
|
---|
[a6852d6] | 86 | <ulink url="https://nuspell.github.io/">Nuspell</ulink>,
|
---|
[a7c2ccc] | 87 | <ulink url="http://hunspell.github.io/">Voikko</ulink>, and
|
---|
| 88 | <ulink url="https://github.com/unittest-cpp/unittest-cpp/releases">unittest-cpp</ulink> (required for tests)</para>
|
---|
[7ff76531] | 89 |
|
---|
| 90 | <para condition="html" role="usernotes">User Notes:
|
---|
| 91 | <ulink url="&blfs-wiki;/enchant"/></para>
|
---|
| 92 |
|
---|
| 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="installation">
|
---|
| 96 | <title>Installation of enchant</title>
|
---|
| 97 |
|
---|
[d56e7df] | 98 | <para>
|
---|
| 99 | Install <application>enchant</application> by running the following
|
---|
| 100 | commands:
|
---|
| 101 | </para>
|
---|
[7ff76531] | 102 |
|
---|
[d45a9e69] | 103 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[7ff76531] | 104 | make</userinput></screen>
|
---|
| 105 |
|
---|
[d56e7df] | 106 | <para>
|
---|
| 107 | To run tests, unittest-cpp must be installed and the
|
---|
| 108 | <option>--enable-relocatable</option> option passed to configure above.
|
---|
| 109 | If these conditions are present, the tests may be run with <command>make
|
---|
| 110 | check</command>.
|
---|
| 111 | </para>
|
---|
[7ff76531] | 112 |
|
---|
[d56e7df] | 113 | <para>
|
---|
| 114 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 115 | </para>
|
---|
[7ff76531] | 116 |
|
---|
[6323e0b4] | 117 | <screen role="root"><userinput>make install &&
|
---|
| 118 | rm -rf /usr/include/enchant &&
|
---|
| 119 | ln -sfv enchant-2 /usr/include/enchant &&
|
---|
[411857f9] | 120 | ln -sfv enchant-2 /usr/bin/enchant &&
|
---|
[6323e0b4] | 121 | ln -sfv libenchant-2.so /usr/lib/libenchant.so &&
|
---|
| 122 | ln -sfv enchant-2.pc /usr/lib/pkgconfig/enchant.pc</userinput></screen>
|
---|
[7ff76531] | 123 |
|
---|
| 124 | </sect2>
|
---|
| 125 |
|
---|
[d45a9e69] | 126 | <sect2 role="commands">
|
---|
| 127 | <title>Command Explanations</title>
|
---|
| 128 |
|
---|
| 129 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 130 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 131 |
|
---|
[6323e0b4] | 132 | <para>
|
---|
| 133 | <command>rm -rf /usr/include/enchant</command>;
|
---|
[997ab881] | 134 | <command>ln -sfn ...</command>: Create symlinks for this package
|
---|
[6323e0b4] | 135 | version so that other other packages can find it using the old name.
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
[d45a9e69] | 138 | </sect2>
|
---|
| 139 |
|
---|
[7ff76531] | 140 | <sect2 role="configuration">
|
---|
| 141 | <title>Configuring enchant</title>
|
---|
| 142 |
|
---|
| 143 | <sect3 id="enchant-config">
|
---|
| 144 | <title>Config Files</title>
|
---|
[d56e7df] | 145 | <para>
|
---|
| 146 | <filename>~/.enchant</filename> and
|
---|
| 147 | <filename>/usr/share/enchant/enchant.ordering</filename>
|
---|
| 148 | </para>
|
---|
[7ff76531] | 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>
|
---|
[411857f9] | 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.
|
---|
[d45a9e69] | 165 | <para>
|
---|
[ea0c1c2] | 166 | If you wish to use the <xref linkend="aspell"/> backend, create a
|
---|
[d45a9e69] | 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>
|
---|
[411857f9] | 171 | -->
|
---|
[d45a9e69] | 172 | <para>
|
---|
| 173 | You can test your installation and configuration by creating a test
|
---|
[a6852d6] | 174 | file and running the following commands (you can replace the
|
---|
[f8939c0] | 175 | en_GB dictionary by any other downloaded when installing <xref
|
---|
| 176 | linkend="aspell"/>):
|
---|
[d45a9e69] | 177 | </para>
|
---|
| 178 |
|
---|
[e7d4e823] | 179 | <screen remap="test"><userinput>cat > /tmp/test-enchant.txt << "EOF"
|
---|
[d45a9e69] | 180 | <literal>Tel me more abot linux
|
---|
| 181 | Ther ar so many commads</literal>
|
---|
| 182 | EOF
|
---|
| 183 |
|
---|
| 184 | enchant -d en_GB -l /tmp/test-enchant.txt &&
|
---|
| 185 | enchant -d en_GB -a /tmp/test-enchant.txt</userinput></screen>
|
---|
| 186 |
|
---|
| 187 | <para>
|
---|
[f8939c0] | 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.
|
---|
[d45a9e69] | 194 | </para>
|
---|
[7ff76531] | 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>
|
---|
[b3e767b] | 209 | <seg>enchant and enchant-lsmod-2</seg>
|
---|
[d45a9e69] | 210 | <seg>libenchant.so and various backend libraries</seg>
|
---|
[3b9ea00] | 211 | <seg>/usr/{include,lib,share}/enchant-2</seg>
|
---|
[7ff76531] | 212 | </seglistitem>
|
---|
| 213 | </segmentedlist>
|
---|
| 214 |
|
---|
| 215 | <variablelist>
|
---|
| 216 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 217 | <?dbfo list-presentation="list"?>
|
---|
| 218 | <?dbhtml list-presentation="table"?>
|
---|
| 219 |
|
---|
| 220 | <varlistentry id="enchant-prog">
|
---|
| 221 | <term><command>enchant</command></term>
|
---|
| 222 | <listitem>
|
---|
[d56e7df] | 223 | <para>
|
---|
| 224 | is a spellchecker
|
---|
| 225 | </para>
|
---|
[7ff76531] | 226 | <indexterm zone="enchant enchant-prog">
|
---|
| 227 | <primary sortas="b-enchant">enchant</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
[b3e767b] | 231 |
|
---|
| 232 | <varlistentry id="enchant-lsmod-2">
|
---|
| 233 | <term><command>enchant-lsmod-2</command></term>
|
---|
[7ff76531] | 234 | <listitem>
|
---|
[d56e7df] | 235 | <para>
|
---|
| 236 | lists available backends, languages, and dictionaries.
|
---|
| 237 | </para>
|
---|
[b3e767b] | 238 | <indexterm zone="enchant enchant-lsmod-2">
|
---|
| 239 | <primary sortas="b-enchant-lsmod-2">enchant-lsmod-2</primary>
|
---|
[7ff76531] | 240 | </indexterm>
|
---|
| 241 | </listitem>
|
---|
| 242 | </varlistentry>
|
---|
[b3e767b] | 243 |
|
---|
[7ff76531] | 244 | <varlistentry id="libenchant">
|
---|
[f8939c0] | 245 | <term><filename class='libraryfile'>libenchant.so</filename></term>
|
---|
[7ff76531] | 246 | <listitem>
|
---|
[d56e7df] | 247 | <para>
|
---|
| 248 | contains spell checking interface API functions.
|
---|
| 249 | </para>
|
---|
[7ff76531] | 250 | <indexterm zone="enchant libenchant">
|
---|
| 251 | <primary sortas="c-libenchant">libenchant.{so,a}</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
| 255 |
|
---|
| 256 | </variablelist>
|
---|
| 257 |
|
---|
| 258 | </sect2>
|
---|
| 259 |
|
---|
| 260 | </sect1>
|
---|