source: x/lib/webkitgtk.xml@ 13ab68e

<?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 webkitgtk-download-http "https://webkitgtk.org/releases/webkitgtk-&webkitgtk-version;.tar.xz">
  <!ENTITY webkitgtk-download-ftp  " ">
  <!ENTITY webkitgtk-md5sum        "46cf81df314acbf62f811bcfd99f4769">
  <!ENTITY webkitgtk-size          "36 MB">
  <!ENTITY webkitgtk-buildsize     "1.2 GB (159 MB installed, add 154 MB for GTK-4)">
  <!ENTITY webkitgtk-time          "29 SBU (for GTK-3, using parallelism=8, add 30 SBU for GTK-4)">

  <!ENTITY libbacktrace
    "<ulink url='https://github.com/ianlancetaylor/libbacktrace'>libbacktrace</ulink>">
]>

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


  <title>WebKitGTK-&webkitgtk-version;</title>

  <indexterm zone="webkitgtk">
    <primary sortas="a-WebKitGTK">WebKitGTK</primary>
  </indexterm>

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

    <para>
      The <application>WebKitGTK</application> package is a port of the
      portable web rendering engine <application>WebKit</application> to the
      <application>GTK+ 3</application> and <application>GTK 4</application>
      platforms.
    </para>

    &lfs121_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/webkitgtk-&webkitgtk-version;-upstream_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cairo"/>,
      <xref linkend="cmake"/>,
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="gst10-plugins-bad"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="gtk4"/>,
      <xref linkend="icu"/>,
      <xref linkend="lcms2"/>,
      <xref linkend="libgudev"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="libsoup3"/>,
      <xref linkend="libtasn1"/>,
      <xref linkend="libwebp"/>,
      <xref linkend="mesa"/>,
      <xref linkend="openjpeg2"/>,
      <xref linkend="ruby"/>,
      <xref linkend="sqlite"/>,
      <xref linkend="unifdef"/>, and
      <xref linkend="which"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="bubblewrap"/>,
      <xref linkend="enchant"/>,
      <xref linkend="geoclue2"/>,
      &gobject-introspection;,
      <xref linkend="hicolor-icon-theme"/>,
      <xref linkend="libavif"/>,
      <xref linkend="libjxl"/>,
      <xref linkend="libseccomp"/>, and
      <xref linkend="xdg-dbus-proxy"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gi-docgen"/>,
      <xref linkend="harfbuzz"/>,
      <xref linkend="wayland"/>,
      <xref linkend="woff2"/>,
      <ulink url="https://ccache.dev/">ccache</ulink>,
      <ulink url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>,
      &libbacktrace;, and
      <!--<ulink url="https://github.com/libjxl/libjxl">libjxl</ulink>, and-->
      <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
    </para>

  </sect2>

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

    <bridgehead renderas="sect3">Installation of
    <application>WebKitGTK</application></bridgehead>

    <important>
      <para>
        This package allows building with either GTK-3 or GTK-4, but not both
        in the same build. The GTK-4 version is needed for packages such as
        <xref linkend="epiphany"/>. Other packages, such as
        <xref linkend="balsa"/> or <xref linkend="evolution"/>, require the
        GTK-3 version. Both versions can be installed side by side on the
        same system. We give build instructions for both cases below, but
        the only difference is the setting of <command>-D USE_GTK4</command>
      </para>
    </important>

    <para>
      First, fix a regression that occurs with some websites that use
      WebAssembly: <!-- Ticket #20235 -->
    </para>

<screen><userinput remap="pre">sed '/returnLocation.isStackArgument/,/returnLocation = canonicalLocation/d'\
    -i Source/JavaScriptCore/wasm/WasmBBQJIT.cpp</userinput></screen>

    <para>
      If you want to install the GTK+-3 version of
      <application>WebKitGTK</application>, run the following commands:
    </para>

<screen revision="systemd"><userinput>mkdir -vp build &amp;&amp;
cd        build &amp;&amp;

