[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[3c2936fe] | 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 |
|
---|
[325ebd7] | 7 | <!ENTITY gspell-download-http "&gnome-download-http;/gspell/&gspell-minor;/gspell-&gspell-version;.tar.xz">
|
---|
[01701da9] | 8 | <!ENTITY gspell-download-ftp " ">
|
---|
[eb6e9a0] | 9 | <!ENTITY gspell-md5sum "282c1ed7213a657e47de663fd2a081db">
|
---|
| 10 | <!ENTITY gspell-size "116 KB">
|
---|
| 11 | <!ENTITY gspell-buildsize "6.7 MB (with tests)">
|
---|
[777a66a] | 12 | <!ENTITY gspell-time "0.1 SBU (with tests)">
|
---|
[3c2936fe] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gspell" xreflabel="gspell-&gspell-version;">
|
---|
| 16 | <?dbhtml filename="gspell.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>gspell-&gspell-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="gspell">
|
---|
| 22 | <primary sortas="a-gspell">gspell</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to gspell</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | The <application>gspell</application> package provides a flexible API to
|
---|
| 30 | add spell checking to a GTK+ application.
|
---|
| 31 | </para>
|
---|
| 32 |
|
---|
[7426e905] | 33 | &lfs122_checked;
|
---|
[3c2936fe] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&gspell-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&gspell-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &gspell-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &gspell-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &gspell-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &gspell-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect3">gspell Dependencies</bridgehead>
|
---|
| 70 |
|
---|
[f25fda55] | 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
[eabab82] | 73 | <xref linkend="enchant"/>,
|
---|
[193807ab] | 74 | <xref linkend="icu"/>, and
|
---|
[5380ca3] | 75 | <xref linkend="gtk3"/>
|
---|
[f25fda55] | 76 | </para>
|
---|
| 77 |
|
---|
[3c2936fe] | 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 79 | <para role="optional">
|
---|
[c0bc0a9] | 80 | &gobject-introspection;,
|
---|
[3c2936fe] | 81 | <xref linkend="gtk-doc"/>,
|
---|
[fd442264] | 82 | <xref linkend="vala"/>,
|
---|
| 83 | <xref linkend="valgrind"/>, and
|
---|
| 84 | <ulink url="https://hunspell.github.io/">Hunspell</ulink> (for tests)
|
---|
[3c2936fe] | 85 | </para>
|
---|
| 86 |
|
---|
| 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 role="installation">
|
---|
| 90 | <title>Installation of gspell</title>
|
---|
| 91 |
|
---|
| 92 | <para>
|
---|
| 93 | Install <application>gspell</application> by running the following
|
---|
| 94 | commands:
|
---|
| 95 | </para>
|
---|
| 96 |
|
---|
[eb6e9a0] | 97 | <screen><userinput>mkdir gspell-build &&
|
---|
| 98 | cd gspell-build &&
|
---|
| 99 |
|
---|
| 100 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
| 101 | ninja</userinput></screen>
|
---|
[3c2936fe] | 102 |
|
---|
| 103 | <para>
|
---|
[eb6e9a0] | 104 | To test the results, issue: <command>ninja test</command>. The tests
|
---|
[193807ab] | 105 | must be run in an X session. One test, test-checker, is known to fail if
|
---|
| 106 | the external package
|
---|
| 107 | <ulink url="https://hunspell.github.io/">Hunspell</ulink> is not
|
---|
| 108 | installed.
|
---|
[3c2936fe] | 109 | </para>
|
---|
| 110 |
|
---|
| 111 | <para>
|
---|
| 112 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
[eb6e9a0] | 115 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[eb8d428] | 116 |
|
---|
[eb6e9a0] | 117 | <!-- not needed because of meson
|
---|
[eb8d428] | 118 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 119 | href="../../xincludes/rm-la-file-referring-icu.xml"/>
|
---|
| 120 |
|
---|
| 121 | <screen role="root"><userinput>rm -v /usr/lib/libgspell-1.la</userinput></screen>
|
---|
[eb6e9a0] | 122 | -->
|
---|
[3c2936fe] | 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 |
|
---|
| 126 | <sect2 role="content">
|
---|
| 127 | <title>Contents</title>
|
---|
| 128 |
|
---|
| 129 | <segmentedlist>
|
---|
| 130 | <segtitle>Installed Programs</segtitle>
|
---|
| 131 | <segtitle>Installed Libraries</segtitle>
|
---|
| 132 | <segtitle>Installed Directories</segtitle>
|
---|
| 133 |
|
---|
| 134 | <seglistitem>
|
---|
[cfc1f98] | 135 | <seg>gspell-app1</seg>
|
---|
[3c2936fe] | 136 | <seg>libgspell-1.so</seg>
|
---|
| 137 | <seg>/usr/include/gspell-1 and
|
---|
| 138 | /usr/share/gtk-doc/html/gspell-1.0</seg>
|
---|
| 139 | </seglistitem>
|
---|
| 140 | </segmentedlist>
|
---|
[170e308] | 141 |
|
---|
[3c2936fe] | 142 | <variablelist>
|
---|
| 143 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 144 | <?dbfo list-presentation="list"?>
|
---|
| 145 | <?dbhtml list-presentation="table"?>
|
---|
| 146 |
|
---|
[170e308] | 147 | <varlistentry id="gspell-app1">
|
---|
| 148 | <term><command>gspell-app1</command></term>
|
---|
[3c2936fe] | 149 | <listitem>
|
---|
| 150 | <para>
|
---|
[4c24eb0a] | 151 | checks the spelling of a text entered in a window
|
---|
[3c2936fe] | 152 | </para>
|
---|
[170e308] | 153 | <indexterm zone="gspell gspell-app1">
|
---|
| 154 | <primary sortas="b-gspell-app1">gspell-app1</primary>
|
---|
[3c2936fe] | 155 | </indexterm>
|
---|
| 156 | </listitem>
|
---|
| 157 | </varlistentry>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="libgspell">
|
---|
| 160 | <term><filename class="libraryfile">libgspell-1.so</filename></term>
|
---|
| 161 | <listitem>
|
---|
| 162 | <para>
|
---|
[4c24eb0a] | 163 | is the <application>gspell</application> API library
|
---|
[3c2936fe] | 164 | </para>
|
---|
[170e308] | 165 | <indexterm zone="gspell libgspell">
|
---|
| 166 | <primary sortas="c-libgspell">libgspell-1.so</primary>
|
---|
[3c2936fe] | 167 | </indexterm>
|
---|
| 168 | </listitem>
|
---|
| 169 | </varlistentry>
|
---|
| 170 | </variablelist>
|
---|
[170e308] | 171 |
|
---|
[3c2936fe] | 172 | </sect2>
|
---|
[4c24eb0a] | 173 |
|
---|
[3c2936fe] | 174 | </sect1>
|
---|