source: x/lib/webkitgtk2.xml@ 5e11bc38

<?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 webkitgtk2-download-http "http://webkitgtk.org/releases/webkitgtk-&webkitgtk2-version;.tar.xz">
  <!ENTITY webkitgtk2-download-ftp  " ">
  <!ENTITY webkitgtk2-md5sum        "c2e1687bb0314a0948fbf78e2d1e931f">
  <!ENTITY webkitgtk2-size          "9.4 MB">
  <!ENTITY webkitgtk2-buildsize     "1.5 GB (both built)">
  <!ENTITY webkitgtk2-time          "138 SBU (both built, webkitgtk-3.0 takes a little longer than webkitgtk-1.0)">
]>

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

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

  <title>WebKitGTK+-&webkitgtk2-version;</title>

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

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

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

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gst10-plugins-base"/>,
      <xref linkend="gtk2"/> or
      <xref linkend="gtk3"/>,
      <xref linkend="icu"/>,
      <xref linkend="libsecret"/>,
      <xref linkend="libsoup"/>,
      <xref linkend="libwebp"/>,
      <xref linkend="mesalib"/>,
      <xref linkend="ruby"/>,
      <xref linkend="sqlite"/>,
      <xref linkend="udev-extras"/> (for GUdev) and
      <xref linkend="which"/>
    </para>

    <note><para>
      WebKit2 links against GTK+ 2 (even if GTK+ 3 is being used), in order to
      be able to use NPAPI plugins such as Adobe Flash.
    </para></note>


    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="enchant"/>,
      <xref linkend="geoclue"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="hicolor-icon-theme"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <xref linkend="harfbuzz"/>,
      <xref linkend="llvm"/>,
      <ulink url="http://gitorious.org/geoclue2/">GeoClue2</ulink>, and
      <ulink url="http://xsltml.sourceforge.net/">MathML</ulink>
    </para>

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

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

    <para>
      If you have not installed <xref linkend="gtk-doc"/>, fix a bug that will
      cause <command>make install</command> to fail:
    </para>

<screen><userinput>sed -i '/generate-gtkdoc --rebase/s:^:# :' \
                           GNUmakefile.in</userinput></screen>

    <para>
      Upstream standard now is to link this package against GTK+ 3. However,
      for backward compatibility, manu users need also another instance, linked
      to GTK+ 2. Both can be installed in the same system, without problem.
      However, some packages can alternatively be linked to either one. Here,
      both build methods are presented and recommended to be built, but if you
      know which one you need, just jump to the respective part. 
    </para>

<!-- ==== WebKitGTK+ against GTK+ 3 ====== -->
    <bridgehead renderas="sect3">Build and install WebKitGTK+ against
      GTK+ 3</bridgehead>

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

<screen><userinput>mkdir -vp build-3           &amp;&amp;
cp -a Documentation build-3 &amp;&amp;
cd build-3                  &amp;&amp;


../configure --prefix=/usr --enable-introspection &amp;&amp;
make</userinput></screen>

    <para>
      This package does not have a working testsuite. However, there are two
      useable basic graphical web browsers in the build directory,
      <application>Programs/GtkLauncher</application> and
      <application>Programs/MiniBrowser</application>. If launching any one
      fails, there is a problem with the build.
    </para>

    <note><para>
      When installing, the Makefile does some additional compiling and linking.
      If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
      variables need to be defined for the root user.  If using sudo to assume
      root, use the -E option to pass your current environment variables for the
      install process.
    </para></note>

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

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

    <para>
      Finally, leave the buid directory:
    </para>

<screen><userinput>cd ..</userinput></screen>

<!-- ==== WebKitGTK+ against GTK+ 2 ====== -->
    <bridgehead renderas="sect3">Build and install WebKitGTK+ against
      GTK+ 2</bridgehead>

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

<screen><userinput>mkdir -vp build-1</userinput></screen>

    <para>
      If you have built and installed the package against GTK+ 3, skip the
      following command, because the previous docummentation also applies here:
    </para>

<screen><userinput>cp -a Documentation build-1</userinput></screen>

    <para>
      Now, change into the build directory and effectively start the build and
      install:
    </para>

<screen><userinput>cd build-1 &amp;&amp;


../configure --prefix=/usr --with-gtk=2.0 --disable-webkit2 &amp;&amp;
make</userinput></screen>

    <para>
      This package does not have a working testsuite. However, there is one
      useable basic graphical web browser in the build directory,
      <application>Programs/GtkLauncher</application>. If launching it
      fails, there is a problem with the build.
    </para>

    <note><para>
      When installing, the Makefile does some additional compiling and linking.
      If you do not have Xorg in /usr, the LIBRARY_PATH and PKG_CONFIG_PATH
      variables need to be defined for the root user.  If using sudo to assume
      root, use the -E option to pass your current environment variables for the
      install process.
    </para></note>

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

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

    <para>
      Finally, leave the buid directory:
    </para>

<screen><userinput>cd ..</userinput></screen>

  </sect2>

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

    <para>
      <option>--enable-introspection</option>: This switch enables support for
      <application>Gobject Introspection</application> and is required for a
      <application>GNOME</application> Desktop. Remove if you don't have
      <application>Gobject Introspection</application> installed or you don't
      want to install <application>GNOME</application>.
    </para>

    <para>
      <option>--disable-geolocation</option>: Use this option if you did not
      install <xref linkend="geoclue"/> or <command>configure</command> will
      fail.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          jsc-1, and jsc-3
        </seg>
        <seg>
          libjavascriptcoregtk-1.0.so,
          libjavascriptcoregtk-3.0.so,
          libwebkit2gtk-3.0.so,
          libwebkitgtk-1.0.so,
          libwebkitgtk-3.0.so, and
          webkit2gtk-3.0/injected-bundle/libwebkit2gtkinjectedbundle.so
        </seg>
        <seg>
          /usr/include/webkitgtk-1.0,
          /usr/include/webkitgtk-3.0,
          /usr/lib/webkit2gtk-3.0,
          /usr/share/gtk-doc/html/webkit2gtk,
          /usr/share/gtk-doc/html/webkitdomgtk,
          /usr/share/gtk-doc/html/webkitgtk,
          /usr/share/webkitgtk-1.0, and
          /usr/share/webkitgtk-3.0
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="jsc-1">
        <term><command>jsc-1</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="webkitgtk2 jsc-1">
            <primary sortas="b-jsc-1">jsc-1</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jsc-3">
        <term><command>jsc-3</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="webkitgtk2 jsc-3">
            <primary sortas="b-jsc-3">jsc-3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

      <varlistentry id="libwebkitgtk-1">
        <term><filename class="libraryfile">libwebkitgtk-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>WebKitGTK+</application> API functions for
            <application>GTK+ 2</application>.
          </para>
          <indexterm zone="webkitgtk2 libwebkitgtk-1">
            <primary sortas="c-libwebkitgtk-1">libwebkitgtk-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libwebkitgtk-3">
        <term><filename class="libraryfile">libwebkitgtk-3.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>WebKitGTK+</application> API functions for
            <application>GTK+ 3</application>.
          </para>
          <indexterm zone="webkitgtk2 libwebkitgtk-3">
            <primary sortas="c-libwebkitgtk-3">libwebkitgtk-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>