source: x/lib/webkitgtk2.xml@ 827b20f5

<?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        "f5decdd76b2c08ab6e01ac47342f680e">
  <!ENTITY webkitgtk2-size          "9.0 MB">
  <!ENTITY webkitgtk2-buildsize     "855 MB">
  <!ENTITY webkitgtk2-time          "53 SBU">
]>

<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> platform.
    </para>

    &lfs74_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="gperf"/>,
      <xref linkend="gst10-plugins-base"/>,
      <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>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <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 may 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/webkitgtk3 \
            --enable-introspection &amp;&amp;
make</userinput></screen>

    <para>
      This package does not have a working testsuite.
    </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>
  </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 Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          jsc-3
        </seg>
        <seg>
          libjavascriptcoregtk-3.0.so,
          libwebkit2gtkinjectedbundle.so,
          libwebkit2gtk-3.0.so, and
          libwebkitgtk-3.0.so
        </seg>
        <seg>
          /usr/include/webkitgtk-3.0, 
          /usr/lib/webkitgtk3,
          /usr/lib/webkit2gtk-3.0,
          /usr/share/gtk-doc/html/webkitgtk,
          /usr/share/gtk-doc/html/webkit2gtk, 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-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-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="libwebkit2gtkinjectedbundle">
        <term><filename class="libraryfile">libwebkit2gtkinjectedbundle.so</filename></term>
        <listitem>
          <para>
            contains the <application>WebKitGTK+</application> API functions for
            the Injected Bundle support.
          </para>
          <indexterm zone="webkitgtk libwebkit2gtkinjectedbundle">
            <primary sortas="c-libwebkit2gtkinjectedbundle">libwebkit2gtkinjectedbundle.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>