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