source: gnome/add/gnopernicus.xml@ a29060d

<?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 gnopernicus-download-http "&gnome-download-http;/gnopernicus/0.11/gnopernicus-&gnopernicus-version;.tar.bz2">
  <!ENTITY gnopernicus-download-ftp  "&gnome-download-ftp;/gnopernicus/0.11/gnopernicus-&gnopernicus-version;.tar.bz2">
  <!ENTITY gnopernicus-md5sum        "d2042f0d7fde12a90cc23b98420dbeda">
  <!ENTITY gnopernicus-size          "2.1 MB">
  <!ENTITY gnopernicus-buildsize     "40.5 MB">
  <!ENTITY gnopernicus-time          "0.6 SBU">
]>

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

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

  <title>Gnopernicus-&gnopernicus-version;</title>

  <indexterm zone="gnopernicus">
    <primary sortas="a-Gnopernicus">Gnopernicus</primary>
  </indexterm>

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

    <para><application>Gnopernicus</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="&gnopernicus-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gnopernicus-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gnopernicus-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gnopernicus-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gnopernicus-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gnopernicus-time;</para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgail-gnome"/>,
    <xref linkend="gnome-speech"/>, and
    <xref linkend="gnome-mag"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/> and
    <ulink url="http://www.mielke.cc/brltty/">BRLTTY</ulink></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
            --libexecdir=`pkg-config \
            --variable=prefix ORBit-2.0`/lib/gnopernicus-1.0 \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib &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><parameter>--libexecdir=`pkg-config --variable=prefix
    ORBit-2.0`/lib/gnopernicus-1.0</parameter>: This switch puts libexec files
    in <filename class="directory">$GNOME_PREFIX/lib/gnopernicus-1.0</filename>
    instead of
    <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This switch puts
    configuration files in <filename class="directory">&gnome-etc-dir;</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename>.</para>

    <!-- Commented out as the default X font dir is not /usr/share/fonts
    <para><parameter>-with-default-fonts-path=/usr/X11R6/lib/X11/fonts/Type1</parameter>:
    This switch installs Braille fonts into
    <filename class='directory'>/usr/X11R6/lib/X11/fonts/Type1</filename> instead
    of <filename class='directory'>/usr/share/fonts/default/Type1</filename>.</para>
    -->

  </sect2>

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

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

      <seglistitem>
        <seg>gnopernicus, gnopernicus-mag-config and srcore</seg>
        <seg><application>Gnopernicus</application> support libraries</seg>
        <seg>&gnome-etc-dir;/gconf/gconf.xml.defaults/apps/gnopernicus,
        &gnome-etc-dir;/gconf/gconf.xml.defaults/schemas/apps/gnopernicus,
        &gnome-etc-dir;/gnopernicus-1.0, and the following subdirectories of
        $GNOME_PREFIX/:
        include/gnopernicus-1.0,
        lib/gnopernicus-1.0,
        share/gnome/help/{brlmonitor,gnopernicus},
        share/gnopernicus and
        share/omf/gnopernicus</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gnopernicus-prog">
        <term><command>gnopernicus</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="gnopernicus gnopernicus-prog">
            <primary sortas="b-gnopernicus">gnopernicus</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>