source: lxqt/apps/qupzilla.xml@ 20e1589

<?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 qupzilla-download-http "https://github.com/QupZilla/qupzilla/archive/v&qupzilla-version;.tar.gz">
  <!ENTITY qupzilla-download-ftp  " ">
  <!ENTITY qupzilla-md5sum        "e80ad1b6e26212f3d43908c2ad87ba4d">
  <!ENTITY qupzilla-size          "4.5 MB">
  <!ENTITY qupzilla-buildsize     "79 MB">
  <!ENTITY qupzilla-time          "3.1 SBU">
]>

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

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

  <title>QupZilla-&qupzilla-version;</title>

  <indexterm zone="qupzilla">
    <primary sortas="a-QupZilla">QupZilla</primary>
  </indexterm>

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

    <para>
      <application>QupZilla</application> is a fast
       <application>QtWebKit</application> browser. It aims to be a lightweight
       web browser available through all major platforms. It has been
       originally started only for educational purposes. But from its start,
       <application>QupZilla</application> has grown into a feature-rich
       browser.
    </para>

    &lfs77_checked; &gcc5_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>


    <note>
      <para>
        Notice that v&qupzilla-version;.tar.gz is the downloaded file name.
        This was obtained by compressing a directory named <filename
        class="directory">qupzilla-&qupzilla-version;</filename>. This is not
        convenient. It is better to rename the file to
        <filename>qupzilla-&qupzilla-version;.tar.gz</filename>.
        Alternatively, you can do it automatically, downloading with the
        command <command>wget ... -O
        <filename>qupzilla-&qupzilla-version;.tar.gz</filename></command>.
      </para>
    </note>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>
      <xref linkend="openssl"/>, and
      <xref linkend="qt5"/> or
      <xref linkend="qt4"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gdb"/>,
      <xref linkend="kdelibs"/> (KWallet plugin),
      <ulink url="http://hunspell.sourceforge.net/">Hunspell</ulink>, and
      <ulink url="&gnome-download-ftp;/libgnome-keyring/">libgnome-keyring</ulink> (Gnome-Keyring plugin)
    </para>

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

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

    <para>
      The following fixes are needed, if building with <application>Qt5</application>:
    </para>

<screen><userinput>sed -e '/qtlocalpeer/ i #include &lt;QDataStream&gt;'             \
    -i src/lib/3rdparty/qtsingleapplication/qtlocalpeer.cpp &amp;&amp;

sed -e '/QHash/ i #include &lt;QObject&gt;'                     \
    -i src/plugins/TabManager/tldextractor/tldextractor.h</userinput></screen>

    <para>
      If <application>Qt4</application> and <application>Qt5</application> are
      installed, choose which one you prefer, by running <command>source
      setqt4</command> or <command>source setqt5</command>, respectivelly.
    </para>

    <para>
      The next commands are used for the build configuration and for fixing
      the submenu in the Desktop Environment. Alternatively, you can add each
      environmet variable, one at a line, to
      <filename>src/defines.pri</filename>.
    </para>

<screen><userinput>export QUPZILLA_PREFIX=/usr \
       USE_WEBGL=true       &amp;&amp;

sed -e 's/^TargetEnvironment/#&amp;/'              \
    -e 's/Categories=/&amp;Application;Internet;/' \
    -i  linux/applications/qupzilla.desktop</userinput></screen>

    <para>
      The choice of <filename class="directory">/usr</filename> for prefix is
      due to the general characteristics of this program, which can be used
      without <application>LXQt</application>.
    </para>

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

<screen><userinput>qmake</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>

    <para>
      If <xref linkend="desktop-file-utils"/> and <xref linkend="xdg-utils"/>
      are installed, run as, the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>xdg-icon-resource forceupdate --theme hicolor &amp;&amp;
update-desktop-database -q</userinput></screen>

  </sect2>

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

    <para>
      <command>sed ... -i  linux/applications/qupzilla.desktop</command>:
      Fixes location in some Desktop Environment submenu.
    </para>

    <note>
      <para>
        Following variables need to be exported. You can add them to the
        <command>export</command> block in the main instructions.
        Alternatively, instead of exporting, they can be added, one at a line,
        to <filename>src/defines.pri</filename>.
      </para>
    </note>

    <para>
      <envar>CONFIG += debug</envar>: Use if you want to build QupZilla with
      debugging symbols.
    </para>

    <para>
      <envar>GNOME_INTEGRATION=true</envar>: Enable Gnome integration, this
      meaning the build of Gnome-Keyring Password plugin, which provides
      support for storing passwords in Gnome-Keyring.
    </para>

    <para>
      <envar>KDE_INTEGRATION=true</envar>: Enable KDE integration, this
      meaning the build of KWallet Password plugin, which provides support for
      storing passwords in KWallet.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          qupzilla
        </seg>
        <seg>
          libQupZilla.so and plugins under /usr/lib/qupzilla/
        </seg>
        <seg>
          /usr/{lib,share}/qupzilla
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="qupzilla-prog">
        <term><command>qupzilla</command></term>
        <listitem>
          <para>
            is a lightweight <application>QtWebKit</application> web browser.
          </para>
          <indexterm zone="qupzilla qupzilla-prog">
            <primary sortas="b-qupzilla">qupzilla</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libQupZilla">
        <term><filename class="libraryfile">libQupZilla.so</filename></term>
        <listitem>
          <para>
            contains the <application>libQupZilla</application> API functions.
          </para>
          <indexterm zone="qupzilla libQupZilla">
            <primary sortas="c-libQupZilla">libQupZilla.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>