source: gnome/add/orca.xml@ 4c2be438

<?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/3.4/orca-&orca-version;.tar.xz">
  <!ENTITY orca-download-ftp  "&gnome-download-ftp;/orca/3.4/orca-&orca-version;.tar.xz">
  <!ENTITY orca-md5sum        "42b2f4f02024865b4ad29cbd5ee1858b">
  <!ENTITY orca-size          "3.5 MB">
  <!ENTITY orca-buildsize     "60 MB">
  <!ENTITY orca-time          "0.8 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>

    &lfs70_checked;

    <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-spi2-core"/>,
      <xref linkend="dbus-python"/>,
      <xref linkend="gnome-doc-utils"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="pygobject3"/> and
      <xref linkend="pyxdg"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="rarian"/>
    </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) and
      <ulink url="http://devel.freebsoft.org/speechd/">speech dispatcher</ulink>
      (required for speech synthesis)
    </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 [ $GNOME_PREFIX != "/usr" ]; then
    sed -i "s|PATH=\"|&amp;$GNOME_PREFIX/bin:|" \
         src/orca/orca.in
 fi -->
<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc &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>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          orca
        </seg>
        <seg>
          /usr/lib/python2.7/site-packages/orca,
          /usr/share/gnome/help/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>