source: gnome/add/orca.xml@ b25e695

<?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 orca-download-http "&gnome-download-http;/orca/&gnome-version;/orca-&orca-version;.tar.bz2">
  <!ENTITY orca-download-ftp  "&gnome-download-ftp;/orca/&gnome-version;/orca-&orca-version;.tar.bz2">
  <!ENTITY orca-md5sum        "ae4c3eae0800d46a74c2b66f4f3681f9">
  <!ENTITY orca-size          "2.1 MB">
  <!ENTITY orca-buildsize     "39 MB">
  <!ENTITY orca-time          "0.1 SBU">
]>

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

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

  <title>Orca-&orca-version;</title>

  <indexterm zone="orca">
    <primary sortas="a-Orca">Orca</primary>
  </indexterm>

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

    <para><application>Orca</application> enables users with limited
    vision, or no vision, to use the GNOME desktop and applications
    effectively. It provides a number of features, including magnification,
    focus tracking, braille output, automatic screen reading and more.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="at-spi"/>,
    <xref linkend="dbus-python"/>, and
    <xref linkend="gnome-python"/> (with
    <xref linkend="pyorbit"/>)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><ulink
    url="http://www.mielke.cc/brltty/">BRLTTY</ulink> (required for braille
    output, must have <ulink
    url="http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/">Pyrex</ulink>
    installed first),
    <ulink url="http://code.google.com/p/liblouis/">liblouis</ulink> (required
    for contracted braille),
    <xref linkend="gnome-mag"/> (required for screen magnification),
    <xref linkend="gnome-python-desktop"/> (wnck module required for mouse
    review),
    <xref linkend="gnome-speech"/> (required for speech-enabled screen
    reading)</para>

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

  </sect2>

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

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

<screen><userinput>if [ $(pkg-config --variable=prefix ORBit-2.0) != "/usr" ]; then
    sed -i "s|PATH=\"|&amp;$(pkg-config \
           --variable=prefix ORBit-2.0)/bin:|" \
        src/orca/orca.in
fi

./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>

    <!-- see NEWS: Fix for bgo#589244 - Remove libgail-gnome usage, use gail in
    gtk+ instead.
    <para>For full functionality of this package, you should install the
    <xref linkend="libgail-gnome"/> package.</para>-->

  </sect2>

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

    <para><command>if [ ... != "/usr" ]; then ...; fi</command>: This command
    is used to add the <application>GNOME</application> prefix
    <filename class='directory'>bin</filename> directory to the hard-coded
    <envar>PATH</envar> statement in the script if the
    <application>GNOME</application> prefix is anything other than
    <filename class='directory'>/usr</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>orca</seg>
        <seg><application>Python</application> assistive technology
        (accessiblity) modules</seg>
        <seg>/usr/lib/python&python-majorver;/site-packages/orca and
        /usr/share/orca</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="orca-prog">
        <term><command>orca</command></term>
        <listitem>
          <para>is a GUI menu interface used to access and configure the
          various functionality parameters provided for users with limited
          vision.</para>
          <indexterm zone="orca orca-prog">
            <primary sortas="b-orca">orca</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>