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