glfs/gnome/core/gail.xml

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

  <!ENTITY gail-download-http "http://ftp.gnome.org/pub/GNOME/sources/gail/1.8/gail-&gail-version;.tar.bz2">
  <!ENTITY gail-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/gail/1.8/gail-&gail-version;.tar.bz2">
  <!ENTITY gail-md5sum        "7587a0a9ee643bb59ef6b2dea06c5a28">
  <!ENTITY gail-size          "563 KB">
  <!ENTITY gail-buildsize     "19.3 MB">
  <!ENTITY gail-time          "0.6 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gail-&gail-version;.tar</keyword>
      <keyword role="ftptdir">gail</keyword>
    </keywordset>
  </sect1info>

  <title>GAIL-&gail-version;</title>

  <indexterm zone="gail">
    <primary sortas="a-GAIL">GAIL</primary>
  </indexterm>

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

    <para>The <application>GAIL</application> package contains the
    <application>GNOME</application> Accessibility Implementation
    Libraries.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgnomecanvas"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/></para>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../without-gnome.xml"/>

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

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

    <para><application>GTK+</application> will look for the
    <application>GAIL</application> modules in
    <filename class='directory'>/usr/lib</filename> even if
    <envar>$GNOME_PREFIX</envar> is <emphasis>NOT</emphasis>
    <filename class='directory'>/usr</filename>. If <envar>$GNOME_PREFIX</envar>
    is anything other than <filename class='directory'>/usr</filename>, create
    a symlink to <envar>$GNOME_PREFIX</envar> to satisfy this requirement:</para>

<screen role="root"><userinput>ln -v -s `pkg-config --variable=prefix ORBit-2.0`/lib/gtk-2.0/modules \
    /usr/lib/gtk-2.0</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><option>--enable-gtk-doc</option>: Use this parameter if you have
    <application>GTK-Doc</application> installed and wish to build the API
    documentation as the source tarball doesn't contain pre-built docs.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libgailutil.so and <application>GAIL</application>
        <application>GTK+</application> modules</seg>
        <seg>$GNOME_PREFIX/include/gail-1.0,
        $GNOME_PREFIX/lib/gtk-2.0/modules, and
        $GNOME_PREFIX/share/gtk-doc/html/gail-libgail-util</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgailutil">
        <term><filename class='libraryfile'>libgailutil.so</filename></term>
        <listitem>
          <para>provides the functions that solve accessibility problems
          in a consistent manner across <application>GNOME</application>.</para>
          <indexterm zone="gail libgailutil">
            <primary sortas="b-libgailutil">libgailutil.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>