source: gnome/add/gnome-mag.xml@ 75e85c0

<?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 gnome-mag-download-http "&gnome-download-http;/gnome-mag/0.16/gnome-mag-&gnome-mag-version;.tar.bz2">
  <!ENTITY gnome-mag-download-ftp  "&gnome-download-ftp;/gnome-mag/0.16/gnome-mag-&gnome-mag-version;.tar.bz2">
  <!ENTITY gnome-mag-md5sum        "bbe177dadfd64c071b5670956ed703ae">
  <!ENTITY gnome-mag-size          "534 KB">
  <!ENTITY gnome-mag-buildsize     "10 MB">
  <!ENTITY gnome-mag-time          "0.2 SBU">
]>

<sect1 id="gnome-mag" xreflabel="GNOME Magnifier-&gnome-mag-version;">
  <?dbhtml filename="gnome-mag.html"?>

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

  <title>GNOME Magnifier-&gnome-mag-version;</title>

  <indexterm zone="gnome-mag">
    <primary sortas="a-GNOME Magnifier">GNOME Magnifier</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Magnifier</title>

    <para>The <application>GNOME Magnifier</application> includes a screen
    magnifier, which allows you to zoom in on portions of the desktop. It is
    expressly designed for users with low vision who wish to use the
    <application>GNOME</application> desktop.</para>

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

    <bridgehead renderas="sect3">GNOME Magnifier Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="at-spi"/></para>

    <bridgehead renderas="sect4">Optional (to Build the Colorblind Applet)</bridgehead>
    <para role="optional"><xref linkend="gnome-desktop"/>,
    <ulink url="http://people.debian.org/~ruoso/">colorblind</ulink>,
    <xref linkend="pygtk"/> (including the gtk and gtk.libglade modules),
    <xref linkend="pyorbit"/>,
    <xref linkend="gnome-python"/> (including the gnome.ui module), and
    <xref linkend="gnome-python-desktop"/> (including the gnomeapplet
    module)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="doxygen"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Magnifier</title>

    <para>If <xref linkend="doxygen"/> is installed, the reference
    documentation is automatically generated. Install
    <application>GNOME Magnifier</application> by
    running the following commands:</para>

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; &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>

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

  </sect2>

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

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

      <seglistitem>
        <seg>magnifier</seg>
        <seg>libgnome-mag.so and GNOME_Magnifier_module.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/gnome-mag-1.0/magnifier,
        share/{doc/gnome-mag-0.16.1/reference/html,gnome-mag/{1_32,dbus},
        idl/gnome-mag-1.0}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="magnifier">
        <term><command>magnifier</command></term>
        <listitem>
          <para>is a screen zooming utility.</para>
          <indexterm zone="gnome-mag magnifier">
            <primary sortas="b-magnifier">magnifier</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgnome-mag">
        <term><filename class='libraryfile'>libgnome-mag.so</filename></term>
        <listitem>
          <para>contains the <application>GNOME Magnifier</application> API
          functions.</para>
          <indexterm zone="gnome-mag libgnome-mag">
            <primary sortas="c-libgnome-mag">libgnome-mag.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>