glfs/x/lib/gdk-pixbuf.xml
Douglas R. Reno c5408a2d70 Add an entity for the gi-docgen URL and change several packages to use
it.

This should make the different URLs we had previously consistent with
one another, and ease maintenance burden.

This is only temporary though since eventually gi-docgen will become
part of the book, when Pierre's python-modules branch is brought into
trunk.
2022-12-16 13:18:44 -06:00

285 lines
9.3 KiB
XML

<?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.42/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
<!ENTITY gdk-pixbuf-download-ftp
"&gnome-download-ftp;/gdk-pixbuf/2.42/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
<!ENTITY gdk-pixbuf-md5sum "4a62f339cb1424693fba9bb7ffef8150">
<!ENTITY gdk-pixbuf-size "6.2 MB">
<!ENTITY gdk-pixbuf-buildsize "36 MB (with tests)">
<!ENTITY gdk-pixbuf-time "0.2 SBU (With tests; both using parallelism=4)">
]>
<sect1 id="gdk-pixbuf" xreflabel="gdk-pixbuf-&gdk-pixbuf-version;">
<?dbhtml filename="gdk-pixbuf.html"?>
<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>
&lfs112_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>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="glib2"/>,
<xref linkend="libjpeg"/>,
<xref linkend="libpng"/>, and
<xref linkend="shared-mime-info"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="docutils"/>,
<xref role="runtime" linkend="librsvg"/> (runtime dependency, needed for
loading symbolic icons) and
<xref linkend="libtiff"/>
</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"/> and-->
<ulink url="&gi-docgen-url;">gi-docgen</ulink>
(to generate documentation)
</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>mkdir build &amp;&amp;
cd build &amp;&amp;
meson --prefix=/usr --buildtype=release --wrap-mode=nofallback .. &amp;&amp;
ninja</userinput></screen>
<para>
To test the results, issue: <command>ninja test</command>. The tests
make a heavy use of disk.
</para>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>ninja 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>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/meson-buildtype-release.xml"/>
<!-- gi-docgen can get installed without this, if deps exist -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/meson-wrap-nofallback.xml"/>
<!-- with 2.42.9, docutils must be installed to generate man pages.
Without this, you'll get the following output:
Program rst2man found: ../docs/meson.build:70:2: ERROR: Problem encountered:
No rst2man found, but man pages were explicitly enabled -->
<para>
<option>-Dman=false</option>: Use this option if you do not want to
generate manual pages, or if you do not want to install
<xref linkend="docutils" role="nodep"/>.
</para>
</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,
gdk-pixbuf-query-loaders, and
gdk-pixbuf-thumbnailer
</seg>
<seg>
libgdk_pixbuf-2.0.so
</seg>
<seg>
/usr/{include,lib}/gdk-pixbuf-2.0,
/usr/libexec/installed-tests/gdk-pixbuf,
/usr/share/installed-tests/gdk-pixbuf,
/usr/share/gtk-doc/html/gdk-pixbuf, and
/usr/share/thumbnailers
</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="gdk-pixbuf-thumbnailer">
<term><command>gdk-pixbuf-thumbnailer</command></term>
<listitem>
<para>
creates thumbnails of pictures for use in other applications
</para>
<indexterm zone="gdk-pixbuf gdk-pixbuf-thumbnailer">
<primary sortas="b-gdk-pixbuf-thumbnailer">gdk-pixbuf-thumbnailer</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>
<!-- Split off into gdk-pixbuf-xlib
<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>