[ba0ff42b] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY falkon-download-http "https://download.kde.org/stable/falkon/&falkon-version;/falkon-&falkon-version;.tar.xz">
|
---|
| 8 | <!ENTITY falkon-download-ftp " ">
|
---|
| 9 | <!ENTITY falkon-md5sum "c6fb6433ac0f228667e2f763c02317c5">
|
---|
[cd3335ad] | 10 | <!ENTITY falkon-size "2.1 MB">
|
---|
| 11 | <!ENTITY falkon-buildsize "113 MB">
|
---|
| 12 | <!ENTITY falkon-time "1.2 SBU (Using parallelism=4)">
|
---|
[ba0ff42b] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="falkon" xreflabel="falkon-&falkon-version;">
|
---|
| 16 | <?dbhtml filename="falkon.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Falkon-&falkon-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="falkon">
|
---|
| 26 | <primary sortas="a-falkon">falkon</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to falkon</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>Falkon</application> is a KDE web browser using the QtWebEngine
|
---|
| 34 | rendering engine. It was previously known as <application>QupZilla</application>.
|
---|
| 35 | It aims to be a lightweight web browser available through all major platforms.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
| 38 | <para>
|
---|
| 39 | Although <application>falkon</application> is now part of KDE, it can be
|
---|
| 40 | installed without KDE (with the loss of <application>kwallet</application>
|
---|
| 41 | functionality, and of translations of the (not-installed) example
|
---|
| 42 | <command>hellopython.py</command> script).
|
---|
| 43 | </para>
|
---|
| 44 |
|
---|
[3cdb31d] | 45 | &lfs84_checked;
|
---|
[ba0ff42b] | 46 |
|
---|
| 47 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 48 | <itemizedlist spacing="compact">
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download (HTTP): <ulink url="&falkon-download-http;"/>
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download (FTP): <ulink url="&falkon-download-ftp;"/>
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download MD5 sum: &falkon-md5sum;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Download size: &falkon-size;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated disk space required: &falkon-buildsize;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | <listitem>
|
---|
| 75 | <para>
|
---|
| 76 | Estimated build time: &falkon-time;
|
---|
| 77 | </para>
|
---|
| 78 | </listitem>
|
---|
| 79 | </itemizedlist>
|
---|
| 80 |
|
---|
| 81 | <bridgehead renderas="sect3">falkon Dependencies</bridgehead>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 84 | <para role="required">
|
---|
| 85 | <xref linkend="extra-cmake-modules"/>,
|
---|
| 86 | <xref linkend="qtwebengine"/>
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 90 | <para role="optional">
|
---|
| 91 | <xref linkend="gnome-keyring"/>,
|
---|
| 92 | <xref linkend="kf5-frameworks"/>
|
---|
| 93 | (for ki18n if installing the translations of <command>hellopython.py</command>,
|
---|
| 94 | or for kwallet and its dependencies), and
|
---|
| 95 | <ulink
|
---|
| 96 | url="http://download.qt.io/official_releases/QtForPython/pyside2/">PySide2</ulink>
|
---|
| 97 | for experimental <application>Python</application> plugins (compiling this from
|
---|
| 98 | source is very slow).
|
---|
| 99 | </para>
|
---|
| 100 |
|
---|
| 101 | <para condition="html" role="usernotes">
|
---|
| 102 | User Notes: <ulink url="&blfs-wiki;/falkon"/>
|
---|
| 103 | </para>
|
---|
| 104 | </sect2>
|
---|
| 105 |
|
---|
| 106 | <sect2 role="installation">
|
---|
| 107 | <title>Installation of falkon</title>
|
---|
[cd3335ad] | 108 | <!--
|
---|
[ba0ff42b] | 109 | <para>
|
---|
| 110 | To set the prefix to match KDE (if that has been installed), or
|
---|
| 111 | else to install in <filename class="directory">/usr</filename>
|
---|
| 112 | run:
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <screen><userinput>test -n "${KF5_PREFIX}" && export FALKON_PREFIX=${KF5_PREFIX} ||
|
---|
| 116 | export FALKON_PREFIX=/usr</userinput></screen>
|
---|
[cd3335ad] | 117 | -->
|
---|
[ba0ff42b] | 118 | <para>
|
---|
| 119 | Install <application>falkon</application> by running the following
|
---|
| 120 | commands:
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
| 123 | <para>
|
---|
| 124 | Unless you have installed both PySide2 and ki18n, remove the translations
|
---|
| 125 | for the sample <command>hellopython.py</command> script:
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <screen><userinput>rm -rf po/</userinput></screen>
|
---|
| 129 |
|
---|
[55a55f1] | 130 | <!--<para>
|
---|
[ba0ff42b] | 131 | In case you wish to run the tests, fix one of them so that it will
|
---|
| 132 | work correctly with both Qt-5.10 and Qt-5.11:
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
| 135 | <screen><userinput>sed -i 's/"5.11.", 5) == 0 ? 1 : 2/"5.10.", 5) >= 0 ? 2 : 1/' \
|
---|
[55a55f1] | 136 | autotests/webviewtest.cpp</userinput></screen>-->
|
---|
[ba0ff42b] | 137 |
|
---|
| 138 | <para>
|
---|
| 139 | Now build the program:
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
[cd3335ad] | 142 | <screen><userinput>mkdir build &&
|
---|
| 143 | cd build &&
|
---|
| 144 |
|
---|
| 145 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 146 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 147 | .. &&
|
---|
| 148 |
|
---|
[ba0ff42b] | 149 | make</userinput></screen>
|
---|
| 150 |
|
---|
| 151 | <para>
|
---|
| 152 | To test the results, issue: <command>make test</command>. All
|
---|
| 153 | tests should pass. If any fail, the full results will be in
|
---|
| 154 | <filename>Testing/Temporary/LastTest.log</filename>.
|
---|
| 155 | </para>
|
---|
| 156 |
|
---|
| 157 | <para>
|
---|
| 158 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 159 | </para>
|
---|
| 160 |
|
---|
| 161 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 162 |
|
---|
| 163 | <para>
|
---|
| 164 | If you have installed <application>Pyside2</application> you will want to
|
---|
| 165 | examine the <command>hellopython.py</command> which is in the <filename
|
---|
| 166 | class="directory">scripts/</filename> directory, and perhaps copy it to
|
---|
| 167 | your home directory.
|
---|
| 168 | </para>
|
---|
| 169 |
|
---|
| 170 | </sect2>
|
---|
| 171 |
|
---|
| 172 | <sect2 role="commands">
|
---|
| 173 | <title>Command Explanations</title>
|
---|
| 174 |
|
---|
[55a55f1] | 175 | <!--<para>
|
---|
[ba0ff42b] | 176 | <command>sed -i 's/"5.11.", 5) == 0 ? 1 : 2/"5.10.", 5) >= 0 ? 2 : 1/' ...</command>:
|
---|
| 177 | This test previously looked for QtWebengine-5.10 which had changed its
|
---|
| 178 | result compared to earlier versions. In the move to Qt-5.11 the version
|
---|
| 179 | was bumped but the results were swapped. Change it to examine if the version
|
---|
| 180 | is <emphasis>at least 5.10</emphasis>, and to swap the expected results back.
|
---|
[55a55f1] | 181 | </para>-->
|
---|
[ba0ff42b] | 182 |
|
---|
[91e1961f] | 183 | <para>
|
---|
[55a55f1] | 184 | <option>-DBUILD_TESTING=OFF</option>: This will save a little time and space by
|
---|
[91e1961f] | 185 | not building the test programs, use this if you do not wish to run the test.
|
---|
| 186 | </para>
|
---|
| 187 |
|
---|
[ba0ff42b] | 188 | </sect2>
|
---|
| 189 |
|
---|
| 190 | <sect2 role="content">
|
---|
| 191 | <title>Contents</title>
|
---|
| 192 |
|
---|
| 193 | <segmentedlist>
|
---|
| 194 | <segtitle>Installed Programs</segtitle>
|
---|
| 195 | <segtitle>Installed Library</segtitle>
|
---|
| 196 | <segtitle>Installed Directory</segtitle>
|
---|
| 197 |
|
---|
| 198 | <seglistitem>
|
---|
| 199 | <seg>
|
---|
| 200 | falkon
|
---|
| 201 | </seg>
|
---|
| 202 | <seg>
|
---|
| 203 | libFalkonPrivate.so.3
|
---|
| 204 | </seg>
|
---|
| 205 | <seg>
|
---|
| 206 | ${FALKON_PREFIX}/lib/plugins, ${FALKON_PREFIX}/share/falkon.
|
---|
| 207 | </seg>
|
---|
| 208 | </seglistitem>
|
---|
| 209 | </segmentedlist>
|
---|
| 210 |
|
---|
| 211 | <variablelist>
|
---|
| 212 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 213 | <?dbfo list-presentation="list"?>
|
---|
| 214 | <?dbhtml list-presentation="table"?>
|
---|
| 215 |
|
---|
| 216 | <varlistentry id="falkon-prog">
|
---|
| 217 | <term><command>falkon</command></term>
|
---|
| 218 | <listitem>
|
---|
| 219 | <para>
|
---|
| 220 | is a web browser which uses qtwebengine.
|
---|
| 221 | </para>
|
---|
| 222 | <indexterm zone="falkon falkon-prog">
|
---|
| 223 | <primary sortas="b-falkon">falkon</primary>
|
---|
| 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
| 227 |
|
---|
| 228 | <varlistentry id="libFalkonPrivate.so.3">
|
---|
| 229 | <term><filename class="libraryfile">libFalkonPrivate.so.3</filename></term>
|
---|
| 230 | <listitem>
|
---|
| 231 | <para>
|
---|
| 232 | contains functions used by falkon.
|
---|
| 233 | </para>
|
---|
| 234 | <indexterm zone="falkon libFalkonPrivate.so.3">
|
---|
| 235 | <primary sortas="c-libFalkonPrivate.so.3">libFalkonPrivate.so.3</primary>
|
---|
| 236 | </indexterm>
|
---|
| 237 | </listitem>
|
---|
| 238 | </varlistentry>
|
---|
| 239 | </variablelist>
|
---|
| 240 | </sect2>
|
---|
| 241 | </sect1>
|
---|