cmake -D CMAKE_BUILD_TYPE=Release     \
      -D CMAKE_INSTALL_PREFIX=/usr    \
      -D CMAKE_SKIP_INSTALL_RPATH=ON  \
      -D PORT=GTK                     \
      -D LIB_INSTALL_DIR=/usr/lib     \
      -D USE_LIBBACKTRACE=OFF         \
      -D USE_LIBHYPHEN=OFF            \
      -D ENABLE_GAMEPAD=OFF           \
      -D ENABLE_MINIBROWSER=ON        \
      -D ENABLE_DOCUMENTATION=OFF     \
      -D ENABLE_WEBDRIVER=OFF         \
      -D USE_WOFF2=OFF                \
      -D USE_GTK4=OFF                 \
      -D ENABLE_BUBBLEWRAP_SANDBOX=ON \
      -W no-dev -G Ninja ..           &amp;&amp;
ninja</userinput></screen>

<screen revision="sysv"><userinput>mkdir -vp build &amp;&amp;
cd        build &amp;&amp;

cmake -D CMAKE_BUILD_TYPE=Release     \
      -D CMAKE_INSTALL_PREFIX=/usr    \
      -D CMAKE_SKIP_INSTALL_RPATH=ON  \
      -D PORT=GTK                     \
      -D LIB_INSTALL_DIR=/usr/lib     \
      -D USE_LIBBACKTRACE=OFF         \
      -D USE_LIBHYPHEN=OFF            \
      -D ENABLE_GAMEPAD=OFF           \
      -D ENABLE_MINIBROWSER=ON        \
      -D ENABLE_DOCUMENTATION=OFF     \
      -D ENABLE_WEBDRIVER=OFF         \
      -D USE_WOFF2=OFF                \
      -D USE_GTK4=OFF                 \
      -D ENABLE_JOURNALD_LOG=OFF      \
      -D ENABLE_BUBBLEWRAP_SANDBOX=ON \
      -W no-dev -G Ninja ..           &amp;&amp;
ninja</userinput></screen>

    <para>
      This package does not have a working test suite. However, there is a
      usable basic graphical web browser in the build directory,
      <application>build/bin/MiniBrowser</application>. If launching it fails,
      there is a problem with the build.
    </para>

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

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

    <para>
      If you want to install the GTK4 version of
      <application>WebKitGTK</application>, run the following commands:
    </para>

<screen revision="systemd"><userinput>rm -rf * .[^.]* &amp;&amp;

cmake -D CMAKE_BUILD_TYPE=Release     \
      -D CMAKE_INSTALL_PREFIX=/usr    \
      -D CMAKE_SKIP_INSTALL_RPATH=ON  \
      -D PORT=GTK                     \
      -D LIB_INSTALL_DIR=/usr/lib     \
      -D USE_LIBBACKTRACE=OFF         \
      -D USE_LIBHYPHEN=OFF            \
      -D ENABLE_GAMEPAD=OFF           \
      -D ENABLE_MINIBROWSER=ON        \
      -D ENABLE_DOCUMENTATION=OFF     \
      -D USE_WOFF2=OFF                \
      -D USE_GTK4=ON                  \
      -D ENABLE_BUBBLEWRAP_SANDBOX=ON \
      -W no-dev -G Ninja ..           &amp;&amp;
ninja</userinput></screen>

<screen revision="sysv"><userinput>rm -rf * .[^.]* &amp;&amp;

cmake -D CMAKE_BUILD_TYPE=Release     \
      -D CMAKE_INSTALL_PREFIX=/usr    \
      -D CMAKE_SKIP_INSTALL_RPATH=ON  \
      -D PORT=GTK                     \
      -D LIB_INSTALL_DIR=/usr/lib     \
      -D USE_LIBBACKTRACE=OFF         \
      -D USE_LIBHYPHEN=OFF            \
      -D ENABLE_GAMEPAD=OFF           \
      -D ENABLE_MINIBROWSER=ON        \
      -D ENABLE_DOCUMENTATION=OFF     \
      -D USE_WOFF2=OFF                \
      -D USE_GTK4=ON                  \
      -D ENABLE_JOURNALD_LOG=OFF      \
      -D ENABLE_BUBBLEWRAP_SANDBOX=ON \
      -W no-dev -G Ninja ..           &amp;&amp;
