source: x/lib/gdk-pixbuf.xml@ 8ee0429

<?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 gdk-pixbuf-download-http
           "&gnome-download-http;/gdk-pixbuf/2.34/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
  <!ENTITY gdk-pixbuf-download-ftp
           "&gnome-download-ftp;/gdk-pixbuf/2.34/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
  <!ENTITY gdk-pixbuf-md5sum        "63cb19f92cf7709ccf44bbb6fe1ff70c">
  <!ENTITY gdk-pixbuf-size          "2.6 MB">
  <!ENTITY gdk-pixbuf-buildsize     "40 MB (additional 2 MB for tests)">
  <!ENTITY gdk-pixbuf-time          "4.0 SBU (with tests)">
]>

<!--
   Test Suite value seems to keep on increasing. This might be worth
   investigating.-->

<!--
   Only 3.9SBU for me this time.
-->

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

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

  <title>gdk-pixbuf-&gdk-pixbuf-version;</title>

  <indexterm zone="gdk-pixbuf">
    <primary sortas="a-gdk-pixbuf">gdk-pixbuf</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Gdk Pixbuf</title>

    <para>
      The <application>Gdk Pixbuf</application> package is a toolkit for image
      loading and pixel buffer manipulation. It is used by
      <application>GTK+ 2</application> and <application>GTK+ 3</application> to
      load and manipulate images. In the past it was distributed as part of
      <application>GTK+ 2</application> but it was split off into a separate
      package in preparation for the change to <application>GTK+ 3</application>.
    </para>

    &lfs79_checked;&gcc6_checked;

<!-- Note that I am very skeptical about tagging this. Munir and I both
     have had memory allocation/leak issues with the tests. -->

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

    <bridgehead renderas="sect3">Gdk Pixbuf Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="libpng"/> and
      <xref linkend="libtiff"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="xorg7-lib"/>
      (<emphasis>Many</emphasis> <application>GTK+</application>
      applications <emphasis>require</emphasis> gdk-pixbuf-xlib).
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="jasper"/> and
      <xref linkend="gtk-doc"/>
    </para>

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

  <sect2 role="installation">
    <title>Installation of Gdk Pixbuf</title>

    <para>
      Install <application>Gdk Pixbuf</application> by running the following
      commands:
    </para>

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

    <para>
      To test the results, issue: <command>make check</command>. Some tests
      might fail for unknown reasons.
    </para>

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

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

    <note>
      <para>
        If you installed the package on to your system using a
        <quote>DESTDIR</quote> method, an important file was not installed and
        should be copied and/or generated. Generate it using the following
        command as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
    </note>
  </sect2>

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

    <para>
      <parameter>--with-x11</parameter>: This switch enables building of the
      <application>Gdk Pixbuf</application> <application>X11</application>
      library which is needed for <emphasis>many</emphasis> packages.
    </para>

    <para>
      <option>--with-libjasper</option>: If you've installed
      <xref linkend="jasper"/> and you want
      <application>Gdk Pixbuf</application> to use it to compile a
      JPEG2000 image loader, pass this switch to configure.
    </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>
          gdk-pixbuf-csource, 
          gdk-pixbuf-pixdata, and 
          gdk-pixbuf-query-loaders
        </seg>
        <seg>
          libgdk_pixbuf-2.0.so and
          libgdk_pixbuf_xlib-2.0.so
        </seg>
        <seg>
          /usr/include/gdk-pixbuf-2.0,
          /usr/lib/gdk-pixbuf-2.0, and
          /usr/share/gtk-doc/html/gdk-pixbuf
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gdk-pixbuf-csource">
        <term><command>gdk-pixbuf-csource</command></term>
        <listitem>
          <para>
            is a small utility that generates C code containing images, used
            for compiling images directly into programs.
          </para>
          <indexterm zone="gdk-pixbuf gdk-pixbuf-csource">
            <primary sortas="b-gdk-pixbuf-csource">gdk-pixbuf-csource</primary>
          </indexterm>
        </listitem>
      </varlistentry>

     <varlistentry id="gdk-pixbuf-pixdata">
        <term><command>gdk-pixbuf-pixdata</command></term>
        <listitem>
          <para>
            is a tool used to convert GdkPixbuf to GdkPixdata.
          </para>
          <indexterm zone="gdk-pixbuf gdk-pixbuf-pixdata">
            <primary sortas="b-gdk-pixbuf-pixdata">gdk-pixbuf-pixdata</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gdk-pixbuf-query-loaders">
        <term><command>gdk-pixbuf-query-loaders</command></term>
        <listitem>
          <para>
            collects information about loadable modules for
            <application>Gdk Pixbuf</application> and writes it
            to the default cache file location, or to stdout.
          </para>
          <indexterm zone="gdk-pixbuf gdk-pixbuf-query-loaders">
            <primary sortas="b-gdk-pixbuf-query-loaders">gdk-pixbuf-query-loaders</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgdk_pixbuf-2">
        <term><filename class="libraryfile">libgdk_pixbuf-2.0.so</filename></term>
        <listitem>
          <para>
            contains functions used to load and render images.
          </para>
          <indexterm zone="gdk-pixbuf libgdk_pixbuf-2">
            <primary sortas="c-libgdk_pixbuf-2">libgdk_pixbuf-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgdk_pixbuf_xlib-2">
        <term><filename class="libraryfile">libgdk_pixbuf_xlib-2.0.so</filename></term>
        <listitem>
          <para>
            contains functions used to manipulate images and interfaces with
            <application>Xlib</application>.
          </para>
          <indexterm zone="gdk-pixbuf libgdk_pixbuf_xlib-2">
            <primary sortas="c-libgdk_pixbuf_xlib-2">libgdk_pixbuf_xlib-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>