source: gnome/add/at-spi2-core.xml@ 3dc432e

<?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-spi2-core-download-http "&gnome-download-http;/at-spi2-core/2.3/at-spi2-core-&at-spi2-core-version;.tar.xz">
  <!ENTITY at-spi2-core-download-ftp  "&gnome-download-ftp;/at-spi2-core/2.3/at-spi2-core-&at-spi2-core-version;.tar.xz">
  <!ENTITY at-spi2-core-md5sum        "983f3dfe71187877138139d81af41ccf">
  <!ENTITY at-spi2-core-size          "421 KB">
  <!ENTITY at-spi2-core-buildsize     "12 MB">
  <!ENTITY at-spi2-core-time          "0.2 SBU">
]>

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

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

  <title>at-spi2-core-&at-spi2-core-version;</title>

  <indexterm zone="at-spi2-core">
    <primary sortas="a-at-spi2-core">at-spi2-core</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to at-spi2-core</title>

    <para>The <application>at-spi2-core</application> package is a part of the Gnome
    Accessibility Project. It provides a Service Provider Interface for the Assisstive
    Technologies available on the <application>GNOME</application> platform, and a
    library against which applications can be linked.</para>

    &lfs70_built;

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

    <bridgehead renderas="sect3">at-spi2-core Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="dbus"/> and
    <xref linkend="pkgconfig"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of at-spi2-core</title>

    <para>Install <application>at-spi2-core</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$GNOME_PREFIX \
            --sysconfdir=$GNOME_SYSCONFDIR \
            --libexecdir=$GNOME_PREFIX/lib/at-spi2-core &amp;&amp;
make</userinput></screen>

    <para>To test the results, 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>

    <para><parameter>--sysconfdir=$GNOME_SYSCONFDIR</parameter>: This parameter
    controls where the <filename>accessibility.conf</filename> file will be installed.
    If your prefix is <filename class="directory">/usr</filename> this is necessary
    so that the file will be in <filename class="directory">/etc</filename> instead
    of <filename class="directory">/usr/etc</filename></para>

    <para><parameter>--libexecdir=$GNOME_PREFIX/lib/at-spi2-core</parameter>: This
    parameter ensures both programs will be installed to this directory, instead
    of the non-FHS-compliant
    <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>at-spi-bus-launcher and at-spi2-registryd</seg>
        <seg>libatspi.so</seg>
        <seg><envar>$GNOME_SYSCONFDIR</envar>/{at-spi2,xdg/autostart}, <envar>$GNOME_PREFIX</envar>/{include/at-spi-2.0/atspi,lib/at-spi2-core,share/gtk-doc/html/libatspi}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="at-spi-bus-launcher">
        <term><command>at-spi-bus-launcher</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="at-spi2-core at-spi-bus-launcher">
            <primary sortas="b-at-spi-bus-launcher">at-spi-bus-launcher</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="at-spi2-registryd">
        <term><command>at-spi2-registryd</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="at-spi2-core at-spi2-registryd">
            <primary sortas="b-at-spi2-registryd">at-spi2-registryd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>