source: x/lib/webkitgtk.xml@ 9db393f1

<?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 webkitgtk-download-http "http://webkitgtk.org/releases/webkitgtk-&webkitgtk-version;.tar.xz">
  <!ENTITY webkitgtk-download-ftp  " ">
  <!ENTITY webkitgtk-md5sum        "28c930cda012391453c476cdacfaca65">
  <!ENTITY webkitgtk-size          "8.2 MB">
  <!ENTITY webkitgtk-buildsize     "800 MB">
  <!ENTITY webkitgtk-time          "55 SBU">
]>

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

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

  <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 the port of the
      portable web rendering engine <application>WebKit</application> to the
      <application>GTK+</application> platform.
    </para>

    &lfs72_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">WebKitGTK+ Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gperf"/>,
      <xref linkend="gst10-plugins-base"/> or
      <xref linkend="gst-plugins-base"/>,
      <xref linkend="gtk3"/> or
      <xref linkend="gtk2"/>,
      <xref linkend="icu"/>,
      <xref linkend="libxslt"/>,
      <xref linkend="libsoup"/>,
      <xref linkend="mesalib"/>,
      <xref linkend="ruby"/>,
      <xref linkend="sqlite"/> and
      <xref linkend="which"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="geoclue"/> and
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="curl"/>,
      <xref linkend="enchant"/>,
      <xref linkend="gtk-doc"/> 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>

    <warning>
      <para>
        If you are building <application>WebKitGTK+</application>
        with <command>make</command> 3.82, make sure that you have built
        it with the following
        <ulink url="&patch-downloads;/make/make-3.82-upstream_fixes-3.patch">
        patch</ulink> applied or <application>WebKitGTK+</application>
        build will fail.
      </para>
    </warning>

    <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>
      Install <application>WebKitGTK+</application> by running the
      following commands:
    </para>

<screen><userinput>./configure --prefix=/usr \
            --libexecdir=/usr/lib/WebKitGTK \
            --with-gstreamer=1.0 \
            --enable-introspection &amp;&amp;
make</userinput></screen>

    <para>
      This package does not have a working testsuite.
    </para>

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

<screen role="root"><userinput>make install</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>
      <parameter>--with-gstreamer=1.0</parameter>: This switch forces use of
      <application>GStreamer</application> 1.0 series which
      <application>GNOME</application> 3.6 uses. Remove if you don't want
      to install <application>GStreamer</application> 1.0 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>

    <para>
      <parameter>--with-gtk=2.0 --disable-webkit2</parameter>: These parameters
      force <application>WebKitGTK+</application> to compile against
      <application>GTK+ 2</application>, even if
      <application>GTK+ 3</application> is also installed. With
      <application>GTK+ 2</application>, everything
      <application>WebKitGTK+</application> installs is suffixed with 1.0. When it
      is compiled against <application>GTK+ 3</application> everything it
      installs is suffixed with 3.0. Both versions can be installed alongside
      one another with no namespace conflicts.
    </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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          jsc-1 or jsc-3
        </seg>
        <seg>
          libjavascriptcoregtk-1.0.so and libwebkit-1.0.so or
          libjavascriptcoregtk-3.0.so, libwebkit2gtk-3.0.so and
          libwebkit-3.0.so
        </seg>
        <seg>
          /usr/include/webkit-1.0 and /usr/share/webkit-1.0 or
          /usr/include/webkit-3.0, /usr/lib/WebKit and
          /usr/share/webkit-3.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-1</command> or <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="webkitgtk jsc">
            <primary sortas="b-jsc">jsc</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="webkitgtk libjavascriptcoregtk-1">
            <primary sortas="c-libjavascriptcoregtk-1">libjavascriptcoregtk-1.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="webkitgtk libwebkitgtk-1">
            <primary sortas="c-libwebkitgtk-1">libwebkitgtk-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="webkitgtk libjavascriptcoregtk-3">
            <primary sortas="c-libjavascriptcoregtk-3">libjavascriptcoregtk-3.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="webkitgtk 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="webkitgtk libwebkit2gtk-3">
            <primary sortas="c-libwebkit2gtk-3">libwebkit2gtk-3.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>