source: x/lib/webkitgtk.xml@ 31bf432

<?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/webkit-&webkitgtk-version;.tar.gz">
  <!ENTITY webkitgtk-download-ftp  " ">
  <!ENTITY webkitgtk-md5sum        "e6eb43bb4f75b4a2a09aec95e2f43e91">
  <!ENTITY webkitgtk-size          "5.8 MB">
  <!ENTITY webkitgtk-buildsize     "251 MB">
  <!ENTITY webkitgtk-time          "18 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>

    <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="enchant"/>,
    <xref linkend="gail"/>,
    <xref linkend="gperf"/>,
    <xref linkend="gst-plugins-base"/>,
    <xref linkend="icu"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="libsoup"/>,
    <xref linkend="libxslt"/>,
    <xref linkend="pcre"/>,
    <xref linkend="sqlite"/>, and
    <xref linkend="which"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="curl"/> and
    <ulink url="http://www.freedesktop.org/wiki/Software/GeoClue">GeoClue</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>Install <application>WebKitGTK+</application> by running the following
    commands:</para>

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

    <para>To test the results, issue: <command>make check</command>.</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-3D-transforms</option>: This option enable support
    for 3D transforms.</para>

    <para><option>--enable-geolocation</option>: This option enable support for
    geolocation.</para>

    <para><option>--enable-wml</option>: This option enable support for
    WML.</para>

    <para><option>--enable-shared-workers</option>: This option enable support
    for SharedWorkers.</para>

    <para><option>--enable-filters</option>: This option enable support for
    filters.</para>

    <para><option>--enable-web-sockets</option>: This option enable support for
    Web Sockets.</para>

    <xi:include xmlns:xi="http://www.w3.org/2003/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</seg>
        <seg>libwebkit-1.0.so</seg>
        <seg>/usr/{include/webkit-1.0/{JavaScriptCore,webkit},
        share/webkit-1.0/{images,resources,webinspector/Images}}</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="libwebkit-1.0">
        <term><filename class='libraryfile'>libwebkit-1.0.so</filename></term>
        <listitem>
          <para>contains the <application>WebKitGTK+</application> API
          functions.</para>
          <indexterm zone="webkitgtk libwebkit-1.0">
            <primary sortas="c-libwebkit-1.0">libwebkit-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>