source: kde/kf5-apps/okular5.xml@ 39eac921

<?xml version="1.0" encoding="UTF-8"?>
<!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 "&kf5apps-download-http;/okular-&kf5apps-version;.tar.xz">
  <!ENTITY okular-download-ftp  " ">
  <!ENTITY okular-md5sum        "b2ced60d37221bf1c4693e529aa0429d">
  <!ENTITY okular-size          "8.2 MB">
  <!ENTITY okular-buildsize     "93 MB">
  <!ENTITY okular-time          "1.0 SBU (using parallelism=4)">
]>

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


  <title>Okular-&kf5apps-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, DjVu, DVI, XPS, and ePub.
    </para>

    &lfs121_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">Okular Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kf5-frameworks"/>
      <xref linkend="plasma-activities"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libkexiv2"/>,
      <xref linkend="libtiff"/>, and
      <xref linkend="poppler"/> (built with Qt6, required for PDF support)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="qca"/>,
      <ulink url="https://www.pell.portland.or.us/~orc/Code/discount/">discount</ulink>,
      <ulink url="https://djvu.sourceforge.net/">DjVuLibre</ulink>,
      <ulink url="https://libspectre.freedesktop.org/">libspectre</ulink>
      <ulink url="https://sourceforge.net/projects/ebook-tools">libepub</ulink>, and
      <ulink url="https://libzip.org">LibZip</ulink>
    </para>

  </sect2>

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

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

    <note>
      <para>
        If any of the optional dependencies are installed, remove the
        associated reference in the SKIP_OPTIONAL environment variable.
      </para>
    </note>

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

SKIP_OPTIONAL='Discount;DjVuLibre;EPub;LibSpectre;LibZip'

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -DFORCE_NOT_REQUIRED_DEPENDENCIES="$SKIP_OPTIONAL" \
      -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="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>
          okular
        </seg>
        <seg>
          Okular6Core.so
        </seg>
        <seg>
          $KF6_PREFIX/include/okular,
          $KF6_PREFIX/lib/cmake/Okular6,
          $KF6_PREFIX/lib/plugins/okular,
          $KF6_PREFIX/share/okular, and
          $KF6_PREFIX/share/doc/HTML/*/okular
        </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 a document viewer
          </para>
          <indexterm zone="okular okular-prog">
            <primary sortas="b-okular">okular</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>