source: kde/add/okular.xml@ 18c9ee54

<?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 okular-download-http "&kde-download-http;&kde-version;/src/okular-&kde-version;.tar.xz">
  <!ENTITY okular-download-ftp  "&kde-download-ftp;&kde-version;/src/okular-&kde-version;.tar.xz">
  <!ENTITY okular-md5sum        "af0bdfa2670e7e4494dafcb562886bf2">
  <!ENTITY okular-size          "1.5 MB">
  <!ENTITY okular-buildsize     "26 MB">
  <!ENTITY okular-time          "2.1 SBU">
]>

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

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

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

  <indexterm zone="okular">
    <primary sortas="a-okular">okular</primary>
  </indexterm>

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

    <para>Okular is a document viewer for KDE. It can view documents of many types
    including PDF, PostScript, TIFF, Microsoft CHM, DjVu, DVI, XPS and ePub.</para>

    &lfs74_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/okular-&kde-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">Okular Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
    <xref linkend="kactivities"/>,
    <xref linkend="freetype2"/>,
    <xref linkend="qimageblitz"/>,
    <xref linkend="libtiff"/>,
    <xref linkend="libjpeg"/>, and
    <xref linkend="poppler"/> (required for PDF support)
    </para>

    <note><para>For PDF support in <application>Okular</application> you need to
    configure <application>Poppler</application> using <option>--enable-xpdf-headers
    </option>.</para></note>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <ulink url="https://projects.kde.org/projects/extragear/base/plasma-mobile">ActiveApp</ulink>
      (for developing applications for Plasma Active),
      <ulink url="http://libspectre.freedesktop.org/">libspectre</ulink> (for PostScript support),
      <ulink url="http://www.jedrea.com/chmlib">libchm</ulink>,
      <ulink url="http://djvu.org/">DjVuLibre</ulink>, and
      <ulink url="http://sourceforge.net/projects/ebook-tools">libepub</ulink>

    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/okular"/>
    </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=&kde-dir; \
      -DCMAKE_BUILD_TYPE=Release         \
      .. &amp;&amp;
make</userinput></screen>

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

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

  </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 and several in &kde-dir;/lib/kde4</seg>
        <seg>&kde-dir;/include/okular and several in &kde-dir;/lib and
        &kde-dir;/share</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="okular-prog">
        <term><command>okular</command></term>
        <listitem>
          <para>is the KDE document viewer.</para>
          <indexterm zone="okular okular-prog">
            <primary sortas="b-okular">okular</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>