source: kde5/applications/okular.xml@ d8aa38f0

<?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;
]>

<sect1 id="okular5" xreflabel="Okular-&okular5-version;">
  <?dbhtml filename="okular.html"?>

  <sect1info>
    <othername>$LastChangedBy: krejzi $</othername>
    <date>$Date: 2014-10-25 18:13:26 +0200 (Sat, 25 Oct 2014) $</date>
  </sect1info>

  <title>Okular-&okular5-version;</title>

  <indexterm zone="okular5">
    <primary sortas="a-Okular">Okular</primary>
  </indexterm>

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

    <para>
      The <application>Okular</application> package contains a document
      viewer for the <application>KDE Plasma</application> Desktop. It
      supports many document types, including PDF, PostScript, TIFF,
      Microsoft CHM, DjVu, DVI, XPS and ePub. 
    </para>

    &lfs77_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kf5"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libkexiv25"/>,
      <xref linkend="libkscreen"/>,
      <xref linkend="libtiff"/> and
      <xref linkend="poppler"/> (with Qt5 library)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="http://www.jedrea.com/chmlib/">CHMLib</ulink>,
      <ulink url="http://djvu.sourceforge.net/">DJVuLibre</ulink>,
      <ulink url="http://sourceforge.net/projects/ebook-tools/">EBook-Tools</ulink>,
      <ulink url="http://www.freedesktop.org/wiki/Software/libspectre/">libspectre</ulink> and
      <ulink url="http://quickgit.kde.org/qca.git">QCA (Qt5 version)</ulink>
    </para>

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

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DLIB_INSTALL_DIR=lib              \
      -DBUILD_TESTING=OFF                \
      -DQT_PLUGIN_INSTALL_DIR=&qt5-plugins-dir; \
      -Wno-dev .. &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/cmake-release.xml"/>

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

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          okular
        </seg>
        <seg>
          libokularcore.so
        </seg>
        <seg>
          $KF5_PREFIX/include/okular,
          $KF5_PREFIX/lib/cmake/Okular,
          $KF5_PREFIX/share/doc/HTML/*/okular,
          $KF5_PREFIX/share/kxmlgui5/okular and
          $KF5_PREFIX/share/okular
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>