source: gnome/applications/evince.xml@ 731c264

<?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-40;/evince-&evince-version;.tar.xz">
  <!ENTITY evince-download-ftp
     "&gnome-download-ftp;/evince/&gnome-40;/evince-&evince-version;.tar.xz">
  <!ENTITY evince-md5sum        "89b9c52d6fd03ffb244abc12a989d1ec">
  <!ENTITY evince-size          "2.8 MB">
  <!ENTITY evince-buildsize     "84 MB">
  <!ENTITY evince-time          "0.4 SBU (Using parallelism=4)">
]>

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

  <sect1info>
    <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>
      <application>Evince</application> is a document viewer for multiple
      document formats. It supports PDF, Postscript, DjVu, TIFF and DVI.
      It is useful for viewing documents of various types using one simple
      application instead of the multiple document viewers that once existed
      on the <application>GNOME</application> Desktop.
    </para>

    &lfs101_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="adwaita-icon-theme"/>,
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="itstool"/>,
      <xref linkend="libhandy1"/>,
      <xref linkend="libxml2"/>, and
      <xref linkend="openjpeg2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gnome-keyring"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="libarchive"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="nautilus"/> (to build the plugin), and
      <xref linkend="poppler"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="cups"/> (to enable printing if support is built into
      <application>GTK+ 3</application>),
      <xref linkend="gnome-desktop"/>,
      <xref linkend="gspell"/>,
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend="libgxps"/>,
      <xref linkend="libtiff"/>,
      <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
      <ulink url="http://djvu.sourceforge.net/">DjVuLibre</ulink>,
      <!--<ulink url="https://wiki.gnome.org/action/show/Projects/libgxps">libgxps</ulink>,-->
      <ulink url="http://www.freedesktop.org/wiki/Software/libspectre/">libspectre</ulink>,
      <ulink url="https://github.com/jlaurens/synctex">Synctex</ulink>, and
      <ulink url="https://www.t1lib.org/">t1lib</ulink>
    </para>

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

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

    <para>
      First, make sure that meson can find TeXLive if it is installed.
      This has no effect on systems without TeXLive installed.
    </para>

<screen><userinput remap="pre">export CPPFLAGS="-I/opt/texlive/&texlive-year;/include" &amp;&amp;
export LDFLAGS="$LDFLAGS -L/opt/texlive/&texlive-year;/lib"</userinput></screen>

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

<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr -Dgtk_doc=false -Dsystemduserunitdir=no .. &amp;&amp;
ninja</userinput></screen>

<screen revision="systemd"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson --prefix=/usr -Dgtk_doc=false .. &amp;&amp;
ninja</userinput></screen>

    <para>
      This package does not have a working testsuite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

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

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>
    <!--
    <para>
      <parameter>- -enable-compile-warnings=minimum</parameter>: This
      switch prevents a warning about a date format being treated as an error by
      <application>gcc-6.1</application>.
    </para>
    -->

    <para>
      <parameter>CPPFLAGS="..." LDFLAGS="$LDFLAGS ..."</parameter>: If
      <application>TeXLive</application> has been installed in
      <filename class="directory">/opt/texlive-&texlive-year;</filename> the
      configure script will find <filename class='libraryfile'>libkpathsea.so</filename>
      and enable the DVI backend, but without this addition the compile will fail
      because it cannot find the required headers. Adding this to a system where
      <application>TeXLive</application> has not been installed does not break the
      build.
    </para>

    <para>
      <parameter>-Dgtk_doc=false</parameter>: This switch disables generating
      the gtk-doc API reference documentation. If you have
      <xref role="nodep" linkend="gtk-doc"/> installed and wish to generate
      the API reference documentation, remove this switch.
    </para>

    <para>
      <option>-Dgspell=false</option>: This switch turns off support
      for the spell checking plugin.
    </para>

    <para>
      <option>-Dintrospection=false</option>: Use this option if you
      don't have <xref role="nodep" linkend="gobject-introspection"/> 
      installed and don't wish to have introspection support built into Evince.
    </para>

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

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

    <para>
      <option>-Dnautilus=false</option>: This switch disables building
      the <application>Nautilus</application> Plugin. Use this switch
      if <application>Nautilus</application> is not installed.
    </para>

    <para>
      <option>-Dkeyring=false</option>: This switch disables the use of
      <application>libsecret</application>. Use this switch
      if <application>libsecret</application> is not installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          evince, evince-previewer, and evince-thumbnailer
        </seg>
        <seg>
          libevdocument3.so,
          libevview3.so, and
          /usr/lib/nautilus/extensions-3.0/libevince-properties-page.so
        </seg>
        <seg>
          /usr/{include,lib,share}/evince,
          /usr/share/gtk-doc/html/{evince,libevdocument-3.0,libevview-3.0}, and
          /usr/share/help/*/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 previewer
          </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>