aboutsummaryrefslogtreecommitdiffstats
path: root/kde/kf5-apps/okular5.xml
blob: 25d3e516d807e51bc24723ddefabac050caa971d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?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 okular5-download-http "&kf5apps-download-http;/okular-&kf5apps-version;.tar.xz">
  <!ENTITY okular5-download-ftp  " ">
  <!ENTITY okular5-md5sum        "6e1244b7145c0f7e22442bfd47777193">
  <!ENTITY okular5-size          "7.7 MB">
  <!ENTITY okular5-buildsize     "73 MB">
  <!ENTITY okular5-time          "0.8 SBU (using parallelism=4)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

  <indexterm zone="okular5">
    <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>

    &lfs101_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-frameworks"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="qca"/>,
      <ulink url="http://djvu.sourceforge.net/">DjVuLibre</ulink>,
      <ulink url="https://download.kde.org/stable/release-service/&kf5apps-version;/src/">
                 kpimtextedit</ulink>,
      <ulink url="http://libspectre.freedesktop.org/">libspectre</ulink> 
                 (for PostScript support),
      <ulink url="http://www.jedrea.com/chmlib">libchm</ulink>,
      <ulink url="https://sourceforge.net/projects/ebook-tools">libepub</ulink>, and
      <ulink url="https://projects.kde.org/projects/kde/kdegraphics/kdegraphics-mobipocket">
                 Mobipocket</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         \
      -DBUILD_TESTING=OFF                \
      -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>
          libOkular5Core.so
        </seg>
        <seg>
          $KF5_PREFIX/include/okular,
          $KF5_PREFIX/lib/cmake/Okular5,
          $KF5_PREFIX/lib/plugins/okular,
          $KF5_PREFIX/share/kxmlgui5/okular,
          $KF5_PREFIX/share/okular,
          $KF5_PREFIX/share/doc/HTML/*/okular, and
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>