source: gnome/add/evince.xml@ f1e103a

<?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/&gnome-version;/evince-&evince-version;.tar.bz2">
  <!ENTITY evince-download-ftp  "&gnome-download-ftp;/evince/&gnome-version;/evince-&evince-version;.tar.bz2">
  <!ENTITY evince-md5sum        "2ae7fe7da797a9f08f2dd1ba4cbdeeae">
  <!ENTITY evince-size          "2.1 MB">
  <!ENTITY evince-buildsize     "53 MB">
  <!ENTITY evince-time          "1.3 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>

    &lfs65_built;

    <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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/evince-&evince-version;-t1lib-1.patch"/></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="gtk2"/>, and
    <xref linkend="which"/></para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="GConf"/>,
    <xref linkend="libgnome-keyring"/>,
    <xref linkend="gtk-doc"/>,
    <xref linkend="libtiff"/>,
    <xref linkend="tetex"/> or <xref linkend="texlive"/> (required to build the DVI viewer),
    <xref linkend="nautilus"/>
      (required to build the <application>Nautilus</application> plugin),
    <xref linkend="poppler"/> (required for PDF support and must be built
      with <application>GTK+</application> support),
    <ulink url="http://libspectre.freedesktop.org/wiki/">libspectre</ulink>
    (required for Postscript ability from <application>Evince</application>),
    <ulink url="http://djvulibre.djvuzone.org/">DjVuLibre</ulink>
    (required for DjVu graphics from <application>Evince</application>), and
    <ulink url="http://www.sfr-fresh.com/linux/misc/t1lib">t1lib</ulink>
    (required for Type1 font support in 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=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib \
            --libexecdir=$(pkg-config \
                --variable=prefix ORBit-2.0)/lib/evince \
            --mandir=$(pkg-config \
                --variable=prefix ORBit-2.0)/share/man \
            --enable-pixbuf \
            --without-keyring \
            --without-gconf \
            --disable-nautilus \
            --disable-pdf &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"/>

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

    <para><parameter>--libexecdir=$(pkg-config --variable=prefix
    ORBit-2.0)/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'>$GNOME_PREFIX/lib/evince</filename> instead of <filename
    class='directory'>$GNOME_PREFIX/libexec</filename>.</para>

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

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

    <para><parameter>--enable-pixbuf</parameter>: This parameter enables the
    Pixbuf Backend.</para>

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

    <para><parameter>--without-gconf</parameter>: This parameter disables
    <application>GConf</application> Support. Remove parameter if
    <application>GConf</application> is installed.</para>

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

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

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

    <para><option>--enable-introspection</option>: Use this parameter if you
    have the <application>gobject-introspection</application> package installed
    and you wish to enable GObject introspection.</para>

    <para><option>--enable-impress</option>: Use this parameter if you wish to
    compile with support for impress presentations.</para>

    <para><option>--enable-dvi</option>: Use this parameter if you have the
    <application>teTeX</application> or <application>TeX Live</application>
    package installed and you wish to build support to view DVI files.</para>

    <para><option>--enable-t1lib</option>: Use this parameter if you have the
    <application>t1lib</application> package installed and you wish to build
    support for Type1 fonts in the DVI viewer.</para>

  </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, evince-thumbnailer,
        evince-convert-metadata, and evinced</seg>
        <seg>libcomicsdocument.{so,a}, libpdfdocument.{so,a},
        libpixbufdocument.{so,a}, libtiffdocument.{so,a}, libevdocument.{so,a},
        libevview.{so,a}, and libevince-properties-page.{so,a}</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/evince/&gnome-version;/{libdocument,
        libview},lib/evince/2/backends,
        share/{evince/icons/hicolor/{16x16/{actions,mimetypes},22x22/{actions,
        mimetypes},24x24/{actions,mimetypes},32x32/{actions,mimetypes},
        48x48/actions,scalable/{actions,mimetypes}},gnome/help/evince/*,
        gtk-doc/html/{evince,libevdocument-&gnome-version;,
        libevview-&gnome-version;},omf/evince}}</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>