ninja</userinput></screen>

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

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

    <para>
      As the <option>-D ENABLE_DOCUMENTATION=OFF</option> option is used,
      the documentation is not rebuilt nor installed now.  If you need the
      documentation, you can either install <xref linkend='gi-docgen'/>
      and remove this option from the <command>cmake</command> command,
      or install the pre-built documentation (only for the GTK-4 version)
      instead:
    </para>

<screen role='root'><userinput>install -vdm755 /usr/share/gtk-doc/html &amp;&amp;
cp -rv ../Documentation/* /usr/share/gtk-doc/html</userinput></screen>

  </sect2>

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

<!--    <para>
      <command>sed ... TextCheckerEnchant.cpp</command>: This command
      is needed to allow the build to complete with enchant-2.x.
    </para> -->

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/cmake-skip-install-rpath.xml"/>

    <para>
      <parameter>-D USE_LIBBACKTRACE=OFF</parameter>: This switch disables
      the use of libbacktrace for dumping a stack trace when a crash
      happens.  You need to install &libbacktrace; if you wish to enable it
      (replacing OFF with ON or just removing the switch).
    </para>

    <para>
      <parameter>-D USE_LIBHYPHEN=OFF</parameter>: This switch disables the
      default automatic hyphenation implementation. You need to install
      <ulink
      url="https://sourceforge.net/projects/hunspell/files/Hyphen/">Hyphen</ulink>
      if you wish to enable it (replacing OFF with ON or just removing
      the switch).
    </para>

    <para>
      <parameter>-D ENABLE_DOCUMENTATION=OFF</parameter>: This switch disables
      regenerating the documentation. Remove this switch if you have
      <xref linkend="gi-docgen"/>
      installed and wish to regenerate the documentation.
    </para>

    <para>
      <parameter>-D ENABLE_GAMEPAD=OFF</parameter>: This switch disables
      gamepad support. Remove this switch if you have
      <ulink url="https://gnome.pages.gitlab.gnome.org/libmanette/">libmanette</ulink>
      installed and wish to enable it.
    </para>

    <para>
      <parameter>-D ENABLE_MINIBROWSER=ON</parameter>: This switch enables
      compiling and installing the MiniBrowser.
    </para>

    <para>
      <parameter>-D ENABLE_WEBDRIVER=OFF</parameter>: This switch disables
      compiling and installing <command>WebKitWebDriver</command>.  We use
      it for the GTK-3 build because the <command>WebKitWebDriver</command>
      from the GTK-3 build will be overwritten by the GTK-4 build anyway.
      Remove this option if you don't plan to build this package with
      GTK-4.
    </para>

<!--
    <para>
      <parameter>-D USE_JPEGXL=OFF</parameter>: This switch turns off support
      for JPEG-XL images. Remove it if you have the optional package
      <ulink url="https://github.com/libjxl/libjxl">libjxl</ulink> installed.
    </para>
-->
    <para>
      <parameter>-D ENABLE_BUBBLEWRAP_SANDBOX=ON</parameter>: This switch
      enables the Bubblewrap sandbox, which helps mitigate the impact of most
      security vulnerabilities in this package. Change this switch to OFF if
      you do not want to install <xref linkend="bubblewrap" role="nodep"/>,
      <xref linkend='libseccomp' role="nodep"/>, or
      <xref linkend="xdg-dbus-proxy" role="nodep"/>, but note that this may
      put you at risk.
      <!-- Note: This works well on both i686 and x86_64. -renodr -->
    </para>

    <para revision="sysv">
      <parameter>-D ENABLE_JOURNALD_LOG=OFF</parameter>: This switch disables using the
      systemd journal for logging errors and debugging information since it
      is not available on SysV systems.
    </para>

    <para>
      <option>-D USE_SYSTEM_MALLOC=ON</option>: This switch enables building
      against the system installed <application>malloc</application>.
    </para>

    <para>
      <option>-D ENABLE_GEOLOCATION=OFF</option>: Use this switch if you don't
      want to install <xref linkend="geoclue2"/>.
    </para>

    <para>
      <option>-D USE_AVIF=OFF</option>: Use this switch if you don't want to
      install <xref linkend="libavif"/>. Note that you will not have support
      for AVIF images if you do this.
    </para>

    <para>
      <option>-D USE_WOFF2=ON</option>: Use this switch if the optional
      package <xref linkend="woff2"/> is installed. This adds additional
      support for fonts.
    </para>

    <para>
      <option>-D USE_JPEGXL=OFF</option>: Use this switch if the recommended
      package <xref linkend="libjxl"/> is not installed. Note that you will not
      have support for JPEG XL images if this option is passed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
<!-- Moved to /usr/libexec/webkit2gtk-4.0, so shouldn't appear here
          jsc,
          MiniBrowser, and -->
          WebKitWebDriver
        </seg>
        <seg>
          libjavascriptcoregtk-4.1.so,
          libjavascriptcoregtk-6.0.so,
          libwebkit2gtk-4.1.so, and
          libwebkitgtk-6.0.so
        </seg>
        <seg>
          /usr/include/webkitgtk-4.1,
          /usr/include/webkitgtk-6.0,
          /usr/lib{,exec}/webkit2gtk-4.1,
          /usr/lib{,exec}/webkitgtk-6.0,
          /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-extension}}-4.1
          (optional), and
          /usr/share/gtk-doc/html/{jsc-glib,webkit2gtk{,-web-process-extension}}-6.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

<!--
      <varlistentry id="jsc">
        <term><command>jsc</command></term>
        <listitem>
          <para>
            is a command-line utility that allows you to run JavaScript programs
            outside of the context of a web browser.
          </para>
          <indexterm zone="webkitgtk jsc">
            <primary sortas="b-jsc">jsc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="MiniBrowser">
        <term><command>MiniBrowser</command></term>
        <listitem>
          <para>
            is a very simple graphical browser.
          </para>
          <indexterm zone="webkitgtk MiniBrowser">
            <primary sortas="b-MiniBrowser">MiniBrowser</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="WebKitWebDriver">
        <term><command>WebKitWebDriver</command></term>
        <listitem>
          <para>
            allows debugging and automation of web pages and browsers
          </para>
          <indexterm zone="webkitgtk WebKitWebDriver">
            <primary sortas="b-WebKitWebDriver">WebKitWebDriver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libjavascriptcoregtk-4.1">
        <term>
          <filename class="libraryfile">libjavascriptcoregtk-4.1.so</filename>
        </term>
        <listitem>
          <para>
            contains core JavaScript API functions used by
            <command>jsc</command> and
            <filename class="libraryfile">libwebkit2gtk-4.1</filename>
          </para>
          <indexterm zone="webkitgtk libjavascriptcoregtk-4.1">
            <primary sortas="c-libjavascriptcoregtk-4.1">libjavascriptcoregtk-4.1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libjavascriptcoregtk-6.0">
        <term><filename class="libraryfile">libjavascriptcoregtk-6.0.so</filename></term>
        <listitem>
          <para>
            contains core JavaScript API functions used by
            <command>jsc</command> and
            <filename class="libraryfile">libwebkitgtk-6.0</filename>
          </para>
          <indexterm zone="webkitgtk libjavascriptcoregtk-6.0">
            <primary sortas="c-libjavascriptcoregtk-6.0">libjavascriptcoregtk-6.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwebkit2gtk-4">
        <term><filename class="libraryfile">libwebkit2gtk-4.1.so</filename></term>
        <listitem>
          <para>
            contains the <application>WebKit2</application> API functions
          </para>
          <indexterm zone="webkitgtk libwebkit2gtk-4">
            <primary sortas="c-libwebkit2gtk-4">libwebkit2gtk-4.1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwebkitgtk-6">
        <term><filename class="libraryfile">libwebkitgtk-6.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>WebKit</application> API functions for
            GTK-4 applications
          </para>
          <indexterm zone="webkitgtk libwebkitgtk-6">
            <primary sortas="c-libwebkitgtk-6">libwebkitgtk-6.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>