source: xsoft/graphweb/falkon.xml@ 0bcf4d1

<?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 falkon-download-http "https://download.kde.org/stable/falkon/&falkon-major-version;/falkon-&falkon-version;.tar.xz">
  <!ENTITY falkon-download-ftp  " ">
  <!ENTITY falkon-md5sum        "8733affc1d98770f4be1c9f587ad29b0">
  <!ENTITY falkon-size          "2.4 MB">
  <!ENTITY falkon-buildsize     "162 MB (without optional dependencies)">
  <!ENTITY falkon-time          "1.4 SBU (Using parallelism=4)">
]>

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

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

  <title>Falkon-&falkon-version;</title>

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

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

    <para>
      <application>Falkon</application> is a KDE web browser using the QtWebEngine
      rendering engine. It was previously known as <application>QupZilla</application>.
      It aims to be a lightweight web browser available through all major platforms.
    </para>

    <para>
      Although <application>falkon</application> is now part of KDE, it can be
      installed without KDE (with the loss of <application>kwallet</application>
      functionality).
    </para>

    <warning>
      <para>
        Falkon relies on QtWebEngine. That uses a forked copy of chromium, and
        is therefore vulnerable to many issues found there. The Qt developers
        have always preferred to make releases at the same time as the rest of Qt
        (rather than adding emergency fixes). Now that they are keen to move to
        Qt6, the 5.15.3 and later Qt-5.15 releases are initially only available
        to paying customers. QtWebEngine is something of an exception because of
        its LGPL licence, but getting the git sources (with the forked chromium
        submodule) to a point where they will successfully build on a current
        BLFS system can take a lot of effort. Be aware that future fixes for
        vulnerabilities might be very delayed, to the extent that you might wish
        to consider using a different browser.
      </para>
    </warning>

    &lfs110a_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="extra-cmake-modules"/> and
      <xref linkend="qtwebengine"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gnome-keyring"/>,
      <xref linkend="kf5-frameworks"/> and
      <ulink
      url="http://download.qt.io/official_releases/QtForPython/pyside2/">PySide2</ulink>
      for experimental <application>Python</application> plugins (compiling this from
      source is very slow).
    </para>

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

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

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

    <para>
      Unless you have installed both PySide2 and ki18n, remove the translations
      for the sample <command>hellopython.py</command> script:
    </para>

<screen><userinput>rm -rf po/</userinput></screen>
<!--
    <para>
      Fix a missing include in Qt-5.14:
    </para>

<screen><userinput>sed -i '/#include &lt;QSettings&gt;/a#include &lt;QFile&gt;' \
   src/plugins/VerticalTabs/verticaltabsplugin.cpp</userinput></screen>

    <para>
      Fix a build problem introduced in Qt-5.15:
    </para>
<screen><userinput remap="pre">sed -i '/#include &lt;QPainter&gt;/a #include &lt;QPainterPath&gt;' \
   src/lib/tools/qztools.cpp</userinput></screen>
-->
    <para>
      Now build the program:
    </para>

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &amp;&amp;

make</userinput></screen>

    <para>
      To test the results, issue: <command>make test</command>. All
      tests should pass. If any fail, the full results will be in
      <filename>Testing/Temporary/LastTest.log</filename>.
    </para>

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

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

    <para>
      If you have installed <application>Pyside2</application> you will want to
      examine the <command>hellopython.py</command> which is in the <filename
      class="directory">scripts/</filename> directory, and perhaps copy it to
      your home directory.
    </para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>-DBUILD_TESTING=OFF</option>: This will save a little time and space by
      not building the test programs, use this if you do not wish to run the test.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          falkon
        </seg>
        <seg>
          libFalkonPrivate.so.3
        </seg>
        <seg>
          ${FALKON_PREFIX}/lib/plugins, ${FALKON_PREFIX}/share/falkon.
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="falkon-prog">
        <term><command>falkon</command></term>
        <listitem>
          <para>
            is a web browser which uses qtwebengine
          </para>
          <indexterm zone="falkon falkon-prog">
            <primary sortas="b-falkon">falkon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libFalkonPrivate.so.3">
        <term><filename class="libraryfile">libFalkonPrivate.so.3</filename></term>
        <listitem>
          <para>
            contains functions used by falkon
          </para>
          <indexterm zone="falkon libFalkonPrivate.so.3">
            <primary sortas="c-libFalkonPrivate.so.3">libFalkonPrivate.so.3</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>