source: x/lib/gdk-pixbuf.xml

trunk
Last change on this file was c244130, checked in by Bruce Dubbs <bdubbs@…>, 8 days ago

Update to gdk-pixbuf-2.42.11.

  • Property mode set to 100644
File size: 9.6 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY gdk-pixbuf-download-http
8 "&gnome-download-http;/gdk-pixbuf/2.42/gdk-pixbuf-&gdk-pixbuf-version;.tar.xz">
9 <!ENTITY gdk-pixbuf-download-ftp " ">
10 <!ENTITY gdk-pixbuf-md5sum "b2ba2f594122001ac7f89e7d02560497">
11 <!ENTITY gdk-pixbuf-size "6.2 MB">
12 <!ENTITY gdk-pixbuf-buildsize "33 MB (with tests)">
13 <!ENTITY gdk-pixbuf-time "0.1 SBU (With tests; both using parallelism=4)">
14]>
15
16<sect1 id="gdk-pixbuf" xreflabel="gdk-pixbuf-&gdk-pixbuf-version;">
17 <?dbhtml filename="gdk-pixbuf.html"?>
18
19
20 <title>gdk-pixbuf-&gdk-pixbuf-version;</title>
21
22 <indexterm zone="gdk-pixbuf">
23 <primary sortas="a-gdk-pixbuf">gdk-pixbuf</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to Gdk Pixbuf</title>
28
29 <para>
30 The <application>Gdk Pixbuf</application> package is a toolkit for image
31 loading and pixel buffer manipulation. It is used by
32 <application>GTK+ 2</application> and <application>GTK+ 3</application> to
33 load and manipulate images. In the past it was distributed as part of
34 <application>GTK+ 2</application> but it was split off into a separate
35 package in preparation for the change to <application>GTK+ 3</application>.
36 </para>
37
38 &lfs121_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&gdk-pixbuf-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&gdk-pixbuf-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &gdk-pixbuf-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &gdk-pixbuf-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &gdk-pixbuf-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &gdk-pixbuf-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">Gdk Pixbuf Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="glib2"/> (GObject Introspection required for GNOME),
79 <xref linkend="libjpeg"/>,
80 <xref linkend="libpng"/>, and
81 <xref linkend="shared-mime-info"/>
82 </para>
83
84 <bridgehead renderas="sect4">Recommended</bridgehead>
85 <para role="recommended">
86 <xref linkend="docutils"/>,
87 <xref role="runtime" linkend="librsvg"/> (runtime dependency, needed for
88 loading symbolic icons) and
89 <xref linkend="libtiff"/>
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="gi-docgen"/>
95 (to generate documentation),
96 <xref role="runtime" linkend="libavif"/>
97 (runtime dependency, needed for loading AVIF images),
98 <xref role="runtime" linkend="libjxl"/>
99 (runtime dependency, needed for loading JPEG XL images), and
100 <xref role="runtime" linkend="webp-pixbuf-loader"/>
101 (runtime dependency, needed for loading WebP images)
102 </para>
103
104 </sect2>
105
106 <sect2 role="installation">
107 <title>Installation of Gdk Pixbuf</title>
108
109 <para>
110 Install <application>Gdk Pixbuf</application> by running the following
111 commands:
112 </para>
113
114<screen><userinput>mkdir build &amp;&amp;
115cd build &amp;&amp;
116
117meson setup .. \
118 --prefix=/usr \
119 --buildtype=release \
120 --wrap-mode=nofallback &amp;&amp;
121ninja</userinput></screen>
122
123 <para>
124 If you have <xref linkend='gi-docgen'/> installed and wish to build
125 the API documentation for this package, issue:
126 </para>
127
128<screen role='nodump'><userinput>sed "/docs_dir =/s@\$@ / 'gdk-pixbuf-&gdk-pixbuf-version;'@" -i ../docs/meson.build &amp;&amp;
129meson configure -Dgtk_doc=true &amp;&amp;
130ninja</userinput></screen>
131
132 <para>
133 To test the results, issue: <command>ninja test</command>. The tests
134 make a heavy use of disk.
135 </para>
136
137 <para>
138 Now, as the <systemitem class="username">root</systemitem> user:
139 </para>
140
141<screen role="root"><userinput>ninja install</userinput></screen>
142
143 <note>
144 <para>
145 If you installed the package on to your system using a
146 <quote>DESTDIR</quote> method, an important file was not installed and
147 should be copied and/or generated. Generate it using the following
148 command as the <systemitem class="username">root</systemitem> user:
149 </para>
150
151<screen role="root"><userinput>gdk-pixbuf-query-loaders --update-cache</userinput></screen>
152 </note>
153 </sect2>
154
155 <sect2 role="commands">
156 <title>Command Explanations</title>
157
158 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
159 href="../../xincludes/meson-buildtype-release.xml"/>
160
161 <!-- gi-docgen can get installed without this, if deps exist -->
162 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
163 href="../../xincludes/meson-wrap-nofallback.xml"/>
164
165 <!-- with 2.42.9, docutils must be installed to generate man pages.
166 Without this, you'll get the following output:
167 Program rst2man found: ../docs/meson.build:70:2: ERROR: Problem encountered:
168 No rst2man found, but man pages were explicitly enabled -->
169 <para>
170 <option>-Dman=false</option>: Use this option if you do not want to
171 generate manual pages, or if you do not want to install
172 <xref linkend="docutils" role="nodep"/>.
173 </para>
174 </sect2>
175
176 <sect2 role="content">
177 <title>Contents</title>
178
179 <segmentedlist>
180 <segtitle>Installed Programs</segtitle>
181 <segtitle>Installed Libraries</segtitle>
182 <segtitle>Installed Directories</segtitle>
183
184 <seglistitem>
185 <seg>
186 gdk-pixbuf-csource,
187 gdk-pixbuf-pixdata,
188 gdk-pixbuf-query-loaders, and
189 gdk-pixbuf-thumbnailer
190 </seg>
191 <seg>
192 libgdk_pixbuf-2.0.so
193 </seg>
194 <seg>
195 /usr/{include,lib}/gdk-pixbuf-2.0,
196 /usr/libexec/installed-tests/gdk-pixbuf,
197 /usr/share/installed-tests/gdk-pixbuf,
198 /usr/share/gtk-doc/html/gdk-pixbuf, and
199 /usr/share/thumbnailers
200 </seg>
201 </seglistitem>
202 </segmentedlist>
203
204 <variablelist>
205 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
206 <?dbfo list-presentation="list"?>
207 <?dbhtml list-presentation="table"?>
208
209 <varlistentry id="gdk-pixbuf-csource">
210 <term><command>gdk-pixbuf-csource</command></term>
211 <listitem>
212 <para>
213 is a small utility that generates C code containing images, used
214 for compiling images directly into programs
215 </para>
216 <indexterm zone="gdk-pixbuf gdk-pixbuf-csource">
217 <primary sortas="b-gdk-pixbuf-csource">gdk-pixbuf-csource</primary>
218 </indexterm>
219 </listitem>
220 </varlistentry>
221
222 <varlistentry id="gdk-pixbuf-pixdata">
223 <term><command>gdk-pixbuf-pixdata</command></term>
224 <listitem>
225 <para>
226 is a tool used to convert GdkPixbuf to GdkPixdata
227 </para>
228 <indexterm zone="gdk-pixbuf gdk-pixbuf-pixdata">
229 <primary sortas="b-gdk-pixbuf-pixdata">gdk-pixbuf-pixdata</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="gdk-pixbuf-query-loaders">
235 <term><command>gdk-pixbuf-query-loaders</command></term>
236 <listitem>
237 <para>
238 collects information about loadable modules for
239 <application>Gdk Pixbuf</application> and writes it
240 to the default cache file location, or to stdout
241 </para>
242 <indexterm zone="gdk-pixbuf gdk-pixbuf-query-loaders">
243 <primary sortas="b-gdk-pixbuf-query-loaders">gdk-pixbuf-query-loaders</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="gdk-pixbuf-thumbnailer">
249 <term><command>gdk-pixbuf-thumbnailer</command></term>
250 <listitem>
251 <para>
252 creates thumbnails of pictures for use in other applications
253 </para>
254 <indexterm zone="gdk-pixbuf gdk-pixbuf-thumbnailer">
255 <primary sortas="b-gdk-pixbuf-thumbnailer">gdk-pixbuf-thumbnailer</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="libgdk_pixbuf-2">
261 <term><filename class="libraryfile">libgdk_pixbuf-2.0.so</filename></term>
262 <listitem>
263 <para>
264 contains functions used to load and render images
265 </para>
266 <indexterm zone="gdk-pixbuf libgdk_pixbuf-2">
267 <primary sortas="c-libgdk_pixbuf-2">libgdk_pixbuf-2.0.so</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <!-- Split off into gdk-pixbuf-xlib
273 <varlistentry id="libgdk_pixbuf_xlib-2">
274 <term><filename class="libraryfile">libgdk_pixbuf_xlib-2.0.so</filename></term>
275 <listitem>
276 <para>
277 contains functions used to manipulate images and interfaces with
278 <application>Xlib</application>
279 </para>
280 <indexterm zone="gdk-pixbuf libgdk_pixbuf_xlib-2">
281 <primary sortas="c-libgdk_pixbuf_xlib-2">libgdk_pixbuf_xlib-2.0.so</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285 -->
286 </variablelist>
287
288 </sect2>
289
290</sect1>
Note: See TracBrowser for help on using the repository browser.