source: gnome/core/evince.xml@ ff53809

<?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 evince-download-http "&gnome-download-http;/evince/3.4/evince-&evince-version;.tar.xz">
  <!ENTITY evince-download-ftp  "&gnome-download-ftp;/evince/3.4/evince-&evince-version;.tar.xz">
  <!ENTITY evince-md5sum        "23c8a5eec7686d2bb607f9c8245ad242">
  <!ENTITY evince-size          "5.9 MB">
  <!ENTITY evince-buildsize     "90 MB">
  <!ENTITY evince-time          "3.7 SBU">
]>

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

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

  <title>Evince-&evince-version;</title>

  <indexterm zone="evince">
    <primary sortas="a-Evince">Evince</primary>
  </indexterm>

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

    <para>The <application>Evince</application> package contains a document
    viewer for multiple document formats. It currently supports PDF,
    Postscript, DjVu, TIFF and DVI. This is useful for viewing documents of
    various types using one simple application instead of the multiple document
    viewers that once existed on the GNOME Desktop.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gnome-doc-utils"/>,
      <xref linkend="gnome-icon-theme"/>,
      <xref linkend="gsettings-desktop-schemas"/> and
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Required (Runtime)</bridgehead>
    <para role="required">
      <xref linkend="shared-mime-info"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="libgnome-keyring"/>,
      <xref linkend="libgxps"/> (required for XPS support),
      <xref linkend="nautilus"/> (required for the Nautilus plugin),
      <xref linkend="poppler"/> (required for PDF support and must be built
      with <application>GTK+</application> support) and
      <xref linkend="rarian"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://djvulibre.djvuzone.org/">DjVuLibre</ulink>
      (required for DjVu graphics from <application>Evince</application>),
      <xref linkend="gtk-doc"/>,
      <ulink url="http://libspectre.freedesktop.org/wiki/">libspectre</ulink>
      (required for Postscript ability from <application>Evince</application>),
      <ulink url="http://www.sfr-fresh.com/linux/misc/t1lib">t1lib</ulink>
      (required for Type1 font support in the DVI viewer) and
      <xref linkend="texlive"/> (required to build the DVI viewer).
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/evince \
            --enable-introspection \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>The test suite for this package requires a functional
    <application>dogtail</application> installation. Requirements and
    download information can be found at
    <ulink url="http://people.redhat.com/zcerza/dogtail/"/>. The test suite
    is invoked by issuing <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>

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

    <para><parameter>--libexecdir=/usr/lib/evince</parameter>: This
    parameter is used so that the <application>Evince</application> internal
    support programs are installed in the preferred location of <filename
    class='directory'>/usr/lib/evince</filename> instead of <filename
    class='directory'>/usr/libexec</filename>.</para>

    <para><parameter>--enable-introspection</parameter>: By default, the
    gobject-introspection support is turned off, even though that package
    is an expected component of a <application>GNOME</application> system.
    The introspection support is, however, required if you intend to build
    <xref linkend="gnome-documents"/>, so it is enabled here.</para>

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

    <para><parameter>--without-keyring</parameter>: This parameter disables the
    use of <application>gnome-keyring</application>. Use this parameter if
    <application>libgnome-keyring</application> is not installed.</para>

    <para><parameter>--disable-nautilus</parameter>: This parameter disables the
    <application>Nautilus</application> Plugin. Add this parameter if
    <application>Nautilus</application> is not installed.</para>

    <para><parameter>--disable-pdf</parameter>: This parameter disables the PDF
    Backend. Add this parameter if <application>Poppler</application> is not
    installed.</para>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          evince, evince-previewer and evince-thumbnailer
        </seg>
        <seg>
          libevdocument3.so and libevview3.so
        </seg>
        <seg>
          /usr/include/evince, /usr/lib/evince, /usr/share/evince,
          /usr/share/gnome/help/evince and
          /usr/share/gtk-doc/html/{evince,libevdocument-3.0,libevview-3.0}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="evince-prog">
        <term><command>evince</command></term>
        <listitem>
          <para>is a multiple format document viewer.</para>
          <indexterm zone="evince evince-prog">
            <primary sortas="b-evince">evince</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="evince-previewer">
        <term><command>evince-previewer</command></term>
        <listitem>
          <para>is an applicaton that implements the printing preview.</para>
          <indexterm zone="evince evince-previewer">
            <primary sortas="b-evince-previewer">evince-previewer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="evince-thumbnailer">
        <term><command>evince-thumbnailer</command></term>
        <listitem>
          <para>is a simple program used to create thumbnail images of
          supported documents.</para>
          <indexterm zone="evince evince-thumbnailer">
            <primary sortas="b-evince-thumbnailer">evince-thumbnailer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>