source: gnome/add/at-spi.xml@ b88be39

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 at-spi-download-http "&gnome-download-http;/at-spi/1.30/at-spi-&at-spi-version;.tar.bz2">
  <!ENTITY at-spi-download-ftp  "&gnome-download-ftp;/at-spi/1.30/at-spi-&at-spi-version;.tar.bz2">
  <!ENTITY at-spi-md5sum        "29fdf7934e98efda5fe0ab74ab4d3f29">
  <!ENTITY at-spi-size          "817 KB">
  <!ENTITY at-spi-buildsize     "23 MB">
  <!ENTITY at-spi-time          "0.4 SBU">
]>

<sect1 id="at-spi" xreflabel="AT SPI-&at-spi-version;">
  <?dbhtml filename="at-spi.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>AT SPI-&at-spi-version;</title>

  <indexterm zone="at-spi">
    <primary sortas="a-AT-SPI">AT SPI</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to AT SPI</title>

    <para>The <application>AT SPI</application> package contains the Assistive
    Technology Service Provider Interface. This is useful for redirecting
    UI events to accessible applications and adaptive/assistive
    technologies.</para>

    &lfs65_checked;

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

    <bridgehead renderas="sect3">AT SPI Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="GConf"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="libbonobo"/>,
    <xref linkend="python"/>, and
    <xref linkend="xorg7-lib"/></para>

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

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/at-spi"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of AT SPI</title>

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --libexecdir=$(pkg-config \
                --variable=prefix ORBit-2.0)/lib/at-spi &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a functional test suite. Review the
    <filename>README</filename> file for additional information about testing
    the package.</para>

    <!-- The test suite cannot be run until after the package is installed.
    To run the test suite after installation, issue:
    <command>make check</command>.</para> -->

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

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

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-prefix.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-sysconfdir.xml"/>

    <para><parameter>--libexecdir=$(pkg-config --variable=prefix
    ORBit-2.0)/lib/at-spi</parameter>: This parameter causes the libexec
    files to be installed in the preferred location of
    <filename class="directory">$GNOME_PREFIX/lib/at-spi</filename> instead of
    <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>at-spi-registryd</seg>
        <seg>libatk-bridge.so, libcspi.so, libloginhelper.so, libspi.so,
        Accessibility_LoginHelper_module.so, and Accessibility_module.so</seg>
        <seg>/usr/lib/python&python2-majorver;/site-packages/pyatspi,
        <envar>$GNOME_PREFIX</envar>/{include/at-spi-1.0/{cspi,libspi,
        login-helper},lib/at-spi,share/{doc/at-spi-1.30.1/reference/html,
        gtk-doc/html/at-spi-cspi,idl/at-spi-1.0}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="at-spi-registryd">
        <term><command>at-spi-registryd</command></term>
        <listitem>
          <para>is the registry daemon that allows communication between
          the UI and assistance devices.</para>
          <indexterm zone="at-spi at-spi-registryd">
            <primary sortas="b-at-spi-registryd">at-spi-registryd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libatk-bridge">
        <term><filename class='libraryfile'>libatk-bridge.so</filename></term>
        <listitem>
          <para>is a <application>GTK+</application> module.</para>
          <indexterm zone="at-spi libatk-bridge">
            <primary sortas="c-libatk-bridge">libatk-bridge.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!--<varlistentry id="libcspi">
        <term><filename class='libraryfile'>libcspi.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="at-spi libcspi">
            <primary sortas="c-libcspi">libcspi.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libloginhelper">
        <term><filename class='libraryfile'>libloginhelper.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="at-spi libloginhelper">
            <primary sortas="c-libloginhelper">libloginhelper.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libspi">
        <term><filename class='libraryfile'>libspi.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="at-spi libspi">
            <primary sortas="c-libspi">libspi.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

      <varlistentry id="Accessibility_LoginHelper_module">
        <term><filename class='libraryfile'>Accessibility_LoginHelper_module.so</filename></term>
        <listitem>
          <para>is an <application>ORBit2</application> module.</para>
          <indexterm zone="at-spi Accessibility_LoginHelper_module">
            <primary sortas="c-Accessibility_LoginHelper_module">Accessibility_LoginHelper_module.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="Accessibility_module">
        <term><filename class='libraryfile'>Accessibility_module.so</filename></term>
        <listitem>
          <para>is an <application>ORBit2</application> module.</para>
          <indexterm zone="at-spi Accessibility_module">
            <primary sortas="c-Accessibility_module">Accessibility_module.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>