source: x/lib/gdk-pixbuf.xml@ 4c2be438

<?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.26/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
  <!ENTITY gdk-pixbuf-download-ftp  "&gnome-download-ftp;/gdk-pixbuf/2.26/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
  <!ENTITY gdk-pixbuf-md5sum        "82197921c651a81ae28178aa9adfc0e6">
  <!ENTITY gdk-pixbuf-size          "1.2 MB">
  <!ENTITY gdk-pixbuf-buildsize     "25 MB">
  <!ENTITY gdk-pixbuf-time          "0.2 SBU">
]>

<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> library is a toolkit for
    image loading and pixel buffer manipulation. It is used by gtk+-2 and
    gtk+-3 to load and manipulate images. In the past it was distributed as
    part of gtk+-2 but it was split off into a separate package in preparation
    for the change to gtk+-3.</para>

    &lfs71_checked;

    <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>

    <!-- Whole package is useless without jpeg, png and tiff loaders. -->
    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libjpeg"/>,
      <xref linkend="libpng"/>,
      <xref linkend="libtiff"/>,
      <xref linkend="pkgconfig"/> and
      <xref linkend="xorg7-lib"/>
    </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>.</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>--with-x11</option>: This switch enables building of
    gdk-pixbuf x11 library which is needed for some packages.</para>

    <para><option>--with-libjasper</option>: If you've installed
    <xref linkend="jasper"/> and you want gdk-pixbuf to use it to compile a
    JPEG2000 image loader, pass this option 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-query-loaders">
        <term><command>gdk-pixbuf-query-loaders</command></term>
        <listitem>
          <para>collects information about loadable modules for gdk-pixbuf 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.0">
        <term><filename class='libraryfile'>libgdk_pixbuf-2.0.so</filename></term>
        <listitem>
          <para>contains functions that load and render images.</para>
          <indexterm zone="gdk-pixbuf libgdk_pixbuf-2.0">
            <primary sortas="c-libgdk_pixbuf-2.0">libgdk_pixbuf-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>