[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 " ">
|
---|
[6e8afde] | 9 | <!ENTITY enchant-md5sum "5a680a39c64c4ebb1bc02098cb5ed40b">
|
---|
| 10 | <!ENTITY enchant-size "972 KB">
|
---|
| 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 | <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 |
|
---|
[d56e7df] | 31 | <para>
|
---|
[0f124fa] | 32 | The <application>enchant</application> package provides a generic
|
---|
[d56e7df] | 33 | interface into various existing spell checking libraries.
|
---|
| 34 | </para>
|
---|
[7ff76531] | 35 |
|
---|
[03a2986] | 36 | &lfs111_checked;
|
---|
[5603a81] | 37 |
|
---|
[7ff76531] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
[d56e7df] | 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&enchant-download-http;"/>
|
---|
| 43 | </para>
|
---|
[7ff76531] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[d56e7df] | 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&enchant-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
[7ff76531] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[d56e7df] | 51 | <para>
|
---|
| 52 | Download MD5 sum: &enchant-md5sum;
|
---|
| 53 | </para>
|
---|
[7ff76531] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[d56e7df] | 56 | <para>
|
---|
| 57 | Download size: &enchant-size;
|
---|
| 58 | </para>
|
---|
[7ff76531] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[d56e7df] | 61 | <para>
|
---|
| 62 | Estimated disk space required: &enchant-buildsize;
|
---|
| 63 | </para>
|
---|
[7ff76531] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[d56e7df] | 66 | <para>
|
---|
| 67 | Estimated build time: &enchant-time;
|
---|
| 68 | </para>
|
---|
[7ff76531] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">enchant Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[47274444] | 75 | <para role="required">
|
---|
| 76 | <xref linkend="glib2"/>
|
---|
| 77 | </para>
|
---|
[7ff76531] | 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[47274444] | 80 | <para role="recommended">
|
---|
| 81 | <xref linkend="aspell"/>
|
---|
| 82 | </para>
|
---|
[7ff76531] | 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[47274444] | 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>
|
---|
[7ff76531] | 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 |
|
---|
[d56e7df] | 104 | <para>
|
---|
| 105 | Install <application>enchant</application> by running the following
|
---|
| 106 | commands:
|
---|
| 107 | </para>
|
---|
[7ff76531] | 108 |
|
---|
[d45a9e69] | 109 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[7ff76531] | 110 | make</userinput></screen>
|
---|
| 111 |
|
---|
[d56e7df] | 112 | <para>
|
---|
[8558044] | 113 | To run tests, unittest-cpp must be installed and the
|
---|
[d56e7df] | 114 | <option>--enable-relocatable</option> option passed to configure above.
|
---|
[8558044] | 115 | If these conditions are present, the tests may be run with <command>make
|
---|
[d56e7df] | 116 | check</command>.
|
---|
| 117 | </para>
|
---|
[7ff76531] | 118 |
|
---|
[d56e7df] | 119 | <para>
|
---|
| 120 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 121 | </para>
|
---|
[7ff76531] | 122 |
|
---|
[e6f368f] | 123 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[7ff76531] | 124 |
|
---|
| 125 | </sect2>
|
---|
| 126 |
|
---|
[d45a9e69] | 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 |
|
---|
[7ff76531] | 135 | <sect2 role="configuration">
|
---|
| 136 | <title>Configuring enchant</title>
|
---|
| 137 |
|
---|
| 138 | <sect3 id="enchant-config">
|
---|
| 139 | <title>Config Files</title>
|
---|
[d56e7df] | 140 | <para>
|
---|
| 141 | <filename>~/.enchant</filename> and
|
---|
| 142 | <filename>/usr/share/enchant/enchant.ordering</filename>
|
---|
| 143 | </para>
|
---|
[7ff76531] | 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>
|
---|
[8558044] | 156 | <!--
|
---|
| 157 | Looks like this is not required when installing enchant in the flavor
|
---|
[411857f9] | 158 | we do above. Leaving it in source (for a while) in case I'm wrong and
|
---|
| 159 | it needs to be restored.
|
---|
[d45a9e69] | 160 | <para>
|
---|
[ea0c1c2] | 161 | If you wish to use the <xref linkend="aspell"/> backend, create a
|
---|
[d45a9e69] | 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>
|
---|
[411857f9] | 166 | -->
|
---|
[d45a9e69] | 167 | <para>
|
---|
| 168 | You can test your installation and configuration by creating a test
|
---|
[a6852d6] | 169 | file and running the following commands (you can replace the
|
---|
[f8939c0] | 170 | en_GB dictionary by any other downloaded when installing <xref
|
---|
| 171 | linkend="aspell"/>):
|
---|
[d45a9e69] | 172 | </para>
|
---|
| 173 |
|
---|
[e7d4e823] | 174 | <screen remap="test"><userinput>cat > /tmp/test-enchant.txt << "EOF"
|
---|
[d45a9e69] | 175 | <literal>Tel me more abot linux
|
---|
| 176 | Ther ar so many commads</literal>
|
---|
| 177 | EOF
|
---|
| 178 |
|
---|
[e6f368f] | 179 | enchant-2 -d en_GB -l /tmp/test-enchant.txt &&
|
---|
| 180 | enchant-2 -d en_GB -a /tmp/test-enchant.txt</userinput></screen>
|
---|
[d45a9e69] | 181 |
|
---|
| 182 | <para>
|
---|
[f8939c0] | 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.
|
---|
[d45a9e69] | 189 | </para>
|
---|
[7ff76531] | 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>
|
---|
[4ce51255] | 204 | <seg>enchant-2 and enchant-lsmod-2</seg>
|
---|
| 205 | <seg>libenchant-2.so</seg>
|
---|
| 206 | <seg>/usr/include/enchant-2, /usr/lib/enchant-2, and
|
---|
[d1de86bc] | 207 | /usr/share/enchant</seg>
|
---|
[7ff76531] | 208 | </seglistitem>
|
---|
| 209 | </segmentedlist>
|
---|
| 210 |
|
---|
| 211 | <variablelist>
|
---|
| 212 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 213 | <?dbfo list-presentation="list"?>
|
---|
| 214 | <?dbhtml list-presentation="table"?>
|
---|
| 215 |
|
---|
[4ce51255] | 216 | <varlistentry id="enchant-2">
|
---|
| 217 | <term><command>enchant-2</command></term>
|
---|
[7ff76531] | 218 | <listitem>
|
---|
[d56e7df] | 219 | <para>
|
---|
| 220 | is a spellchecker
|
---|
| 221 | </para>
|
---|
[4ce51255] | 222 | <indexterm zone="enchant enchant-2">
|
---|
| 223 | <primary sortas="b-enchant-2">enchant-2</primary>
|
---|
[7ff76531] | 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
[b3e767b] | 227 |
|
---|
| 228 | <varlistentry id="enchant-lsmod-2">
|
---|
| 229 | <term><command>enchant-lsmod-2</command></term>
|
---|
[7ff76531] | 230 | <listitem>
|
---|
[d56e7df] | 231 | <para>
|
---|
[4c24eb0a] | 232 | lists available backends, languages, and dictionaries
|
---|
[d56e7df] | 233 | </para>
|
---|
[b3e767b] | 234 | <indexterm zone="enchant enchant-lsmod-2">
|
---|
| 235 | <primary sortas="b-enchant-lsmod-2">enchant-lsmod-2</primary>
|
---|
[7ff76531] | 236 | </indexterm>
|
---|
| 237 | </listitem>
|
---|
| 238 | </varlistentry>
|
---|
[b3e767b] | 239 |
|
---|
[4ce51255] | 240 | <varlistentry id="libenchant-2">
|
---|
| 241 | <term><filename class="libraryfile">libenchant-2.so</filename></term>
|
---|
[7ff76531] | 242 | <listitem>
|
---|
[d56e7df] | 243 | <para>
|
---|
[4c24eb0a] | 244 | contains spell checking interface API functions
|
---|
[d56e7df] | 245 | </para>
|
---|
[4ce51255] | 246 | <indexterm zone="enchant libenchant-2">
|
---|
| 247 | <primary sortas="c-libenchant-2">libenchant-2.so</primary>
|
---|
[7ff76531] | 248 | </indexterm>
|
---|
| 249 | </listitem>
|
---|
| 250 | </varlistentry>
|
---|
| 251 |
|
---|
| 252 | </variablelist>
|
---|
| 253 |
|
---|
| 254 | </sect2>
|
---|
| 255 |
|
---|
| 256 | </sect1>
|
---|