source: general/genlib/gspell.xml@ eb6e9a0

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gspell-download-http "&gnome-download-http;/gspell/&gspell-minor;/gspell-&gspell-version;.tar.xz">
  <!ENTITY gspell-download-ftp  " ">
  <!ENTITY gspell-md5sum        "282c1ed7213a657e47de663fd2a081db">
  <!ENTITY gspell-size          "116 KB">
  <!ENTITY gspell-buildsize     "6.7 MB (with tests)">
  <!ENTITY gspell-time          "0.1 SBU (with tests)">
]>

<sect1 id="gspell" xreflabel="gspell-&gspell-version;">
  <?dbhtml filename="gspell.html"?>


  <title>gspell-&gspell-version;</title>

  <indexterm zone="gspell">
    <primary sortas="a-gspell">gspell</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to gspell</title>

    <para>
      The <application>gspell</application> package provides a flexible API to
      add spell checking to a GTK+ application.
    </para>

    &lfs122_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&gspell-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&gspell-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &gspell-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &gspell-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &gspell-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &gspell-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">gspell Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="enchant"/>,
      <xref linkend="icu"/>, and
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      &gobject-introspection;,
      <xref linkend="gtk-doc"/>,
      <xref linkend="vala"/>,
      <xref linkend="valgrind"/>, and
      <ulink url="https://hunspell.github.io/">Hunspell</ulink> (for tests)
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of gspell</title>

    <para>
      Install <application>gspell</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir gspell-build &amp;&amp;
cd    gspell-build &amp;&amp;

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.  The tests
      must be run in an X session. One test, test-checker, is known to fail if
      the external package
      <ulink url="https://hunspell.github.io/">Hunspell</ulink> is not
      installed.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

<!-- not needed because of meson
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/rm-la-file-referring-icu.xml"/>

<screen role="root"><userinput>rm -v /usr/lib/libgspell-1.la</userinput></screen>
-->
 </sect2>


  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gspell-app1</seg>
        <seg>libgspell-1.so</seg>
        <seg>/usr/include/gspell-1 and
             /usr/share/gtk-doc/html/gspell-1.0</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gspell-app1">
        <term><command>gspell-app1</command></term>
        <listitem>
          <para>
            checks the spelling of a text entered in a window
          </para>
          <indexterm zone="gspell gspell-app1">
            <primary sortas="b-gspell-app1">gspell-app1</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgspell">
        <term><filename class="libraryfile">libgspell-1.so</filename></term>
        <listitem>
          <para>
            is the <application>gspell</application> API library
          </para>
          <indexterm zone="gspell libgspell">
            <primary sortas="c-libgspell">libgspell-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>